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

Class ListInstancesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ListInstancesRequest.Builder>
com.google.spanner.admin.instance.v1.ListInstancesRequest.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListInstancesRequestOrBuilder, Cloneable
Enclosing class:
ListInstancesRequest
public static final class ListInstancesRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ListInstancesRequest.Builder> implements ListInstancesRequestOrBuilder
 The request for
 [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
Protobuf type google.spanner.admin.instance.v1.ListInstancesRequest

  • Method Details

    • 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.Builder<ListInstancesRequest.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

      public ListInstancesRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

    • clearField

      public ListInstancesRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

    • clearOneof

      public ListInstancesRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

    • setRepeatedField

      public ListInstancesRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

    • addRepeatedField

      public ListInstancesRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

    • mergeFrom

      public ListInstancesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListInstancesRequest.Builder>

    • mergeFrom

      public ListInstancesRequest.Builder mergeFrom(ListInstancesRequest other)

    • isInitialized

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

    • mergeFrom

      public ListInstancesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListInstancesRequest.Builder>
      Throws:
      IOException

    • 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.

    • setParent

      public ListInstancesRequest.Builder setParent(String value)
       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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ListInstancesRequest.Builder clearParent()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      public ListInstancesRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPageSize

      public ListInstancesRequest.Builder setPageSize(int value)
       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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListInstancesRequest.Builder clearPageSize()
       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;
      Returns:
      This builder for chaining.

    • 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.

    • setPageToken

      public ListInstancesRequest.Builder setPageToken(String value)
       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;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListInstancesRequest.Builder clearPageToken()
       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;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListInstancesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • 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.

    • setFilter

      public ListInstancesRequest.Builder setFilter(String value)
       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;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ListInstancesRequest.Builder clearFilter()
       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;
      Returns:
      This builder for chaining.

    • setFilterBytes

      public ListInstancesRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • 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.

    • setInstanceDeadline

      public ListInstancesRequest.Builder setInstanceDeadline(com.google.protobuf.Timestamp value)
       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;

    • setInstanceDeadline

      public ListInstancesRequest.Builder setInstanceDeadline(com.google.protobuf.Timestamp.Builder builderForValue)
       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;

    • mergeInstanceDeadline

      public ListInstancesRequest.Builder mergeInstanceDeadline(com.google.protobuf.Timestamp value)
       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;

    • clearInstanceDeadline

      public ListInstancesRequest.Builder clearInstanceDeadline()
       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;

    • getInstanceDeadlineBuilder

      public com.google.protobuf.Timestamp.Builder getInstanceDeadlineBuilder()
       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;

    • 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

    • setUnknownFields

      public final ListInstancesRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

    • mergeUnknownFields

      public final ListInstancesRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListInstancesRequest.Builder>