public static final class ListInstancePartitionOperationsRequest.Builder extends GeneratedMessageV3.Builder<ListInstancePartitionOperationsRequest.Builder> implements ListInstancePartitionOperationsRequestOrBuilderThe request for ListInstancePartitionOperations.
Protobuf type google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListInstancePartitionOperationsRequest.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListInstancePartitionOperationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
build()
public ListInstancePartitionOperationsRequest build()| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest | |
buildPartial()
public ListInstancePartitionOperationsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest | |
clear()
public ListInstancePartitionOperationsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public ListInstancePartitionOperationsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
clearFilter()
public ListInstancePartitionOperationsRequest.Builder clearFilter()Optional. 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 CreateInstancePartitionMetadata istype.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata.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.instance.v1.CreateInstancePartitionMetadata) AND\(metadata.instance_partition.name:custom-instance-partition) AND\(metadata.start_time < \"2021-03-28T14:50:00Z\") AND\(error:*)- Return operations where:- The operation's metadata type is CreateInstancePartitionMetadata.
- The instance partition name contains "custom-instance-partition".
- The operation started before 2021-03-28T14:50:00Z.
- The operation resulted in an error.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | This builder for chaining. |
clearInstancePartitionDeadline()
public ListInstancePartitionOperationsRequest.Builder clearInstancePartitionDeadline()Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable_instance_partitions in ListInstancePartitionOperationsResponse.
.google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListInstancePartitionOperationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
clearPageSize()
public ListInstancePartitionOperationsRequest.Builder clearPageSize()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | This builder for chaining. |
clearPageToken()
public ListInstancePartitionOperationsRequest.Builder clearPageToken()Optional. If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same parent and with the same filter.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | This builder for chaining. |
clearParent()
public ListInstancePartitionOperationsRequest.Builder clearParent()Required. The parent instance of the instance partition 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 |
ListInstancePartitionOperationsRequest.Builder | This builder for chaining. |
clone()
public ListInstancePartitionOperationsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
getDefaultInstanceForType()
public ListInstancePartitionOperationsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getFilter()
public String getFilter()Optional. 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 CreateInstancePartitionMetadata istype.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata.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.instance.v1.CreateInstancePartitionMetadata) AND\(metadata.instance_partition.name:custom-instance-partition) AND\(metadata.start_time < \"2021-03-28T14:50:00Z\") AND\(error:*)- Return operations where:- The operation's metadata type is CreateInstancePartitionMetadata.
- The instance partition name contains "custom-instance-partition".
- The operation started before 2021-03-28T14:50:00Z.
- The operation resulted in an error.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The filter. |
getFilterBytes()
public ByteString getFilterBytes()Optional. 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 CreateInstancePartitionMetadata istype.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata.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.instance.v1.CreateInstancePartitionMetadata) AND\(metadata.instance_partition.name:custom-instance-partition) AND\(metadata.start_time < \"2021-03-28T14:50:00Z\") AND\(error:*)- Return operations where:- The operation's metadata type is CreateInstancePartitionMetadata.
- The instance partition name contains "custom-instance-partition".
- The operation started before 2021-03-28T14:50:00Z.
- The operation resulted in an error.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for filter. |
getInstancePartitionDeadline()
public Timestamp getInstancePartitionDeadline()Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable_instance_partitions in ListInstancePartitionOperationsResponse.
.google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The instancePartitionDeadline. |
getInstancePartitionDeadlineBuilder()
public Timestamp.Builder getInstancePartitionDeadlineBuilder()Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable_instance_partitions in ListInstancePartitionOperationsResponse.
.google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getInstancePartitionDeadlineOrBuilder()
public TimestampOrBuilder getInstancePartitionDeadlineOrBuilder()Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable_instance_partitions in ListInstancePartitionOperationsResponse.
.google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getPageSize()
public int getPageSize()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | The pageSize. |
getPageToken()
public String getPageToken()Optional. If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same parent and with the same filter.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()Optional. If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same parent and with the same filter.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for pageToken. |
getParent()
public String getParent()Required. The parent instance of the instance partition 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 parent instance of the instance partition 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. |
hasInstancePartitionDeadline()
public boolean hasInstancePartitionDeadline()Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable_instance_partitions in ListInstancePartitionOperationsResponse.
.google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the instancePartitionDeadline field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListInstancePartitionOperationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ListInstancePartitionOperationsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
mergeFrom(ListInstancePartitionOperationsRequest other)
public ListInstancePartitionOperationsRequest.Builder mergeFrom(ListInstancePartitionOperationsRequest other)| Parameter | |
|---|---|
| Name | Description |
other | ListInstancePartitionOperationsRequest |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
mergeInstancePartitionDeadline(Timestamp value)
public ListInstancePartitionOperationsRequest.Builder mergeInstancePartitionDeadline(Timestamp value)Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable_instance_partitions in ListInstancePartitionOperationsResponse.
.google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListInstancePartitionOperationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public ListInstancePartitionOperationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
setFilter(String value)
public ListInstancePartitionOperationsRequest.Builder setFilter(String value)Optional. 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 CreateInstancePartitionMetadata istype.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata.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.instance.v1.CreateInstancePartitionMetadata) AND\(metadata.instance_partition.name:custom-instance-partition) AND\(metadata.start_time < \"2021-03-28T14:50:00Z\") AND\(error:*)- Return operations where:- The operation's metadata type is CreateInstancePartitionMetadata.
- The instance partition name contains "custom-instance-partition".
- The operation started before 2021-03-28T14:50:00Z.
- The operation resulted in an error.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListInstancePartitionOperationsRequest.Builder setFilterBytes(ByteString value)Optional. 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 CreateInstancePartitionMetadata istype.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata.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.instance.v1.CreateInstancePartitionMetadata) AND\(metadata.instance_partition.name:custom-instance-partition) AND\(metadata.start_time < \"2021-03-28T14:50:00Z\") AND\(error:*)- Return operations where:- The operation's metadata type is CreateInstancePartitionMetadata.
- The instance partition name contains "custom-instance-partition".
- The operation started before 2021-03-28T14:50:00Z.
- The operation resulted in an error.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | This builder for chaining. |
setInstancePartitionDeadline(Timestamp value)
public ListInstancePartitionOperationsRequest.Builder setInstancePartitionDeadline(Timestamp value)Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable_instance_partitions in ListInstancePartitionOperationsResponse.
.google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
setInstancePartitionDeadline(Timestamp.Builder builderForValue)
public ListInstancePartitionOperationsRequest.Builder setInstancePartitionDeadline(Timestamp.Builder builderForValue)Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable_instance_partitions in ListInstancePartitionOperationsResponse.
.google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
setPageSize(int value)
public ListInstancePartitionOperationsRequest.Builder setPageSize(int value)Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListInstancePartitionOperationsRequest.Builder setPageToken(String value)Optional. If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same parent and with the same filter.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListInstancePartitionOperationsRequest.Builder setPageTokenBytes(ByteString value)Optional. If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same parent and with the same filter.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | This builder for chaining. |
setParent(String value)
public ListInstancePartitionOperationsRequest.Builder setParent(String value)Required. The parent instance of the instance partition 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 |
ListInstancePartitionOperationsRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListInstancePartitionOperationsRequest.Builder setParentBytes(ByteString value)Required. The parent instance of the instance partition 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 |
ListInstancePartitionOperationsRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListInstancePartitionOperationsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListInstancePartitionOperationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListInstancePartitionOperationsRequest.Builder | |