Class ListClustersRequest.Builder (0.9.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListClustersRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListClustersRequest.Builder
Overrides

build()

public ListClustersRequest build()
Returns
TypeDescription
ListClustersRequest

buildPartial()

public ListClustersRequest buildPartial()
Returns
TypeDescription
ListClustersRequest

clear()

public ListClustersRequest.Builder clear()
Returns
TypeDescription
ListClustersRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListClustersRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListClustersRequest.Builder
Overrides

clearFilter()

public ListClustersRequest.Builder clearFilter()

To filter on multiple expressions, provide each separate expression within parentheses. For example: <code><code> (name = "example-cluster") (nodeCount = "3") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (name = "example-cluster-1") AND (createTime &gt; "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") </code></code>

string filter = 4;

Returns
TypeDescription
ListClustersRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListClustersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ListClustersRequest.Builder

This builder for chaining.

clone()

public ListClustersRequest.Builder clone()
Returns
TypeDescription
ListClustersRequest.Builder
Overrides

getDefaultInstanceForType()

public ListClustersRequest getDefaultInstanceForType()
Returns
TypeDescription
ListClustersRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

To filter on multiple expressions, provide each separate expression within parentheses. For example: <code><code> (name = "example-cluster") (nodeCount = "3") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (name = "example-cluster-1") AND (createTime &gt; "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") </code></code>

string filter = 4;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

To filter on multiple expressions, provide each separate expression within parentheses. For example: <code><code> (name = "example-cluster") (nodeCount = "3") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (name = "example-cluster-1") AND (createTime &gt; "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") </code></code>

string filter = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListClustersRequest other)

public ListClustersRequest.Builder mergeFrom(ListClustersRequest other)
Parameter
NameDescription
otherListClustersRequest
Returns
TypeDescription
ListClustersRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListClustersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListClustersRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListClustersRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListClustersRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListClustersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListClustersRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListClustersRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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: <code><code> (name = "example-cluster") (nodeCount = "3") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (name = "example-cluster-1") AND (createTime &gt; "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") </code></code>

string filter = 4;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
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: <code><code> (name = "example-cluster") (nodeCount = "3") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (name = "example-cluster-1") AND (createTime &gt; "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") </code></code>

string filter = 4;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
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
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListClustersRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListClustersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListClustersRequest.Builder
Overrides