All Superinterfaces:: com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:: ListBackupOperationsRequest, ListBackupOperationsRequest.Builder

public interface ListBackupOperationsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type

Method

Description

String

getFilter()

An expression that filters the list of returned backup operations.

com.google.protobuf.ByteString

getFilterBytes()

An expression that filters the list of returned backup 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.ListBackupOperationsResponse.next_page_token] from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] 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.ListBackupOperationsResponse.next_page_token] from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] 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 backup 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 backup 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 backup 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 [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] is
      `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
   * `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, but
 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.CreateBackupMetadata) AND` \
      `metadata.database:prod` - Returns operations where:
      * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
      * The database the backup was taken from has a name containing the
      string "prod".
   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
     `(metadata.name:howl) AND` \
     `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
     * The backup name contains the string "howl".
     * The operation started before 2018-03-28T14:50:00Z.
     * The operation resulted in an error.
   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \
     `(metadata.source_backup:test) AND` \
     `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata].
     * The source backup of the copied backup name contains the string
     "test".
     * The operation started before 2022-01-18T14:50:00Z.
     * The operation resulted in an error.
   * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
     `(metadata.database:test_db)) OR` \
     `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata)
     AND` \
     `(metadata.source_backup:test_bkp)) AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata matches either of criteria:
       * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] AND the
       database the backup was taken from has name containing string
       "test_db"
       * The operation's metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata] AND the
       backup the backup was copied from has name containing string
       "test_bkp"
     * 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 backup 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 [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] is
      `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
   * `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, but
 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.CreateBackupMetadata) AND` \
      `metadata.database:prod` - Returns operations where:
      * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
      * The database the backup was taken from has a name containing the
      string "prod".
   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
     `(metadata.name:howl) AND` \
     `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
     * The backup name contains the string "howl".
     * The operation started before 2018-03-28T14:50:00Z.
     * The operation resulted in an error.
   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \
     `(metadata.source_backup:test) AND` \
     `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata].
     * The source backup of the copied backup name contains the string
     "test".
     * The operation started before 2022-01-18T14:50:00Z.
     * The operation resulted in an error.
   * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
     `(metadata.database:test_db)) OR` \
     `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata)
     AND` \
     `(metadata.source_backup:test_bkp)) AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata matches either of criteria:
       * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] AND the
       database the backup was taken from has name containing string
       "test_db"
       * The operation's metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata] AND the
       backup the backup was copied from has name containing string
       "test_bkp"
     * 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.ListBackupOperationsResponse.next_page_token]
 from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] 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.ListBackupOperationsResponse.next_page_token]
 from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] to the
 same `parent` and with the same `filter`.

string page_token = 4;

Returns:: The bytes for pageToken.

Interface ListBackupOperationsRequestOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Methods inherited from interface com.google.protobuf.MessageOrBuilder