Class ListInstancesRequest (2.43.0)

publicfinalclass ListInstancesRequestextendsGeneratedMessageV3implementsListInstancesRequestOrBuilder

Request for ListInstances.

Protobuf type google.cloud.memcache.v1.ListInstancesRequest

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

publicstaticfinalintFILTER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

publicstaticfinalintORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

publicstaticfinalintPAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

publicstaticfinalintPAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

publicstaticfinalintPARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticListInstancesRequestgetDefaultInstance()
Returns
Type Description
ListInstancesRequest

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticListInstancesRequest.BuildernewBuilder()
Returns
Type Description
ListInstancesRequest.Builder

newBuilder(ListInstancesRequest prototype)

publicstaticListInstancesRequest.BuildernewBuilder(ListInstancesRequestprototype)
Parameter
Name Description
prototype ListInstancesRequest
Returns
Type Description
ListInstancesRequest.Builder

parseDelimitedFrom(InputStream input)

publicstaticListInstancesRequestparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticListInstancesRequestparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticListInstancesRequestparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticListInstancesRequestparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticListInstancesRequestparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticListInstancesRequestparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<ListInstancesRequest>parser()
Returns
Type Description
Parser<ListInstancesRequest>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicListInstancesRequestgetDefaultInstanceForType()
Returns
Type Description
ListInstancesRequest

getFilter()

publicStringgetFilter()

List filter. For example, exclude all Memcached instances with name as my-instance by specifying "name != my-instance".

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

publicByteStringgetFilterBytes()

List filter. For example, exclude all Memcached instances with name as my-instance by specifying "name != my-instance".

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

publicStringgetOrderBy()

Sort results. Supported values are "name", "name desc" or "" (unsorted).

string order_by = 5;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

publicByteStringgetOrderByBytes()

Sort results. Supported values are "name", "name desc" or "" (unsorted).

string order_by = 5;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

publicintgetPageSize()

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

publicStringgetPageToken()

The next_page_token value returned from a previous List request, if any.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

publicByteStringgetPageTokenBytes()

The next_page_token value returned from a previous List request, if any.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

publicStringgetParent()

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

publicByteStringgetParentBytes()

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

publicParser<ListInstancesRequest>getParserForType()
Returns
Type Description
Parser<ListInstancesRequest>
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicListInstancesRequest.BuildernewBuilderForType()
Returns
Type Description
ListInstancesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedListInstancesRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListInstancesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicListInstancesRequest.BuildertoBuilder()
Returns
Type Description
ListInstancesRequest.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.