Google Cloud Spanner Database Administration v1 API - Class ListDatabaseOperationsRequest (4.1.0) 

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

Reference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class ListDatabaseOperationsRequest.

The request for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].

Inheritance

Object > ListDatabaseOperationsRequest

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

Google.Cloud.Spanner.Admin.Database.V1.dll

Constructors

ListDatabaseOperationsRequest()

public ListDatabaseOperationsRequest()

ListDatabaseOperationsRequest(ListDatabaseOperationsRequest)

public ListDatabaseOperationsRequest(ListDatabaseOperationsRequest other)
Parameter
NameDescription
otherListDatabaseOperationsRequest

Properties

Filter

public string Filter { get; set; }

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][google.longrunning.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 [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata] is type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata.
  • 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.database.v1.RestoreDatabaseMetadata) AND \ (metadata.source_type:BACKUP) AND \ (metadata.backup_info.backup:backup_howl) AND \ (metadata.name:restored_howl) AND \ (metadata.progress.start_time < \&quot;2018-03-28T14:50:00Z\&quot;) AND \ (error:*) - Return operations where:
  • The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
  • The database is restored from a backup.
  • The backup name contains "backup_howl".
  • The restored database's name contains "restored_howl".
  • The operation started before 2018-03-28T14:50:00Z.
  • The operation resulted in an error.
Property Value
TypeDescription
String

PageSize

public int PageSize { get; set; }

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

Property Value
TypeDescription
Int32

PageToken

public string PageToken { get; set; }

If non-empty, page_token should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabaseOperationsResponse.next_page_token] from a previous [ListDatabaseOperationsResponse][google.spanner.admin.database.v1.ListDatabaseOperationsResponse] to the same parent and with the same filter.

Property Value
TypeDescription
String

Parent

public string Parent { get; set; }

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

Property Value
TypeDescription
String

ParentAsInstanceName

public InstanceName ParentAsInstanceName { get; set; }

InstanceName-typed view over the Parent resource name property.

Property Value
TypeDescription
InstanceName