Package com.google.spanner.admin.database.v1

Interface ListDatabaseOperationsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListDatabaseOperationsRequest, ListDatabaseOperationsRequest.Builder

public interface ListDatabaseOperationsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
String	getFilter()	An expression that filters the list of returned operations.
com.google.protobuf.ByteString	getFilterBytes()	An expression that filters the list of returned operations.
int	getPageSize()	Number of operations to be returned in the response.
String	getPageToken()	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`.
com.google.protobuf.ByteString	getPageTokenBytes()	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`.
String	getParent()	Required.
com.google.protobuf.ByteString	getParentBytes()	Required.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getParent

String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getFilter

String 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][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 < \"2018-03-28T14:50:00Z\") 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.
 

string filter = 2;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 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 < \"2018-03-28T14:50:00Z\") 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.
 

string filter = 2;

Returns:

The bytes for filter.

getPageSize

int getPageSize()

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

int32 page_size = 3;

Returns:

The pageSize.

getPageToken

String getPageToken()

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

string page_token = 4;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

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

string page_token = 4;

Returns:

The bytes for pageToken.