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

Class ListBackupOperationsRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListBackupOperationsRequestOrBuilder, Serializable
    public final class ListBackupOperationsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListBackupOperationsRequestOrBuilder
     The request for
 [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].
    Protobuf type google.spanner.admin.database.v1.ListBackupOperationsRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface ListBackupOperationsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface ListBackupOperationsRequestOrBuilder
        Returns:
        The bytes for parent.

      • getFilter

        public 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;
        Specified by:
        getFilter in interface ListBackupOperationsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public 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;
        Specified by:
        getFilterBytes in interface ListBackupOperationsRequestOrBuilder
        Returns:
        The bytes for filter.

      • getPageSize

        public 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;
        Specified by:
        getPageSize in interface ListBackupOperationsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public 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;
        Specified by:
        getPageToken in interface ListBackupOperationsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public 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;
        Specified by:
        getPageTokenBytes in interface ListBackupOperationsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ListBackupOperationsRequest parseFrom​(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListBackupOperationsRequest parseFrom​(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListBackupOperationsRequest parseFrom​(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListBackupOperationsRequest parseFrom​(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListBackupOperationsRequest parseFrom​(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListBackupOperationsRequest parseFrom​(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public ListBackupOperationsRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ListBackupOperationsRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ListBackupOperationsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ListBackupOperationsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ListBackupOperationsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder