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

ProjectsLocationsVmwareClustersVmwareNodePools

class ProjectsLocationsVmwareClustersVmwareNodePools extends Resource (View source)

The "vmwareNodePools" collection of methods.

Typical usage is:

 $gkeonpremService = new Google\Service\GKEOnPrem(...);
 $vmwareNodePools = $gkeonpremService->projects_locations_vmwareClusters_vmwareNodePools;

Methods

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

Creates a new VMware node pool in a given project, location and VMWare cluster. (vmwareNodePools.create)

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

Deletes a single VMware node pool. (vmwareNodePools.delete)

Operation
enroll(string $parent, EnrollVmwareNodePoolRequest $postBody, array $optParams = [])

Enrolls a VMware node pool to Anthos On-Prem API (vmwareNodePools.enroll)

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

Gets details of a single VMware node pool. (vmwareNodePools.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.

ListVmwareNodePoolsResponse
listProjectsLocationsVmwareClustersVmwareNodePools(string $parent, array $optParams = [])

Lists VMware node pools in a given project, location and VMWare cluster.

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

Updates the parameters of a single VMware node pool. (vmwareNodePools.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. (vmwareNodePools.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.

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

Unenrolls a VMware node pool to Anthos On-Prem API (vmwareNodePools.unenroll)

Details

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

Creates a new VMware node pool in a given project, location and VMWare cluster. (vmwareNodePools.create)

Parameters

string $parent

Required. The parent resource where this node pool will be created. projects/{project}/locations/{location}/vmwareClusters/{cluster}
VmwareNodePool $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a single VMware node pool. (vmwareNodePools.delete)

Parameters

string $name

Required. The name of the node pool to delete. Format: pr ojects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePool s/{nodepool}
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 106
Operation enroll(string $parent, EnrollVmwareNodePoolRequest $postBody, array $optParams = [])

Enrolls a VMware node pool to Anthos On-Prem API (vmwareNodePools.enroll)

Parameters

string $parent

Required. The parent resource where the node pool is enrolled in.
EnrollVmwareNodePoolRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 127
VmwareNodePool get(string $name, array $optParams = [])

Gets details of a single VMware node pool. (vmwareNodePools.get)

Parameters

string $name

Required. The name of the node pool to retrieve. projects /{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePools/{nod epool}
array $optParams

Optional parameters.

Return Value

VmwareNodePool

Exceptions

Exception

at line 159
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.

(vmwareNodePools.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 189
ListVmwareNodePoolsResponse listProjectsLocationsVmwareClustersVmwareNodePools(string $parent, array $optParams = [])

Lists VMware node pools in a given project, location and VMWare cluster.

(vmwareNodePools.listProjectsLocationsVmwareClustersVmwareNodePools)

Parameters

string $parent

Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/vmwareClusters/{vmwareCluster}
array $optParams

Optional parameters.

Return Value

ListVmwareNodePoolsResponse

Exceptions

Exception

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

Updates the parameters of a single VMware node pool. (vmwareNodePools.patch)

Parameters

string $name

Immutable. The resource name of this node pool.
VmwareNodePool $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 234
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. (vmwareNodePools.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 257
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. (vmwareNodePools.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

at line 282
Operation unenroll(string $name, array $optParams = [])

Unenrolls a VMware node pool to Anthos On-Prem API (vmwareNodePools.unenroll)

Parameters

string $name

Required. The name of the node pool to unenroll. Format: projects/{project}/locations/{location}/vmwareClusters/{cluster}/vmwareNodePo ols/{nodepool}
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception