Class: Google::Cloud::Spanner::Admin::Instance::V1::ListInstancePartitionOperationsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb

Overview

The request for ListInstancePartitionOperations.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

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


1279
1280
1281
1282
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1279

class ListInstancePartitionOperationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#instance_partition_deadline ⇒ ::Google::Protobuf::Timestamp

Returns 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:



1279
1280
1281
1282
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1279

class ListInstancePartitionOperationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

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



1279
1280
1281
1282
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1279

class ListInstancePartitionOperationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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:



1279
1280
1281
1282
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1279

class ListInstancePartitionOperationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

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



1279
1280
1281
1282
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1279

class ListInstancePartitionOperationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end