Cloud Spanner V1 Client - Class ListDatabaseOperationsRequest (1.54.2)

Version 1.54.2

• 1.89.0 (latest)
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

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

The request for ListDatabaseOperations.

Generated from protobuf message google.spanner.admin.database.v1.ListDatabaseOperationsRequest

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The instance of the database operations. Values are of the form projects/<project>/instances/<instance>.
↳ filter	string 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.&#64;type - the type of metadata. For example, the type string for RestoreDatabaseMetadata is type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata. * metadata.<field_name> - any field in metadata.value. metadata.&#64;type must be specified first, if filtering on metadata fields. * error - Error associated with the long-running operation. * response.&#64;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.&#64;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 < \"2018-03-28T14:50:00Z\") AND \ (error:*) - Return operations where: * The operation's metadata type is 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.
↳ page_size	int 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 If non-empty, page_token should contain a next_page_token from a previous ListDatabaseOperationsResponse to the same parent and with the same filter.

getParent

Required. The instance of the database operations.

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type	Description
string

setParent

Required. The instance of the database operations.

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

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 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 < \"2018-03-28T14:50:00Z\") AND \ (error:*) - Return operations where:
  • The operation's metadata type is 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.

Generated from protobuf field string filter = 2;

Returns
Type	Description
string

setFilter

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 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 < \"2018-03-28T14:50:00Z\") AND \ (error:*) - Return operations where:
  • The operation's metadata type is 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.

Generated from protobuf field string filter = 2;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

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

Generated from protobuf field int32 page_size = 3;

Returns
Type	Description
int

setPageSize

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

Generated from protobuf field int32 page_size = 3;

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

If non-empty, page_token should contain a next_page_token from a previous ListDatabaseOperationsResponse to the same parent and with the same filter.

Generated from protobuf field string page_token = 4;

Returns
Type	Description
string

setPageToken

If non-empty, page_token should contain a next_page_token from a previous ListDatabaseOperationsResponse to the same parent and with the same filter.

Generated from protobuf field string page_token = 4;

Parameter
Name	Description
var	string

Returns
Type	Description
$this