Class ListInstancesRequest (0.19.0)
Version 0.19.0keyboard_arrow_down
public final class ListInstancesRequest extends GeneratedMessageV3 implements ListInstancesRequestOrBuilder
Message for requesting list of Instances
Protobuf type google.cloud.alloydb.v1alpha.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>)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ListInstancesRequest . Builder newBuilder ()
newBuilder(ListInstancesRequest prototype)
public static ListInstancesRequest . Builder newBuilder ( ListInstancesRequest prototype )
public static ListInstancesRequest parseDelimitedFrom ( InputStream input )
public static ListInstancesRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ListInstancesRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ListInstancesRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ListInstancesRequest parseFrom ( CodedInputStream input )
public static ListInstancesRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ListInstancesRequest parseFrom ( InputStream input )
public static ListInstancesRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ListInstancesRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ListInstancesRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public ListInstancesRequest getDefaultInstanceForType ()
getFilter()
public String getFilter ()
Optional. Filtering results
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The filter.
getFilterBytes()
public ByteString getFilterBytes ()
Optional. Filtering results
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for filter.
getOrderBy()
public String getOrderBy ()
Optional. Hint for how to order the results
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The orderBy.
getOrderByBytes()
public ByteString getOrderByBytes ()
Optional. Hint for how to order the results
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for orderBy.
getPageSize()
Optional. Requested page size. Server may return fewer items than
requested. If unspecified, server will pick an appropriate default.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The pageSize.
getPageToken()
public String getPageToken ()
A token identifying a page of results the server should return.
string page_token = 3;
Returns
Type Description
String The pageToken.
getPageTokenBytes()
public ByteString getPageTokenBytes ()
A token identifying a page of results the server should return.
string page_token = 3;
Returns
Type Description
ByteString The bytes for pageToken.
getParent()
public String getParent ()
Required. The name of the parent resource. For the required format, see the
comment on the Instance.name field. Additionally, you can perform an
aggregated list operation by specifying a value with one of the following
formats:
projects/{project}/locations/-/clusters/-
projects/{project}/locations/{region}/clusters/-
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 parent resource. For the required format, see the
comment on the Instance.name field. Additionally, you can perform an
aggregated list operation by specifying a value with one of the following
formats:
projects/{project}/locations/-/clusters/-
projects/{project}/locations/{region}/clusters/-
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 ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ListInstancesRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListInstancesRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public ListInstancesRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-10 UTC."],[],[]]
