public final class ListInstancesRequest extends GeneratedMessageV3 implements ListInstancesRequestOrBuilderThe request for ListInstances.
Protobuf type google.spanner.admin.instance.v1.ListInstancesRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListInstancesRequestImplements
ListInstancesRequestOrBuilderStatic Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INSTANCE_DEADLINE_FIELD_NUMBER
public static final int INSTANCE_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 ListInstancesRequest getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static ListInstancesRequest.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder |
|
newBuilder(ListInstancesRequest prototype)
public static ListInstancesRequest.Builder newBuilder(ListInstancesRequest prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
ListInstancesRequest |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder |
|
parseDelimitedFrom(InputStream input)
public static ListInstancesRequest parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static ListInstancesRequest parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static ListInstancesRequest parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static ListInstancesRequest parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static ListInstancesRequest parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static ListInstancesRequest parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<ListInstancesRequest> parser()| Returns | |
|---|---|
| Type | Description |
Parser<ListInstancesRequest> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public ListInstancesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|
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.keywhere key is the name of a labelSome 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;
| Returns | |
|---|---|
| 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.keywhere key is the name of a labelSome 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getInstanceDeadline()
public Timestamp getInstanceDeadline()Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.
.google.protobuf.Timestamp instance_deadline = 5;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The instanceDeadline. |
getInstanceDeadlineOrBuilder()
public TimestampOrBuilder getInstanceDeadlineOrBuilder()Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.
.google.protobuf.Timestamp instance_deadline = 5;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getPageSize()
public int 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
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) = { ... }
| Returns | |
|---|---|
| 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getParserForType()
public Parser<ListInstancesRequest> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<ListInstancesRequest> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hasInstanceDeadline()
public boolean hasInstanceDeadline()Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.
.google.protobuf.Timestamp instance_deadline = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the instanceDeadline field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public ListInstancesRequest.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListInstancesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public ListInstancesRequest.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|