final case class ListInstancesRequest(parent: String = "", pageSize: Int = 0, pageToken: String = "", filter: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListInstancesRequest] with Product with Serializable

The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].

parent

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

pageSize

Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

pageToken

If non-empty, page_token should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].

filter

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * name * display_name * labels.key where key is the name of a label Some examples of using filters are: * name:* --> The instance has a name. * name:Howl --> The instance's name contains the string "howl". * name:HOWL --> Equivalent to above. * NAME:howl --> Equivalent to above. * labels.env:* --> The instance has the label "env". * labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev". * name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[ListInstancesRequest], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ListInstancesRequest
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ListInstancesRequest(parent: String = "", pageSize: Int = 0, pageToken: String = "", filter: String = "", unknownFields: UnknownFieldSet = ...)

    parent

    Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

    pageSize

    Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

    pageToken

    If non-empty, page_token should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].

    filter

    An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * name * display_name * labels.key where key is the name of a label Some examples of using filters are: * name:* --> The instance has a name. * name:Howl --> The instance's name contains the string "howl". * name:HOWL --> Equivalent to above. * NAME:howl --> Equivalent to above. * labels.env:* --> The instance has the label "env". * labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev". * name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def companion: ListInstancesRequest.type
    Definition Classes
    ListInstancesRequest → GeneratedMessage
  7. def discardUnknownFields: ListInstancesRequest
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. val filter: String
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ListInstancesRequest → GeneratedMessage
  13. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ListInstancesRequest → GeneratedMessage
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. val pageSize: Int
  19. val pageToken: String
  20. val parent: String
  21. def serializedSize: Int
    Definition Classes
    ListInstancesRequest → GeneratedMessage
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  24. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  25. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  26. def toProtoString: String
    Definition Classes
    ListInstancesRequest → GeneratedMessage
  27. val unknownFields: UnknownFieldSet
  28. def update(ms: (Lens[ListInstancesRequest, ListInstancesRequest]) ⇒ Mutation[ListInstancesRequest]*): ListInstancesRequest
    Definition Classes
    Updatable
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. def withFilter(__v: String): ListInstancesRequest
  33. def withPageSize(__v: Int): ListInstancesRequest
  34. def withPageToken(__v: String): ListInstancesRequest
  35. def withParent(__v: String): ListInstancesRequest
  36. def withUnknownFields(__v: UnknownFieldSet): ListInstancesRequest
  37. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  38. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ListInstancesRequest → GeneratedMessage
  39. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[ListInstancesRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped