ProjectsRegionsClusters
class ProjectsRegionsClusters extends Resource (View source)
The "clusters" collection of methods.
Typical usage is:
$dataprocService = new Google\Service\Dataproc(...);
$clusters = $dataprocService->projects_regions_clusters;Methods
Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rp c/google.cloud.dataproc.v1#clusteroperationmetadata). (clusters.create)
Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rp c/google.cloud.dataproc.v1#clusteroperationmetadata). (clusters.delete)
Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rp c/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud.
Gets the resource representation for a cluster in a project. (clusters.get)
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)
Inject encrypted credentials into all of the VMs in a cluster.The target cluster must be a personal auth cluster assigned to the user who is issuing the RPC. (clusters.injectCredentials)
Lists all regions/{region}/clusters in a project alphabetically.
Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rp c/google.cloud.dataproc.v1#clusteroperationmetadata). The cluster must be in a RUNNING state or an error is returned. (clusters.patch)
Repairs a cluster. (clusters.repair)
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)
Starts a cluster in a project. (clusters.start)
Stops a cluster in a project. (clusters.stop)
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
Operation
create(string $projectId, string $region, Cluster $postBody, array $optParams = [])
Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rp c/google.cloud.dataproc.v1#clusteroperationmetadata). (clusters.create)
Operation
delete(string $projectId, string $region, string $clusterName, array $optParams = [])
Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rp c/google.cloud.dataproc.v1#clusteroperationmetadata). (clusters.delete)
Operation
diagnose(string $projectId, string $region, string $clusterName, DiagnoseClusterRequest $postBody, array $optParams = [])
Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rp c/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud.
google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclust erresults). (clusters.diagnose)
Cluster
get(string $projectId, string $region, string $clusterName, array $optParams = [])
Gets the resource representation for a cluster in a project. (clusters.get)
Policy
getIamPolicy(string $resource, GetIamPolicyRequest $postBody, 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)
Operation
injectCredentials(string $project, string $region, string $cluster, InjectCredentialsRequest $postBody, array $optParams = [])
Inject encrypted credentials into all of the VMs in a cluster.The target cluster must be a personal auth cluster assigned to the user who is issuing the RPC. (clusters.injectCredentials)
ListClustersResponse
listProjectsRegionsClusters(string $projectId, string $region, array $optParams = [])
Lists all regions/{region}/clusters in a project alphabetically.
(clusters.listProjectsRegionsClusters)
Operation
patch(string $projectId, string $region, string $clusterName, Cluster $postBody, array $optParams = [])
Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rp c/google.cloud.dataproc.v1#clusteroperationmetadata). The cluster must be in a RUNNING state or an error is returned. (clusters.patch)
Operation
repair(string $projectId, string $region, string $clusterName, RepairClusterRequest $postBody, array $optParams = [])
Repairs a cluster. (clusters.repair)
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)
Operation
start(string $projectId, string $region, string $clusterName, StartClusterRequest $postBody, array $optParams = [])
Starts a cluster in a project. (clusters.start)
Operation
stop(string $projectId, string $region, string $clusterName, StopClusterRequest $postBody, array $optParams = [])
Stops a cluster in a project. (clusters.stop)
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)