Class ListPrivateCloudsRequest (0.38.0)

public final class ListPrivateCloudsRequest extends GeneratedMessageV3 implements ListPrivateCloudsRequestOrBuilder

Request message for VmwareEngine.ListPrivateClouds

Protobuf type google.cloud.vmwareengine.v1.ListPrivateCloudsRequest

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 ListPrivateCloudsRequest getDefaultInstance()
Returns
Type Description
ListPrivateCloudsRequest

getDescriptor()

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

newBuilder()

public static ListPrivateCloudsRequest.Builder newBuilder()
Returns
Type Description
ListPrivateCloudsRequest.Builder

newBuilder(ListPrivateCloudsRequest prototype)

public static ListPrivateCloudsRequest.Builder newBuilder(ListPrivateCloudsRequest prototype)
Parameter
Name Description
prototype ListPrivateCloudsRequest
Returns
Type Description
ListPrivateCloudsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListPrivateCloudsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPrivateCloudsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListPrivateCloudsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListPrivateCloudsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListPrivateCloudsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListPrivateCloudsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListPrivateCloudsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPrivateCloudsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListPrivateCloudsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPrivateCloudsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListPrivateCloudsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListPrivateCloudsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPrivateCloudsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListPrivateCloudsRequest> parser()
Returns
Type Description
Parser<ListPrivateCloudsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListPrivateCloudsRequest getDefaultInstanceForType()
Returns
Type Description
ListPrivateCloudsRequest

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.

getParserForType()

public Parser<ListPrivateCloudsRequest> getParserForType()
Returns
Type Description
Parser<ListPrivateCloudsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListPrivateCloudsRequest.Builder newBuilderForType()
Returns
Type Description
ListPrivateCloudsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListPrivateCloudsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListPrivateCloudsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListPrivateCloudsRequest.Builder toBuilder()
Returns
Type Description
ListPrivateCloudsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException