Google Cloud Vmware Engine V1 Client - Class ListHcxActivationKeysRequest (0.2.1)

Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class ListHcxActivationKeysRequest.

Request message for VmwareEngine.ListHcxActivationKeys

Generated from protobuf message google.cloud.vmwareengine.v1.ListHcxActivationKeysRequest

Namespace

Google \ Cloud \ VmwareEngine \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the private cloud to be queried for HCX activation keys. 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/privateClouds/my-cloud

↳ page_size int

The maximum number of HCX activation keys 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.

↳ page_token string

A page token, received from a previous ListHcxActivationKeys call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListHcxActivationKeys must match the call that provided the page token.

getParent

Required. The resource name of the private cloud to be queried for HCX activation keys.

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/privateClouds/my-cloud

Returns
TypeDescription
string

setParent

Required. The resource name of the private cloud to be queried for HCX activation keys.

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/privateClouds/my-cloud

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The maximum number of HCX activation keys 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.

Returns
TypeDescription
int

setPageSize

The maximum number of HCX activation keys 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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

A page token, received from a previous ListHcxActivationKeys call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListHcxActivationKeys must match the call that provided the page token.

Returns
TypeDescription
string

setPageToken

A page token, received from a previous ListHcxActivationKeys call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListHcxActivationKeys must match the call that provided the page token.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The resource name of the private cloud to be queried for HCX activation keys. 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/privateClouds/my-cloud Please see Google\Cloud\VmwareEngine\V1\VmwareEngineClient::privateCloudName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\VmwareEngine\V1\ListHcxActivationKeysRequest