Class ListClustersRequest.Builder (0.36.0)

public static final class ListClustersRequest.Builder extends GeneratedMessageV3.Builder<ListClustersRequest.Builder> implements ListClustersRequestOrBuilder

Request message for VmwareEngine.ListClusters

Protobuf type google.cloud.vmwareengine.v1.ListClustersRequest

Static 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
Overrides

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
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListClustersRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListClustersRequest.Builder
Overrides

clearFilter()

public ListClustersRequest.Builder clearFilter()

To filter on multiple expressions, provide each separate expression within parentheses. For example: ` (name = "example-cluster") (nodeCount = "3")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "example-cluster-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") `

string filter = 4;

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
Overrides

clearOrderBy()

public ListClustersRequest.Builder clearOrderBy()

Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

string order_by = 5;

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

clearPageSize()

public ListClustersRequest.Builder clearPageSize()

The maximum number of clusters to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.

int32 page_size = 2;

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

clearPageToken()

public ListClustersRequest.Builder clearPageToken()

A page token, received from a previous ListClusters call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListClusters must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

clearParent()

public ListClustersRequest.Builder clearParent()

Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

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
Overrides

getDefaultInstanceForType()

public ListClustersRequest getDefaultInstanceForType()
Returns
Type Description
ListClustersRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

To filter on multiple expressions, provide each separate expression within parentheses. For example: ` (name = "example-cluster") (nodeCount = "3")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "example-cluster-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") `

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

To filter on multiple expressions, provide each separate expression within parentheses. For example: ` (name = "example-cluster") (nodeCount = "3")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "example-cluster-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") `

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

string order_by = 5;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

string order_by = 5;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

The maximum number of clusters to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous ListClusters call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListClusters must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous ListClusters call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListClusters must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

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
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListClustersRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListClustersRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListClustersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListClustersRequest.Builder
Overrides

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
Overrides

setFilter(String value)

public ListClustersRequest.Builder setFilter(String value)

To filter on multiple expressions, provide each separate expression within parentheses. For example: ` (name = "example-cluster") (nodeCount = "3")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "example-cluster-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") `

string filter = 4;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListClustersRequest.Builder setFilterBytes(ByteString value)

To filter on multiple expressions, provide each separate expression within parentheses. For example: ` (name = "example-cluster") (nodeCount = "3")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "example-cluster-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") `

string filter = 4;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListClustersRequest.Builder setOrderBy(String value)

Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

string order_by = 5;

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListClustersRequest.Builder setOrderByBytes(ByteString value)

Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

string order_by = 5;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListClustersRequest.Builder setPageSize(int value)

The maximum number of clusters to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListClustersRequest.Builder setPageToken(String value)

A page token, received from a previous ListClusters call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListClusters must match the call that provided the page token.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListClustersRequest.Builder setPageTokenBytes(ByteString value)

A page token, received from a previous ListClusters call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListClusters must match the call that provided the page token.

string page_token = 3;

Parameter
Name Description
value ByteString

The 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 resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListClustersRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

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

Parameter
Name Description
value ByteString

The 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
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListClustersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListClustersRequest.Builder
Overrides