Documentation

Google_Service_Dataproc_Resource_ProjectsRegionsClusters extends Google_Service_Resource
in package

The "clusters" collection of methods.

Typical usage is: $dataprocService = new Google_Service_Dataproc(...); $clusters = $dataprocService->clusters;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Dataproc_Operation
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)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Dataproc_Operation
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)
diagnose()  : Google_Service_Dataproc_Operation
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.
get()  : Google_Service_Dataproc_Cluster
Gets the resource representation for a cluster in a project. (clusters.get)
getIamPolicy()  : Google_Service_Dataproc_Policy
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)
listProjectsRegionsClusters()  : Google_Service_Dataproc_ListClustersResponse
Lists all regions/{region}/clusters in a project alphabetically.
patch()  : Google_Service_Dataproc_Operation
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). (clusters.patch)
setIamPolicy()  : Google_Service_Dataproc_Policy
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)
testIamPermissions()  : Google_Service_Dataproc_TestIamPermissionsResponse
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.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

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)

public create(string $projectId, string $region, Google_Service_Dataproc_Cluster $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Operation
Parameters
$projectId : string

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

$region : string

Required. The Dataproc region in which to handle the request.

$postBody : Google_Service_Dataproc_Cluster
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Return values
Google_Service_Dataproc_Operation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

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)

public delete(string $projectId, string $region, string $clusterName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Operation
Parameters
$projectId : string

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

$region : string

Required. The Dataproc region in which to handle the request.

$clusterName : string

Required. The cluster name.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string clusterUuid Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.

opt_param

string requestId Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Return values
Google_Service_Dataproc_Operation —

diagnose()

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.

public diagnose(string $projectId, string $region, string $clusterName, Google_Service_Dataproc_DiagnoseClusterRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Operation

google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclust erresults). (clusters.diagnose)

Parameters
$projectId : string

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

$region : string

Required. The Dataproc region in which to handle the request.

$clusterName : string

Required. The cluster name.

$postBody : Google_Service_Dataproc_DiagnoseClusterRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dataproc_Operation —

get()

Gets the resource representation for a cluster in a project. (clusters.get)

public get(string $projectId, string $region, string $clusterName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Cluster
Parameters
$projectId : string

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

$region : string

Required. The Dataproc region in which to handle the request.

$clusterName : string

Required. The cluster name.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dataproc_Cluster —

getIamPolicy()

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)

public getIamPolicy(string $resource, Google_Service_Dataproc_GetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_Dataproc_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dataproc_Policy —

listProjectsRegionsClusters()

Lists all regions/{region}/clusters in a project alphabetically.

public listProjectsRegionsClusters(string $projectId, string $region[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_ListClustersResponse

(clusters.listProjectsRegionsClusters)

Parameters
$projectId : string

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

$region : string

Required. The Dataproc region in which to handle the request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken Optional. The standard List page token.

opt_param

string filter Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

opt_param

int pageSize Optional. The standard List page size.

Return values
Google_Service_Dataproc_ListClustersResponse —

patch()

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

public patch(string $projectId, string $region, string $clusterName, Google_Service_Dataproc_Cluster $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Operation
Parameters
$projectId : string

Required. The ID of the Google Cloud Platform project the cluster belongs to.

$region : string

Required. The Dataproc region in which to handle the request.

$clusterName : string

Required. The cluster name.

$postBody : Google_Service_Dataproc_Cluster
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, only the following fields can be updated: Mask Purpose labels Update labels config.worker_config.num_instances Resize primary worker group config.secondary_worker_config.num_instances Resize secondary worker group config.autoscaling_config.policy_uri Use, stop using, or change autoscaling policies

opt_param

string requestId Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

opt_param

string gracefulDecommissionTimeout Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration (https://developers.google.com/protocol- buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.

Return values
Google_Service_Dataproc_Operation —

setIamPolicy()

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)

public setIamPolicy(string $resource, Google_Service_Dataproc_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_Dataproc_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dataproc_Policy —

testIamPermissions()

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.

public testIamPermissions(string $resource, Google_Service_Dataproc_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_TestIamPermissionsResponse

This operation may "fail open" without warning. (clusters.testIamPermissions)

Parameters
$resource : string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_Dataproc_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dataproc_TestIamPermissionsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results