Cloud Spanner Instance Admin V1 API - Class Google::Cloud::Spanner::Admin::Instance::V1::ListInstancePartitionOperationsRequest (v0.16.0)

Reference documentation and code samples for the Cloud Spanner Instance Admin V1 API class Google::Cloud::Spanner::Admin::Instance::V1::ListInstancePartitionOperationsRequest.

The request for ListInstancePartitionOperations.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String

Returns

(::String) —
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 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.
  - The instance partition name contains "custom-instance-partition".
  - The operation started before 2021-03-28T14:50:00Z.
  - The operation resulted in an error.

#filter=

def filter=(value) -> ::String

Parameter

value (::String) —
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 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.
  - The instance partition name contains "custom-instance-partition".
  - The operation started before 2021-03-28T14:50:00Z.
  - The operation resulted in an error.

Returns

(::String) —
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 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.
  - The instance partition name contains "custom-instance-partition".
  - The operation started before 2021-03-28T14:50:00Z.
  - The operation resulted in an error.

#instance_partition_deadline

def instance_partition_deadline() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — 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][ListInstancePartitionOperationsResponse.unreachable] in ListInstancePartitionOperationsResponse.

#instance_partition_deadline=

def instance_partition_deadline=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — 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][ListInstancePartitionOperationsResponse.unreachable] in ListInstancePartitionOperationsResponse.

Returns

(::Google::Protobuf::Timestamp) — 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][ListInstancePartitionOperationsResponse.unreachable] in ListInstancePartitionOperationsResponse.

#page_size

def page_size() -> ::Integer

Returns

(::Integer) — Optional. Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

#page_size=

def page_size=(value) -> ::Integer

Parameter

value (::Integer) — Optional. Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

Returns

(::Integer) — Optional. Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

#page_token

def page_token() -> ::String

Returns

(::String) — Optional. If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same parent and with the same filter.

#page_token=

def page_token=(value) -> ::String

Parameter

value (::String) — Optional. If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same parent and with the same filter.

Returns

(::String) — Optional. If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same parent and with the same filter.

#parent

def parent() -> ::String

Returns

(::String) — Required. The parent instance of the instance partition operations. Values are of the form projects/<project>/instances/<instance>.

#parent=

def parent=(value) -> ::String

Parameter

value (::String) — Required. The parent instance of the instance partition operations. Values are of the form projects/<project>/instances/<instance>.

Returns

(::String) — Required. The parent instance of the instance partition operations. Values are of the form projects/<project>/instances/<instance>.