ProjectsLocationsBareMetalClusters
class ProjectsLocationsBareMetalClusters extends Resource (View source)
The "bareMetalClusters" collection of methods.
Typical usage is:
$gkeonpremService = new Google\Service\GKEOnPrem(...);
$bareMetalClusters = $gkeonpremService->projects_locations_bareMetalClusters;Methods
Creates a new bare metal cluster in a given project and location.
Deletes a single bare metal Cluster. (bareMetalClusters.delete)
Enrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.
Gets details of a single bare metal Cluster. (bareMetalClusters.get)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists bare metal clusters in a given project and location.
Updates the parameters of a single bare metal Cluster.
Queries the bare metal user cluster version config.
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and
PERMISSION_DENIED errors. (bareMetalClusters.setIamPolicy)
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.
Unenrolls an existing bare metal user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.
Details
Operation
create(string $parent, BareMetalCluster $postBody, array $optParams = [])
Creates a new bare metal cluster in a given project and location.
(bareMetalClusters.create)
Operation
delete(string $name, array $optParams = [])
Deletes a single bare metal Cluster. (bareMetalClusters.delete)
Operation
enroll(string $parent, EnrollBareMetalClusterRequest $postBody, array $optParams = [])
Enrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.
(bareMetalClusters.enroll)
BareMetalCluster
get(string $name, array $optParams = [])
Gets details of a single bare metal Cluster. (bareMetalClusters.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.
(bareMetalClusters.getIamPolicy)
ListBareMetalClustersResponse
listProjectsLocationsBareMetalClusters(string $parent, array $optParams = [])
Lists bare metal clusters in a given project and location.
(bareMetalClusters.listProjectsLocationsBareMetalClusters)
Operation
patch(string $name, BareMetalCluster $postBody, array $optParams = [])
Updates the parameters of a single bare metal Cluster.
(bareMetalClusters.patch)
QueryBareMetalVersionConfigResponse
queryVersionConfig(string $parent, array $optParams = [])
Queries the bare metal user cluster version config.
(bareMetalClusters.queryVersionConfig)
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. (bareMetalClusters.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.
This operation may "fail open" without warning. (bareMetalClusters.testIamPermissions)
Operation
unenroll(string $name, array $optParams = [])
Unenrolls an existing bare metal user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.
(bareMetalClusters.unenroll)