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

ProjectsLocationsPrivateCloudsClusters

class ProjectsLocationsPrivateCloudsClusters extends Resource (View source)

The "clusters" collection of methods.

Typical usage is:

 $vmwareengineService = new Google\Service\VMwareEngine(...);
 $clusters = $vmwareengineService->projects_locations_privateClouds_clusters;

Methods

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

Creates a new cluster in a given private cloud. Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient node quota.

Operation
delete(string $name, array $optParams = [])

Deletes a Cluster resource. To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion.

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

Retrieves a Cluster resource by its resource name. (clusters.get)

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. (clusters.getIamPolicy)

ListClustersResponse
listProjectsLocationsPrivateCloudsClusters(string $parent, array $optParams = [])

Lists Cluster resources in a given private cloud.

Operation
patch(string $name, Cluster $postBody, array $optParams = [])

Modifies a Cluster resource. Only fields specified in updateMask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes. (clusters.patch)

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. (clusters.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 66
Operation create(string $parent, Cluster $postBody, array $optParams = [])

Creates a new cluster in a given private cloud. Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient node quota.

(clusters.create)

Parameters

string $parent

Required. The resource name of the private cloud to create a new cluster in. 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
Cluster $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 91
Operation delete(string $name, array $optParams = [])

Deletes a Cluster resource. To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion.

You cannot delete the management cluster of a private cloud using this method. (clusters.delete)

Parameters

string $name

Required. The resource name of the cluster to delete. 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/clusters/my-cluster
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 109
Cluster get(string $name, array $optParams = [])

Retrieves a Cluster resource by its resource name. (clusters.get)

Parameters

string $name

Required. The cluster resource name 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-a/privateClouds/my- cloud/clusters/my-cluster
array $optParams

Optional parameters.

Return Value

Cluster

Exceptions

Exception

at line 140
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. (clusters.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 176
ListClustersResponse listProjectsLocationsPrivateCloudsClusters(string $parent, array $optParams = [])

Lists Cluster resources in a given private cloud.

(clusters.listProjectsLocationsPrivateCloudsClusters)

Parameters

string $parent

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

Optional parameters.

Return Value

ListClustersResponse

Exceptions

Exception

at line 210
Operation patch(string $name, Cluster $postBody, array $optParams = [])

Modifies a Cluster resource. Only fields specified in updateMask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes. (clusters.patch)

Parameters

string $name

Output only. The resource name of this cluster. 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/clusters/my-cluster
Cluster $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 230
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. (clusters.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 252
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. (clusters.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