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

Interface ListInstancePartitionOperationsRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    com.google.protobuf.Timestamp
    getInstancePartitionDeadline()
    Optional.
    com.google.protobuf.TimestampOrBuilder
    getInstancePartitionDeadlineOrBuilder()
    Optional.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    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 parent instance of the instance partition operations.
 Values are of the form `projects/<project>/instances/<instance>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The parent instance of the instance partition operations.
 Values are of the form `projects/<project>/instances/<instance>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getFilter

      String getFilter()
       Optional. An expression that filters the list of returned operations.

 A filter expression consists of a field name, a
 comparison operator, and a value for filtering.
 The value must be a string, a number, or a boolean. The comparison operator
 must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
 Colon `:` is the contains operator. Filter rules are not case sensitive.

 The following fields in the Operation are eligible for filtering:

   * `name` - The name of the long-running operation
   * `done` - False if the operation is in progress, else true.
   * `metadata.@type` - the type of metadata. For example, the type string
      for
      [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata]
      is
      `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata`.
   * `metadata.<field_name>` - any field in metadata.value.
      `metadata.@type` must be specified first, if filtering on metadata
      fields.
   * `error` - Error associated with the long-running operation.
   * `response.@type` - the type of response.
   * `response.<field_name>` - any field in response.value.

 You can combine multiple expressions by enclosing each expression in
 parentheses. By default, expressions are combined with AND logic. However,
 you can specify AND, OR, and NOT logic explicitly.

 Here are a few examples:

   * `done:true` - The operation is complete.
   * `(metadata.@type=` \
     `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata)
     AND` \
     `(metadata.instance_partition.name:custom-instance-partition) AND` \
     `(metadata.start_time < \"2021-03-28T14:50:00Z\") AND` \
     `(error:*)` - Return operations where:
     * The operation's metadata type is
     [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata].
     * The instance partition name contains "custom-instance-partition".
     * The operation started before 2021-03-28T14:50:00Z.
     * The operation resulted in an error.
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. An expression that filters the list of returned operations.

 A filter expression consists of a field name, a
 comparison operator, and a value for filtering.
 The value must be a string, a number, or a boolean. The comparison operator
 must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
 Colon `:` is the contains operator. Filter rules are not case sensitive.

 The following fields in the Operation are eligible for filtering:

   * `name` - The name of the long-running operation
   * `done` - False if the operation is in progress, else true.
   * `metadata.@type` - the type of metadata. For example, the type string
      for
      [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata]
      is
      `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata`.
   * `metadata.<field_name>` - any field in metadata.value.
      `metadata.@type` must be specified first, if filtering on metadata
      fields.
   * `error` - Error associated with the long-running operation.
   * `response.@type` - the type of response.
   * `response.<field_name>` - any field in response.value.

 You can combine multiple expressions by enclosing each expression in
 parentheses. By default, expressions are combined with AND logic. However,
 you can specify AND, OR, and NOT logic explicitly.

 Here are a few examples:

   * `done:true` - The operation is complete.
   * `(metadata.@type=` \
     `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata)
     AND` \
     `(metadata.instance_partition.name:custom-instance-partition) AND` \
     `(metadata.start_time < \"2021-03-28T14:50:00Z\") AND` \
     `(error:*)` - Return operations where:
     * The operation's metadata type is
     [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata].
     * The instance partition name contains "custom-instance-partition".
     * The operation started before 2021-03-28T14:50:00Z.
     * The operation resulted in an error.
      string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.

    • getPageSize

      int getPageSize()
       Optional. Number of operations to be returned in the response. If 0 or
 less, defaults to the server's maximum allowed page size.
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional. If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.next_page_token]
 from a previous
 [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse]
 to the same `parent` and with the same `filter`.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.next_page_token]
 from a previous
 [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse]
 to the same `parent` and with the same `filter`.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • hasInstancePartitionDeadline

      boolean hasInstancePartitionDeadline()
       Optional. Deadline used while retrieving metadata for instance partition
 operations. Instance partitions whose operation metadata cannot be
 retrieved within this deadline will be added to
 [unreachable_instance_partitions][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.unreachable_instance_partitions]
 in
 [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse].
      .google.protobuf.Timestamp instance_partition_deadline = 5 [(.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 partition
 operations. Instance partitions whose operation metadata cannot be
 retrieved within this deadline will be added to
 [unreachable_instance_partitions][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.unreachable_instance_partitions]
 in
 [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse].
      .google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The instancePartitionDeadline.

    • getInstancePartitionDeadlineOrBuilder

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