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

Class ListDatabaseOperationsRequest.Builder

    • Method Detail

      • 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.Builder<ListDatabaseOperationsRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListDatabaseOperationsRequest.Builder>

      • getDefaultInstanceForType

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

      • build

        public ListDatabaseOperationsRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public ListDatabaseOperationsRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

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

      • mergeFrom

        public ListDatabaseOperationsRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDatabaseOperationsRequest.Builder>
        Throws:
        IOException

      • getParent

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

      • getParentBytes

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

      • setParent

        public ListDatabaseOperationsRequest.Builder setParent​(String value)
         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) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public ListDatabaseOperationsRequest.Builder clearParent()
         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:
        This builder for chaining.

      • setParentBytes

        public ListDatabaseOperationsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

      • getFilter

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

      • getFilterBytes

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

      • setFilter

        public ListDatabaseOperationsRequest.Builder setFilter​(String value)
         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;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public ListDatabaseOperationsRequest.Builder clearFilter()
         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:
        This builder for chaining.

      • setFilterBytes

        public ListDatabaseOperationsRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • 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 ListDatabaseOperationsRequestOrBuilder
        Returns:
        The pageSize.

      • setPageSize

        public ListDatabaseOperationsRequest.Builder setPageSize​(int value)
         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;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public ListDatabaseOperationsRequest.Builder clearPageSize()
         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:
        This builder for chaining.

      • getPageToken

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

      • setPageToken

        public ListDatabaseOperationsRequest.Builder setPageToken​(String value)
         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;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public ListDatabaseOperationsRequest.Builder clearPageToken()
         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:
        This builder for chaining.

      • setPageTokenBytes

        public ListDatabaseOperationsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.