Class ListPrivateCloudsRequest.Builder (0.48.0) 

public static final class ListPrivateCloudsRequest.Builder extends GeneratedMessageV3.Builder<ListPrivateCloudsRequest.Builder> implements ListPrivateCloudsRequestOrBuilder

Request message for VmwareEngine.ListPrivateClouds

Protobuf type google.cloud.vmwareengine.v1.ListPrivateCloudsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListPrivateCloudsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListPrivateCloudsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListPrivateCloudsRequest.Builder
Overrides

build()

public ListPrivateCloudsRequest build()
Returns
Type Description
ListPrivateCloudsRequest

buildPartial()

public ListPrivateCloudsRequest buildPartial()
Returns
Type Description
ListPrivateCloudsRequest

clear()

public ListPrivateCloudsRequest.Builder clear()
Returns
Type Description
ListPrivateCloudsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListPrivateCloudsRequest.Builder clearFilter()

A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =, !=, >, or <.

For example, if you are filtering a list of private clouds, you can exclude the ones named example-pc by specifying name != "example-pc".

You can also filter nested fields. For example, you could specify networkConfig.managementCidr = "192.168.0.0/24" to include private clouds only if they have a matching address in their network configuration.

To filter on multiple expressions, provide each separate expression within parentheses. For example: ` (name = "example-pc") (createTime > "2021-04-12T08:15:10.40Z")

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

string filter = 4;

Returns
Type Description
ListPrivateCloudsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListPrivateCloudsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListPrivateCloudsRequest.Builder
Overrides

clearOrderBy()

public ListPrivateCloudsRequest.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
ListPrivateCloudsRequest.Builder

This builder for chaining.

clearPageSize()

public ListPrivateCloudsRequest.Builder clearPageSize()

The maximum number of private clouds 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
ListPrivateCloudsRequest.Builder

This builder for chaining.

clearPageToken()

public ListPrivateCloudsRequest.Builder clearPageToken()

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

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

string page_token = 3;

Returns
Type Description
ListPrivateCloudsRequest.Builder

This builder for chaining.

clearParent()

public ListPrivateCloudsRequest.Builder clearParent()

Required. The resource name of the private cloud to be queried 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

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

Returns
Type Description
ListPrivateCloudsRequest.Builder

This builder for chaining.

clone()

public ListPrivateCloudsRequest.Builder clone()
Returns
Type Description
ListPrivateCloudsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListPrivateCloudsRequest getDefaultInstanceForType()
Returns
Type Description
ListPrivateCloudsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =, !=, >, or <.

For example, if you are filtering a list of private clouds, you can exclude the ones named example-pc by specifying name != "example-pc".

You can also filter nested fields. For example, you could specify networkConfig.managementCidr = "192.168.0.0/24" to include private clouds only if they have a matching address in their network configuration.

To filter on multiple expressions, provide each separate expression within parentheses. For example: ` (name = "example-pc") (createTime > "2021-04-12T08:15:10.40Z")

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

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =, !=, >, or <.

For example, if you are filtering a list of private clouds, you can exclude the ones named example-pc by specifying name != "example-pc".

You can also filter nested fields. For example, you could specify networkConfig.managementCidr = "192.168.0.0/24" to include private clouds only if they have a matching address in their network configuration.

To filter on multiple expressions, provide each separate expression within parentheses. For example: ` (name = "example-pc") (createTime > "2021-04-12T08:15:10.40Z")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "private-cloud-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "private-cloud-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 private clouds 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 ListPrivateClouds call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPrivateClouds 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 ListPrivateClouds call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPrivateClouds 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 be queried 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

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 be queried 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

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(ListPrivateCloudsRequest other)

public ListPrivateCloudsRequest.Builder mergeFrom(ListPrivateCloudsRequest other)
Parameter
Name Description
other ListPrivateCloudsRequest
Returns
Type Description
ListPrivateCloudsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListPrivateCloudsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPrivateCloudsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

public ListPrivateCloudsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListPrivateCloudsRequest.Builder
Overrides

setFilter(String value)

public ListPrivateCloudsRequest.Builder setFilter(String value)

A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =, !=, >, or <.

For example, if you are filtering a list of private clouds, you can exclude the ones named example-pc by specifying name != "example-pc".

You can also filter nested fields. For example, you could specify networkConfig.managementCidr = "192.168.0.0/24" to include private clouds only if they have a matching address in their network configuration.

To filter on multiple expressions, provide each separate expression within parentheses. For example: ` (name = "example-pc") (createTime > "2021-04-12T08:15:10.40Z")

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

string filter = 4;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListPrivateCloudsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListPrivateCloudsRequest.Builder setFilterBytes(ByteString value)

A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =, !=, >, or <.

For example, if you are filtering a list of private clouds, you can exclude the ones named example-pc by specifying name != "example-pc".

You can also filter nested fields. For example, you could specify networkConfig.managementCidr = "192.168.0.0/24" to include private clouds only if they have a matching address in their network configuration.

To filter on multiple expressions, provide each separate expression within parentheses. For example: ` (name = "example-pc") (createTime > "2021-04-12T08:15:10.40Z")

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

string filter = 4;

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListPrivateCloudsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListPrivateCloudsRequest.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
ListPrivateCloudsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListPrivateCloudsRequest.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
ListPrivateCloudsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListPrivateCloudsRequest.Builder setPageSize(int value)

The maximum number of private clouds 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
ListPrivateCloudsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListPrivateCloudsRequest.Builder setPageToken(String value)

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

When paginating, all other parameters provided to ListPrivateClouds 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
ListPrivateCloudsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListPrivateCloudsRequest.Builder setPageTokenBytes(ByteString value)

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

When paginating, all other parameters provided to ListPrivateClouds 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
ListPrivateCloudsRequest.Builder

This builder for chaining.

setParent(String value)

public ListPrivateCloudsRequest.Builder setParent(String value)

Required. The resource name of the private cloud to be queried 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

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListPrivateCloudsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListPrivateCloudsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the private cloud to be queried 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

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
ListPrivateCloudsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListPrivateCloudsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListPrivateCloudsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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