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

ProjectsLocationsBareMetalClustersBareMetalNodePools

class ProjectsLocationsBareMetalClustersBareMetalNodePools extends Resource (View source)

The "bareMetalNodePools" collection of methods.

Typical usage is:

 $gkeonpremService = new Google\Service\GKEOnPrem(...);
 $bareMetalNodePools = $gkeonpremService->projects_locations_bareMetalClusters_bareMetalNodePools;

Methods

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

Creates a new bare metal node pool in a given project, location and Bare Metal cluster. (bareMetalNodePools.create)

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

Deletes a single bare metal node pool. (bareMetalNodePools.delete)

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

Enrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created. (bareMetalNodePools.enroll)

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

Gets details of a single bare metal node pool. (bareMetalNodePools.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.

ListBareMetalNodePoolsResponse
listProjectsLocationsBareMetalClustersBareMetalNodePools(string $parent, array $optParams = [])

Lists bare metal node pools in a given project, location and bare metal cluster.

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

Updates the parameters of a single bare metal node pool.

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. (bareMetalNodePools.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 bare metal node pool from Anthos On-Prem API.

Details

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

Creates a new bare metal node pool in a given project, location and Bare Metal cluster. (bareMetalNodePools.create)

Parameters

string $parent

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a single bare metal node pool. (bareMetalNodePools.delete)

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Enrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created. (bareMetalNodePools.enroll)

Parameters

string $parent

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 131
BareMetalNodePool get(string $name, array $optParams = [])

Gets details of a single bare metal node pool. (bareMetalNodePools.get)

Parameters

string $name

Required. The name of the node pool to retrieve. projects /{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePool s/{nodepool}
array $optParams

Optional parameters.

Return Value

BareMetalNodePool

Exceptions

Exception

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

(bareMetalNodePools.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 194
ListBareMetalNodePoolsResponse listProjectsLocationsBareMetalClustersBareMetalNodePools(string $parent, array $optParams = [])

Lists bare metal node pools in a given project, location and bare metal cluster.

(bareMetalNodePools.listProjectsLocationsBareMetalClustersBareMetalNodePools)

Parameters

string $parent

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

Optional parameters.

Return Value

ListBareMetalNodePoolsResponse

Exceptions

Exception

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

Updates the parameters of a single bare metal node pool.

(bareMetalNodePools.patch)

Parameters

string $name

Immutable. The bare metal node pool resource name.
BareMetalNodePool $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 244
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. (bareMetalNodePools.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 267
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. (bareMetalNodePools.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 293
Operation unenroll(string $name, array $optParams = [])

Unenrolls a bare metal node pool from Anthos On-Prem API.

(bareMetalNodePools.unenroll)

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception