public final class ListInstancesRequest extends GeneratedMessageV3 implements ListInstancesRequestOrBuilder
The request for ListInstances.
Protobuf type google.spanner.admin.instance.v1.ListInstancesRequest
Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static ListInstancesRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public ListInstancesRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getFilter()
public String getFilter()
An expression for filtering the results of the request. Filter rules are
case insensitive. The fields eligible for filtering are:
namedisplay_namelabels.key where key is the name of a label
Some examples of using filters are:name:* --> The instance has a name.name:Howl --> The instance's name contains the string "howl".name:HOWL --> Equivalent to above.NAME:howl --> Equivalent to above.labels.env:* --> The instance has the label "env".labels.env:dev --> The instance has the label "env" and the value of
the label contains the string "dev".name:howl labels.env:dev --> The instance's name contains "howl" and
it has the label "env" with its value
containing "dev".
string filter = 4;
| Type | Description |
| String | The filter.
|
getFilterBytes()
public ByteString getFilterBytes()
An expression for filtering the results of the request. Filter rules are
case insensitive. The fields eligible for filtering are:
namedisplay_namelabels.key where key is the name of a label
Some examples of using filters are:name:* --> The instance has a name.name:Howl --> The instance's name contains the string "howl".name:HOWL --> Equivalent to above.NAME:howl --> Equivalent to above.labels.env:* --> The instance has the label "env".labels.env:dev --> The instance has the label "env" and the value of
the label contains the string "dev".name:howl labels.env:dev --> The instance's name contains "howl" and
it has the label "env" with its value
containing "dev".
string filter = 4;
getPageSize()
Number of instances to be returned in the response. If 0 or less, defaults
to the server's maximum allowed page size.
int32 page_size = 2;
| Type | Description |
| int | The pageSize.
|
getPageToken()
public String getPageToken()
If non-empty, page_token should contain a
next_page_token from a
previous ListInstancesResponse.
string page_token = 3;
| Type | Description |
| String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
If non-empty, page_token should contain a
next_page_token from a
previous ListInstancesResponse.
string page_token = 3;
getParent()
public String getParent()
Required. The name of the project for which a list of instances is
requested. Values are of the form projects/<project>.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The name of the project for which a list of instances is
requested. Values are of the form projects/<project>.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParserForType()
public Parser<ListInstancesRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static ListInstancesRequest.Builder newBuilder()
Returns
newBuilder(ListInstancesRequest prototype)
public static ListInstancesRequest.Builder newBuilder(ListInstancesRequest prototype)
Parameter
Returns
newBuilderForType()
public ListInstancesRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListInstancesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static ListInstancesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListInstancesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListInstancesRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListInstancesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListInstancesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListInstancesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListInstancesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListInstancesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListInstancesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListInstancesRequest> parser()
Returns
toBuilder()
public ListInstancesRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
