1. class
  2. Google
  3. \
  4. Service
  5. \
  6. VMwareEngine
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsPrivateCloudsHcxActivationKeys

ProjectsLocationsPrivateCloudsHcxActivationKeys

class ProjectsLocationsPrivateCloudsHcxActivationKeys extends Resource (View source)

The "hcxActivationKeys" collection of methods.

Typical usage is:

 $vmwareengineService = new Google\Service\VMwareEngine(...);
 $hcxActivationKeys = $vmwareengineService->projects_locations_privateClouds_hcxActivationKeys;

Methods

Operation
create(string $parent, HcxActivationKey $postBody, array $optParams = [])

Creates a new HCX activation key in a given private cloud.

HcxActivationKey
get(string $name, array $optParams = [])

Retrieves a HcxActivationKey resource by its resource name.

Policy
getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ListHcxActivationKeysResponse
listProjectsLocationsPrivateCloudsHcxActivationKeys(string $parent, array $optParams = [])

Lists HcxActivationKey resources in a given private cloud.

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (hcxActivationKeys.setIamPolicy)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

at line 71
Operation create(string $parent, HcxActivationKey $postBody, array $optParams = [])

Creates a new HCX activation key in a given private cloud.

(hcxActivationKeys.create)

Parameters

string $parent

Required. The resource name of the private cloud to create the key for. 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
HcxActivationKey $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 90
HcxActivationKey get(string $name, array $optParams = [])

Retrieves a HcxActivationKey resource by its resource name.

(hcxActivationKeys.get)

Parameters

string $name

Required. The resource name of the HCX activation key to retrieve. 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/hcxActivationKeys/my-key
array $optParams

Optional parameters.

Return Value

HcxActivationKey

Exceptions

Exception

at line 122
Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

(hcxActivationKeys.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 149
ListHcxActivationKeysResponse listProjectsLocationsPrivateCloudsHcxActivationKeys(string $parent, array $optParams = [])

Lists HcxActivationKey resources in a given private cloud.

(hcxActivationKeys.listProjectsLocationsPrivateCloudsHcxActivationKeys)

Parameters

string $parent

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
array $optParams

Optional parameters.

Return Value

ListHcxActivationKeysResponse

Exceptions

Exception

at line 169
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (hcxActivationKeys.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 192
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (hcxActivationKeys.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception