public static final class ListClustersRequest.Builder extends GeneratedMessageV3.Builder<ListClustersRequest.Builder> implements ListClustersRequestOrBuilderMessage for requesting list of Clusters
Protobuf type google.cloud.alloydb.v1alpha.ListClustersRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListClustersRequest.BuilderImplements
ListClustersRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListClustersRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|
build()
public ListClustersRequest build()| Returns | |
|---|---|
| Type | Description |
ListClustersRequest |
|
buildPartial()
public ListClustersRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListClustersRequest |
|
clear()
public ListClustersRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListClustersRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|
clearFilter()
public ListClustersRequest.Builder clearFilter()Optional. Filtering results
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListClustersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|
clearOrderBy()
public ListClustersRequest.Builder clearOrderBy()Optional. Hint for how to order the results
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListClustersRequest.Builder clearPageSize()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 |
ListClustersRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListClustersRequest.Builder clearPageToken()A token identifying a page of results the server should return.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
clearParent()
public ListClustersRequest.Builder clearParent()Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format:
- projects/{project}/locations/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
clone()
public ListClustersRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|
getDefaultInstanceForType()
public ListClustersRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListClustersRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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()
public int 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 Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format:
- projects/{project}/locations/-
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 Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format:
- projects/{project}/locations/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListClustersRequest other)
public ListClustersRequest.Builder mergeFrom(ListClustersRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListClustersRequest |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListClustersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListClustersRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListClustersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListClustersRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|
setFilter(String value)
public ListClustersRequest.Builder setFilter(String value)Optional. Filtering results
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListClustersRequest.Builder setFilterBytes(ByteString value)Optional. Filtering results
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListClustersRequest.Builder setOrderBy(String value)Optional. Hint for how to order the results
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListClustersRequest.Builder setOrderByBytes(ByteString value)Optional. Hint for how to order the results
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListClustersRequest.Builder setPageSize(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListClustersRequest.Builder setPageToken(String value)A token identifying a page of results the server should return.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListClustersRequest.Builder setPageTokenBytes(ByteString value)A token identifying a page of results the server should return.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListClustersRequest.Builder setParent(String value)Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format:
- projects/{project}/locations/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListClustersRequest.Builder setParentBytes(ByteString value)Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format:
- projects/{project}/locations/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListClustersRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListClustersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListClustersRequest.Builder |
|