public final class ListInstanceConfigOperationsRequest extends GeneratedMessageV3 implements ListInstanceConfigOperationsRequestOrBuilder
The request for ListInstanceConfigOperations.
Protobuf type google.spanner.admin.instance.v1.ListInstanceConfigOperationsRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListInstanceConfigOperationsRequestImplements
ListInstanceConfigOperationsRequestOrBuilderStatic Fields
FILTER_FIELD_NUMBER
public static final int FILTER_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 ListInstanceConfigOperationsRequest getDefaultInstance()
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static ListInstanceConfigOperationsRequest.Builder newBuilder()
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest.Builder |
newBuilder(ListInstanceConfigOperationsRequest prototype)
public static ListInstanceConfigOperationsRequest.Builder newBuilder(ListInstanceConfigOperationsRequest prototype)
Parameter | |
---|---|
Name | Description |
prototype |
ListInstanceConfigOperationsRequest |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest.Builder |
parseDelimitedFrom(InputStream input)
public static ListInstanceConfigOperationsRequest parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListInstanceConfigOperationsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static ListInstanceConfigOperationsRequest parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListInstanceConfigOperationsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ListInstanceConfigOperationsRequest parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListInstanceConfigOperationsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ListInstanceConfigOperationsRequest parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListInstanceConfigOperationsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static ListInstanceConfigOperationsRequest parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListInstanceConfigOperationsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static ListInstanceConfigOperationsRequest parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListInstanceConfigOperationsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<ListInstanceConfigOperationsRequest> parser()
Returns | |
---|---|
Type | Description |
Parser<ListInstanceConfigOperationsRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public ListInstanceConfigOperationsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListInstanceConfigOperationsRequest |
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 CreateInstanceConfigMetadata istype.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata
.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.CreateInstanceConfigMetadata) AND
\(metadata.instance_config.name:custom-config) AND
\(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND
\(error:*)
- Return operations where:- The operation's metadata type is CreateInstanceConfigMetadata.
- The instance config name contains "custom-config".
- The operation started before 2021-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 CreateInstanceConfigMetadata istype.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata
.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.CreateInstanceConfigMetadata) AND
\(metadata.instance_config.name:custom-config) AND
\(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND
\(error:*)
- Return operations where:- The operation's metadata type is CreateInstanceConfigMetadata.
- The instance config name contains "custom-config".
- The operation started before 2021-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
ListInstanceConfigOperationsResponse
to the same parent
and with the same filter
.
string page_token = 4;
Returns | |
---|---|