Cloud Spanner V1 Client - Class ListInstancePartitionOperationsRequest (1.82.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class ListInstancePartitionOperationsRequest.

The request for ListInstancePartitionOperations.

Generated from protobuf message google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest

Namespace

Google \ Cloud \ Spanner \ Admin \ Instance \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent instance of the instance partition operations. Values are of the form projects/<project>/instances/<instance>.
↳ filter 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.
↳ page_size int

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 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.
↳ instance_partition_deadline 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 in ListInstancePartitionOperationsResponse.

getParent

Required. The parent instance of the instance partition operations.

Values are of the form projects/<project>/instances/<instance>.

Returns
Type Description
string

setParent

Required. The parent instance of the instance partition operations.

Values are of the form projects/<project>/instances/<instance>.

Parameter
Name Description
var string
Returns
Type Description
$this

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 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
Type Description
string

setFilter

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.
Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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

Returns
Type Description
int

setPageSize

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

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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 in ListInstancePartitionOperationsResponse.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasInstancePartitionDeadline

clearInstancePartitionDeadline

setInstancePartitionDeadline

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 in ListInstancePartitionOperationsResponse.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent instance of the instance partition operations. Values are of the form projects/<project>/instances/<instance>. Please see Google\Cloud\Spanner\Admin\Instance\V1\InstanceAdminClient::instanceName() for help formatting this field.
Returns
Type Description
Google\Cloud\Spanner\Admin\Instance\V1\ListInstancePartitionOperationsRequest