Package com.google.spanner.admin.instance.v1

Class ListInstancesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.admin.instance.v1.ListInstancesRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListInstancesRequestOrBuilder, Serializable
public final class ListInstancesRequest extends com.google.protobuf.GeneratedMessageV3 implements ListInstancesRequestOrBuilder
 The request for
 [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
Protobuf type google.spanner.admin.instance.v1.ListInstancesRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ListInstancesRequest.Builder
    The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FILTER_FIELD_NUMBER
     
    static final int
    INSTANCE_DEADLINE_FIELD_NUMBER
     
    static final int
    PAGE_SIZE_FIELD_NUMBER
     
    static final int
    PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    PARENT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ListInstancesRequest
    getDefaultInstance()
     
    ListInstancesRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFilter()
    An expression for filtering the results of the request.
    com.google.protobuf.ByteString
    getFilterBytes()
    An expression for filtering the results of the request.
    com.google.protobuf.Timestamp
    getInstanceDeadline()
    Deadline used while retrieving metadata for instances.
    com.google.protobuf.TimestampOrBuilder
    getInstanceDeadlineOrBuilder()
    Deadline used while retrieving metadata for instances.
    int
    getPageSize()
    Number of instances to be returned in the response.
    String
    getPageToken()
    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].
    com.google.protobuf.ByteString
    getPageTokenBytes()
    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].
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.Parser<ListInstancesRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasInstanceDeadline()
    Deadline used while retrieving metadata for instances.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ListInstancesRequest.Builder
    newBuilder()
     
    static ListInstancesRequest.Builder
    newBuilder(ListInstancesRequest prototype)
     
    ListInstancesRequest.Builder
    newBuilderForType()
     
    protected ListInstancesRequest.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ListInstancesRequest
    parseDelimitedFrom(InputStream input)
     
    static ListInstancesRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListInstancesRequest
    parseFrom(byte[] data)
     
    static ListInstancesRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListInstancesRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ListInstancesRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListInstancesRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ListInstancesRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListInstancesRequest
    parseFrom(InputStream input)
     
    static ListInstancesRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListInstancesRequest
    parseFrom(ByteBuffer data)
     
    static ListInstancesRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListInstancesRequest>
    parser()
     
    ListInstancesRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • PARENT_FIELD_NUMBER

      public static final int PARENT_FIELD_NUMBER
      See Also:

    • PAGE_SIZE_FIELD_NUMBER

      public static final int PAGE_SIZE_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

    • FILTER_FIELD_NUMBER

      public static final int FILTER_FIELD_NUMBER
      See Also:

    • INSTANCE_DEADLINE_FIELD_NUMBER

      public static final int INSTANCE_DEADLINE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getParent

      public String getParent()
       Required. The name of the project for which a list of instances is
 requested. Values are of the form `projects/<project>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListInstancesRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The name of the project for which a list of instances is
 requested. Values are of the form `projects/<project>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListInstancesRequestOrBuilder
      Returns:
      The bytes for parent.

    • getPageSize

      public int getPageSize()
       Number of instances to be returned in the response. If 0 or less, defaults
 to the server's maximum allowed page size.
      int32 page_size = 2;
      Specified by:
      getPageSize in interface ListInstancesRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       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].
      string page_token = 3;
      Specified by:
      getPageToken in interface ListInstancesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       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].
      string page_token = 3;
      Specified by:
      getPageTokenBytes in interface ListInstancesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getFilter

      public String getFilter()
       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".
      string filter = 4;
      Specified by:
      getFilter in interface ListInstancesRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       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".
      string filter = 4;
      Specified by:
      getFilterBytes in interface ListInstancesRequestOrBuilder
      Returns:
      The bytes for filter.

    • hasInstanceDeadline

      public boolean hasInstanceDeadline()
       Deadline used while retrieving metadata for instances.
 Instances whose metadata cannot be retrieved within this deadline will be
 added to
 [unreachable][google.spanner.admin.instance.v1.ListInstancesResponse.unreachable]
 in
 [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
      .google.protobuf.Timestamp instance_deadline = 5;
      Specified by:
      hasInstanceDeadline in interface ListInstancesRequestOrBuilder
      Returns:
      Whether the instanceDeadline field is set.

    • getInstanceDeadline

      public com.google.protobuf.Timestamp getInstanceDeadline()
       Deadline used while retrieving metadata for instances.
 Instances whose metadata cannot be retrieved within this deadline will be
 added to
 [unreachable][google.spanner.admin.instance.v1.ListInstancesResponse.unreachable]
 in
 [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
      .google.protobuf.Timestamp instance_deadline = 5;
      Specified by:
      getInstanceDeadline in interface ListInstancesRequestOrBuilder
      Returns:
      The instanceDeadline.

    • getInstanceDeadlineOrBuilder

      public com.google.protobuf.TimestampOrBuilder getInstanceDeadlineOrBuilder()
       Deadline used while retrieving metadata for instances.
 Instances whose metadata cannot be retrieved within this deadline will be
 added to
 [unreachable][google.spanner.admin.instance.v1.ListInstancesResponse.unreachable]
 in
 [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
      .google.protobuf.Timestamp instance_deadline = 5;
      Specified by:
      getInstanceDeadlineOrBuilder in interface ListInstancesRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ListInstancesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInstancesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInstancesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInstancesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInstancesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInstancesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInstancesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListInstancesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListInstancesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListInstancesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListInstancesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListInstancesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ListInstancesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ListInstancesRequest.Builder newBuilder()

    • newBuilder

      public static ListInstancesRequest.Builder newBuilder(ListInstancesRequest prototype)

    • toBuilder

      public ListInstancesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ListInstancesRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ListInstancesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListInstancesRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ListInstancesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ListInstancesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder