Google Cloud Spanner Instance Administration v1 API - Class ListInstancePartitionOperationsRequest (5.1.0) 

public sealed class ListInstancePartitionOperationsRequest : IPageRequest, IMessage<ListInstancePartitionOperationsRequest>, IEquatable<ListInstancePartitionOperationsRequest>, IDeepCloneable<ListInstancePartitionOperationsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Spanner Instance Administration v1 API class ListInstancePartitionOperationsRequest.

The request for [ListInstancePartitionOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitionOperations].

Inheritance

object > ListInstancePartitionOperationsRequest

Namespace

Google.Cloud.Spanner.Admin.Instance.V1

Assembly

Google.Cloud.Spanner.Admin.Instance.V1.dll

Constructors

ListInstancePartitionOperationsRequest()

public ListInstancePartitionOperationsRequest()

ListInstancePartitionOperationsRequest(ListInstancePartitionOperationsRequest)

public ListInstancePartitionOperationsRequest(ListInstancePartitionOperationsRequest other)
Parameter
Name Description
other ListInstancePartitionOperationsRequest

Properties

Filter

public string Filter { get; set; }

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.
Property Value
Type Description
string

InstancePartitionDeadline

public Timestamp InstancePartitionDeadline { get; set; }

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

Property Value
Type Description
Timestamp

PageSize

public int PageSize { get; set; }

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

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The parent instance of the instance partition operations. Values are of the form projects/<project>/instances/<instance>.

Property Value
Type Description
string

ParentAsInstanceName

public InstanceName ParentAsInstanceName { get; set; }

Google.Cloud.Spanner.Common.V1.InstanceName-typed view over the Parent resource name property.

Property Value
Type Description
Google.Cloud.Spanner.Common.V1.InstanceName