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

Interface ListInstancePartitionsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListInstancePartitionsRequest, ListInstancePartitionsRequest.Builder
public interface ListInstancePartitionsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Timestamp
    getInstancePartitionDeadline()
    Optional.
    com.google.protobuf.TimestampOrBuilder
    getInstancePartitionDeadlineOrBuilder()
    Optional.
    int
    getPageSize()
    Number of instance partitions to be returned in the response.
    String
    getPageToken()
    If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancePartitionsResponse.next_page_token] from a previous [ListInstancePartitionsResponse][google.spanner.admin.instance.v1.ListInstancePartitionsResponse].
    com.google.protobuf.ByteString
    getPageTokenBytes()
    If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancePartitionsResponse.next_page_token] from a previous [ListInstancePartitionsResponse][google.spanner.admin.instance.v1.ListInstancePartitionsResponse].
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    boolean
    hasInstancePartitionDeadline()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getParent

      String getParent()
       Required. The instance whose instance partitions should be listed. Values
 are of the form `projects/<project>/instances/<instance>`. Use `{instance}
 = '-'` to list instance partitions for all Instances in a project, e.g.,
 `projects/myproject/instances/-`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The instance whose instance partitions should be listed. Values
 are of the form `projects/<project>/instances/<instance>`. Use `{instance}
 = '-'` to list instance partitions for all Instances in a project, e.g.,
 `projects/myproject/instances/-`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

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

    • getPageToken

      String getPageToken()
       If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.instance.v1.ListInstancePartitionsResponse.next_page_token]
 from a previous
 [ListInstancePartitionsResponse][google.spanner.admin.instance.v1.ListInstancePartitionsResponse].
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.instance.v1.ListInstancePartitionsResponse.next_page_token]
 from a previous
 [ListInstancePartitionsResponse][google.spanner.admin.instance.v1.ListInstancePartitionsResponse].
      string page_token = 3;
      Returns:
      The bytes for pageToken.

    • hasInstancePartitionDeadline

      boolean hasInstancePartitionDeadline()
       Optional. Deadline used while retrieving metadata for instance partitions.
 Instance partitions whose metadata cannot be retrieved within this deadline
 will be added to
 [unreachable][google.spanner.admin.instance.v1.ListInstancePartitionsResponse.unreachable]
 in
 [ListInstancePartitionsResponse][google.spanner.admin.instance.v1.ListInstancePartitionsResponse].
      .google.protobuf.Timestamp instance_partition_deadline = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the instancePartitionDeadline field is set.

    • getInstancePartitionDeadline

      com.google.protobuf.Timestamp getInstancePartitionDeadline()
       Optional. Deadline used while retrieving metadata for instance partitions.
 Instance partitions whose metadata cannot be retrieved within this deadline
 will be added to
 [unreachable][google.spanner.admin.instance.v1.ListInstancePartitionsResponse.unreachable]
 in
 [ListInstancePartitionsResponse][google.spanner.admin.instance.v1.ListInstancePartitionsResponse].
      .google.protobuf.Timestamp instance_partition_deadline = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The instancePartitionDeadline.

    • getInstancePartitionDeadlineOrBuilder

      com.google.protobuf.TimestampOrBuilder getInstancePartitionDeadlineOrBuilder()
       Optional. Deadline used while retrieving metadata for instance partitions.
 Instance partitions whose metadata cannot be retrieved within this deadline
 will be added to
 [unreachable][google.spanner.admin.instance.v1.ListInstancePartitionsResponse.unreachable]
 in
 [ListInstancePartitionsResponse][google.spanner.admin.instance.v1.ListInstancePartitionsResponse].
      .google.protobuf.Timestamp instance_partition_deadline = 4 [(.google.api.field_behavior) = OPTIONAL];