Reference documentation and code samples for the Google Cloud Dataproc V1 Client class DiagnoseClusterRequest.
A request to collect cluster diagnostic information.
Generated from protobuf messagegoogle.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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataproc V1 Client - Class DiagnoseClusterRequest (3.14.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.14.0 (latest)](/php/docs/reference/cloud-dataproc/latest/V1.DiagnoseClusterRequest)\n- [3.13.4](/php/docs/reference/cloud-dataproc/3.13.4/V1.DiagnoseClusterRequest)\n- [3.12.0](/php/docs/reference/cloud-dataproc/3.12.0/V1.DiagnoseClusterRequest)\n- [3.11.0](/php/docs/reference/cloud-dataproc/3.11.0/V1.DiagnoseClusterRequest)\n- [3.10.1](/php/docs/reference/cloud-dataproc/3.10.1/V1.DiagnoseClusterRequest)\n- [3.9.0](/php/docs/reference/cloud-dataproc/3.9.0/V1.DiagnoseClusterRequest)\n- [3.8.1](/php/docs/reference/cloud-dataproc/3.8.1/V1.DiagnoseClusterRequest)\n- [3.7.1](/php/docs/reference/cloud-dataproc/3.7.1/V1.DiagnoseClusterRequest)\n- [3.6.1](/php/docs/reference/cloud-dataproc/3.6.1/V1.DiagnoseClusterRequest)\n- [3.5.1](/php/docs/reference/cloud-dataproc/3.5.1/V1.DiagnoseClusterRequest)\n- [3.4.0](/php/docs/reference/cloud-dataproc/3.4.0/V1.DiagnoseClusterRequest)\n- [3.3.0](/php/docs/reference/cloud-dataproc/3.3.0/V1.DiagnoseClusterRequest)\n- [3.2.2](/php/docs/reference/cloud-dataproc/3.2.2/V1.DiagnoseClusterRequest)\n- [2.6.1](/php/docs/reference/cloud-dataproc/2.6.1/V1.DiagnoseClusterRequest)\n- [2.5.0](/php/docs/reference/cloud-dataproc/2.5.0/V1.DiagnoseClusterRequest)\n- [2.3.0](/php/docs/reference/cloud-dataproc/2.3.0/V1.DiagnoseClusterRequest)\n- [2.2.3](/php/docs/reference/cloud-dataproc/2.2.3/V1.DiagnoseClusterRequest)\n- [2.1.0](/php/docs/reference/cloud-dataproc/2.1.0/V1.DiagnoseClusterRequest)\n- [2.0.0](/php/docs/reference/cloud-dataproc/2.0.0/V1.DiagnoseClusterRequest) \nReference documentation and code samples for the Google Cloud Dataproc V1 Client class DiagnoseClusterRequest.\n\nA request to collect cluster diagnostic information.\n\nGenerated from protobuf message `google.cloud.dataproc.v1.DiagnoseClusterRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataproc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getProjectId\n\nRequired. The ID of the Google Cloud Platform project that the cluster\nbelongs to.\n\n### setProjectId\n\nRequired. The ID of the Google Cloud Platform project that the cluster\nbelongs to.\n\n### getRegion\n\nRequired. The Dataproc region in which to handle the request.\n\n### setRegion\n\nRequired. The Dataproc region in which to handle the request.\n\n### getClusterName\n\nRequired. The cluster name.\n\n### setClusterName\n\nRequired. The cluster name.\n\n### getTarballGcsDir\n\nOptional. The output Cloud Storage directory for the diagnostic\ntarball. If not specified, a task-specific directory in the cluster's\nstaging bucket will be used.\n\n### setTarballGcsDir\n\nOptional. The output Cloud Storage directory for the diagnostic\ntarball. If not specified, a task-specific directory in the cluster's\nstaging bucket will be used.\n\n### getDiagnosisInterval\n\nOptional. Time interval in which diagnosis should be carried out on the\ncluster.\n\n### hasDiagnosisInterval\n\n### clearDiagnosisInterval\n\n### setDiagnosisInterval\n\nOptional. Time interval in which diagnosis should be carried out on the\ncluster.\n\n### getJobs\n\nOptional. Specifies a list of jobs on which diagnosis is to be performed.\n\nFormat: projects/{project}/regions/{region}/jobs/{job}\n\n### setJobs\n\nOptional. Specifies a list of jobs on which diagnosis is to be performed.\n\nFormat: projects/{project}/regions/{region}/jobs/{job}\n\n### getYarnApplicationIds\n\nOptional. Specifies a list of yarn applications on which diagnosis is to be\nperformed.\n\n### setYarnApplicationIds\n\nOptional. Specifies a list of yarn applications on which diagnosis is to be\nperformed.\n\n### static::build"]]
