public final class ListInstancePartitionOperationsRequest extends GeneratedMessageV3 implements ListInstancePartitionOperationsRequestOrBuilder
The request for ListInstancePartitionOperations.
Protobuf type google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INSTANCE_PARTITION_DEADLINE_FIELD_NUMBER
public static final int INSTANCE_PARTITION_DEADLINE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ListInstancePartitionOperationsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListInstancePartitionOperationsRequest.Builder newBuilder()
newBuilder(ListInstancePartitionOperationsRequest )
public static ListInstancePartitionOperationsRequest.Builder newBuilder(ListInstancePartitionOperationsRequest )
public static ListInstancePartitionOperationsRequest parseDelimitedFrom(InputStream input)
public static ListInstancePartitionOperationsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListInstancePartitionOperationsRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListInstancePartitionOperationsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListInstancePartitionOperationsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListInstancePartitionOperationsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListInstancePartitionOperationsRequest parseFrom(CodedInputStream input)
public static ListInstancePartitionOperationsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListInstancePartitionOperationsRequest parseFrom(InputStream input)
public static ListInstancePartitionOperationsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListInstancePartitionOperationsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListInstancePartitionOperationsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListInstancePartitionOperationsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
OverridesgetDefaultInstanceForType()
public ListInstancePartitionOperationsRequest getDefaultInstanceForType()
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 is type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata.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.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 is type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata.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.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 in ListInstancePartitionOperationsResponse.
.google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Timestamp | The instancePartitionDeadline. |
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 in ListInstancePartitionOperationsResponse.
.google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
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. |
getParserForType()
public Parser<ListInstancePartitionOperationsRequest> getParserForType()
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
OverrideshasInstancePartitionDeadline()
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 in ListInstancePartitionOperationsResponse.
.google.protobuf.Timestamp instance_partition_deadline = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the instancePartitionDeadline field is set. |
hashCode()
| Returns |
|---|
| Type | Description |
int | |
OverridesinternalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
isInitialized()
public final boolean isInitialized()
newBuilderForType()
public ListInstancePartitionOperationsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListInstancePartitionOperationsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
toBuilder()
public ListInstancePartitionOperationsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)