public static final class ListDatabaseOperationsRequest.Builder extends GeneratedMessageV3.Builder<ListDatabaseOperationsRequest.Builder> implements ListDatabaseOperationsRequestOrBuilderThe request for ListDatabaseOperations.
Protobuf type google.spanner.admin.database.v1.ListDatabaseOperationsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListDatabaseOperationsRequest.BuilderImplements
ListDatabaseOperationsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListDatabaseOperationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |
build()
public ListDatabaseOperationsRequest build()| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest | |
buildPartial()
public ListDatabaseOperationsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest | |
clear()
public ListDatabaseOperationsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public ListDatabaseOperationsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |
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 are eligible for filtering:
name- The name of the long-running operationdone- False if the operation is in progress, else true.metadata.@type- the type of metadata. For example, the type string for RestoreDatabaseMetadata istype.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata.metadata.<field_name>- any field in metadata.value.metadata.@typemust 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.
string filter = 2;
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListDatabaseOperationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |
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 | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | This builder for chaining. |
clearPageToken()
public ListDatabaseOperationsRequest.Builder clearPageToken() If non-empty, page_token should contain a
next_page_token
from a previous ListDatabaseOperationsResponse to the
same parent and with the same filter.
string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | 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 | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | This builder for chaining. |
clone()
public ListDatabaseOperationsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |
getDefaultInstanceForType()
public ListDatabaseOperationsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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 are eligible for filtering:
name- The name of the long-running operationdone- False if the operation is in progress, else true.metadata.@type- the type of metadata. For example, the type string for RestoreDatabaseMetadata istype.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata.metadata.<field_name>- any field in metadata.value.metadata.@typemust 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.
string filter = 2;
| Returns | |
|---|---|
| Type | Description |
String | The filter. |
getFilterBytes()
public 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 are eligible for filtering:
name- The name of the long-running operationdone- False if the operation is in progress, else true.metadata.@type- the type of metadata. For example, the type string for RestoreDatabaseMetadata istype.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata.metadata.<field_name>- any field in metadata.value.metadata.@typemust 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.
string filter = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString | 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;
| Returns | |
|---|---|
| Type | Description |
int | The pageSize. |
getPageToken()
public String 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.
string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes() If non-empty, page_token should contain a
next_page_token
from a previous ListDatabaseOperationsResponse to the
same parent and with the same filter.
string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for pageToken. |
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The parent. |
getParentBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListDatabaseOperationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ListDatabaseOperationsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |
mergeFrom(ListDatabaseOperationsRequest other)
public ListDatabaseOperationsRequest.Builder mergeFrom(ListDatabaseOperationsRequest other)| Parameter | |
|---|---|
| Name | Description |
other | ListDatabaseOperationsRequest |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListDatabaseOperationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public ListDatabaseOperationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |
setFilter(String value)
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 are eligible for filtering:
name- The name of the long-running operationdone- False if the operation is in progress, else true.metadata.@type- the type of metadata. For example, the type string for RestoreDatabaseMetadata istype.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata.metadata.<field_name>- any field in metadata.value.metadata.@typemust 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.
string filter = 2;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListDatabaseOperationsRequest.Builder setFilterBytes(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 are eligible for filtering:
name- The name of the long-running operationdone- False if the operation is in progress, else true.metadata.@type- the type of metadata. For example, the type string for RestoreDatabaseMetadata istype.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata.metadata.<field_name>- any field in metadata.value.metadata.@typemust 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.
string filter = 2;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | This builder for chaining. |
setPageSize(int value)
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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListDatabaseOperationsRequest.Builder setPageToken(String value) If non-empty, page_token should contain a
next_page_token
from a previous ListDatabaseOperationsResponse to the
same parent and with the same filter.
string page_token = 4;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListDatabaseOperationsRequest.Builder setPageTokenBytes(ByteString value) If non-empty, page_token should contain a
next_page_token
from a previous ListDatabaseOperationsResponse to the
same parent and with the same filter.
string page_token = 4;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | This builder for chaining. |
setParent(String value)
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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListDatabaseOperationsRequest.Builder setParentBytes(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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListDatabaseOperationsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListDatabaseOperationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListDatabaseOperationsRequest.Builder | |