Google Cloud Dataproc V1 Client - Class DiagnoseClusterRequest (3.13.3)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class DiagnoseClusterRequest.

A request to collect cluster diagnostic information.

Generated from protobuf message google.cloud.dataproc.v1.DiagnoseClusterRequest

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ project_id 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.

↳ cluster_name string

Required. The cluster name.

↳ tarball_gcs_dir string

Optional. The output Cloud Storage directory for the diagnostic tarball. If not specified, a task-specific directory in the cluster's staging bucket will be used.

↳ diagnosis_interval Google\Type\Interval

Optional. Time interval in which diagnosis should be carried out on the cluster.

↳ jobs array

Optional. Specifies a list of jobs on which diagnosis is to be performed. Format: projects/{project}/regions/{region}/jobs/{job}

↳ yarn_application_ids array

Optional. Specifies a list of yarn applications on which diagnosis is to be performed.

getProjectId

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

Returns
Type Description
string

setProjectId

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

Parameter
Name Description
var string
Returns
Type Description
$this

getRegion

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

Returns
Type Description
string

setRegion

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

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterName

Required. The cluster name.

Returns
Type Description
string

setClusterName

Required. The cluster name.

Parameter
Name Description
var string
Returns
Type Description
$this

getTarballGcsDir

Optional. The output Cloud Storage directory for the diagnostic tarball. If not specified, a task-specific directory in the cluster's staging bucket will be used.

Returns
Type Description
string

setTarballGcsDir

Optional. The output Cloud Storage directory for the diagnostic tarball. If not specified, a task-specific directory in the cluster's staging bucket will be used.

Parameter
Name Description
var string
Returns
Type Description
$this

getDiagnosisInterval

Optional. Time interval in which diagnosis should be carried out on the cluster.

Returns
Type Description
Google\Type\Interval|null

hasDiagnosisInterval

clearDiagnosisInterval

setDiagnosisInterval

Optional. Time interval in which diagnosis should be carried out on the cluster.

Parameter
Name Description
var Google\Type\Interval
Returns
Type Description
$this

getJobs

Optional. Specifies a list of jobs on which diagnosis is to be performed.

Format: projects/{project}/regions/{region}/jobs/{job}

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setJobs

Optional. Specifies a list of jobs on which diagnosis is to be performed.

Format: projects/{project}/regions/{region}/jobs/{job}

Parameter
Name Description
var string[]
Returns
Type Description
$this

getYarnApplicationIds

Optional. Specifies a list of yarn applications on which diagnosis is to be performed.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setYarnApplicationIds

Optional. Specifies a list of yarn applications on which diagnosis is to be performed.

Parameter
Name Description
var string[]
Returns
Type Description
$this

static::build

Parameters
Name Description
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.

Returns
Type Description
Google\Cloud\Dataproc\V1\DiagnoseClusterRequest