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
ListInstancesRequestOrBuilderFields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER| Type | Description |
| int |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER| Type | Description |
| int |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER| Type | Description |
| int |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER| Type | Description |
| int |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getDefaultInstance()
public static ListInstancesRequest getDefaultInstance()| Type | Description |
| ListInstancesRequest |
getDefaultInstanceForType()
public ListInstancesRequest getDefaultInstanceForType()| Type | Description |
| ListInstancesRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
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 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.keywhere 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 |
| ByteString | The bytes for filter. |
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;
| 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;
| 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) = { ... }
| 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) = { ... }
| Type | Description |
| ByteString | The bytes for parent. |
getParserForType()
public Parser<ListInstancesRequest> getParserForType()| Type | Description |
| Parser<ListInstancesRequest> |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilder()
public static ListInstancesRequest.Builder newBuilder()| Type | Description |
| ListInstancesRequest.Builder |
newBuilder(ListInstancesRequest prototype)
public static ListInstancesRequest.Builder newBuilder(ListInstancesRequest prototype)| Name | Description |
| prototype | ListInstancesRequest |
| Type | Description |
| ListInstancesRequest.Builder |
newBuilderForType()
public ListInstancesRequest.Builder newBuilderForType()| Type | Description |
| ListInstancesRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListInstancesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| ListInstancesRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
parseDelimitedFrom(InputStream input)
public static ListInstancesRequest parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static ListInstancesRequest parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ListInstancesRequest parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ListInstancesRequest parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static ListInstancesRequest parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static ListInstancesRequest parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListInstancesRequest |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<ListInstancesRequest> parser()| Type | Description |
| Parser<ListInstancesRequest> |
toBuilder()
public ListInstancesRequest.Builder toBuilder()| Type | Description |
| ListInstancesRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |