Class DiagnoseClusterRequest (4.48.0)

public final class DiagnoseClusterRequest extends GeneratedMessageV3 implements DiagnoseClusterRequestOrBuilder

A request to collect cluster diagnostic information.

Protobuf type google.cloud.dataproc.v1.DiagnoseClusterRequest

Static Fields

CLUSTER_NAME_FIELD_NUMBER

public static final int CLUSTER_NAME_FIELD_NUMBER
Field Value
Type Description
int

DIAGNOSIS_INTERVAL_FIELD_NUMBER

public static final int DIAGNOSIS_INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

JOBS_FIELD_NUMBER

public static final int JOBS_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
Type Description
int

TARBALL_ACCESS_FIELD_NUMBER

public static final int TARBALL_ACCESS_FIELD_NUMBER
Field Value
Type Description
int

TARBALL_GCS_DIR_FIELD_NUMBER

public static final int TARBALL_GCS_DIR_FIELD_NUMBER
Field Value
Type Description
int

YARN_APPLICATION_IDS_FIELD_NUMBER

public static final int YARN_APPLICATION_IDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DiagnoseClusterRequest getDefaultInstance()
Returns
Type Description
DiagnoseClusterRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DiagnoseClusterRequest.Builder newBuilder()
Returns
Type Description
DiagnoseClusterRequest.Builder

newBuilder(DiagnoseClusterRequest prototype)

public static DiagnoseClusterRequest.Builder newBuilder(DiagnoseClusterRequest prototype)
Parameter
Name Description
prototype DiagnoseClusterRequest
Returns
Type Description
DiagnoseClusterRequest.Builder

parseDelimitedFrom(InputStream input)

public static DiagnoseClusterRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DiagnoseClusterRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DiagnoseClusterRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DiagnoseClusterRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DiagnoseClusterRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DiagnoseClusterRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiagnoseClusterRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DiagnoseClusterRequest> parser()
Returns
Type Description
Parser<DiagnoseClusterRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getClusterName()

public String getClusterName()

Required. The cluster name.

string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The clusterName.

getClusterNameBytes()

public ByteString getClusterNameBytes()

Required. The cluster name.

string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for clusterName.

getDefaultInstanceForType()

public DiagnoseClusterRequest getDefaultInstanceForType()
Returns
Type Description
DiagnoseClusterRequest

getDiagnosisInterval()

public Interval getDiagnosisInterval()

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

.google.type.Interval diagnosis_interval = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Interval

The diagnosisInterval.

getDiagnosisIntervalOrBuilder()

public IntervalOrBuilder getDiagnosisIntervalOrBuilder()

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

.google.type.Interval diagnosis_interval = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.IntervalOrBuilder

getJobs(int index)

public String getJobs(int index)

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

repeated string jobs = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The jobs at the given index.

getJobsBytes(int index)

public ByteString getJobsBytes(int index)

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

repeated string jobs = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the jobs at the given index.

getJobsCount()

public int getJobsCount()

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

repeated string jobs = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of jobs.

getJobsList()

public ProtocolStringList getJobsList()

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

repeated string jobs = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the jobs.

getParserForType()

public Parser<DiagnoseClusterRequest> getParserForType()
Returns
Type Description
Parser<DiagnoseClusterRequest>
Overrides

getProjectId()

public String getProjectId()

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for projectId.

getRegion()

public String getRegion()

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

string region = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

string region = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for region.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTarballAccess()

public DiagnoseClusterRequest.TarballAccess getTarballAccess()

Optional. (Optional) The access type to the diagnostic tarball. If not specified, falls back to default access of the bucket

.google.cloud.dataproc.v1.DiagnoseClusterRequest.TarballAccess tarball_access = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DiagnoseClusterRequest.TarballAccess

The tarballAccess.

getTarballAccessValue()

public int getTarballAccessValue()

Optional. (Optional) The access type to the diagnostic tarball. If not specified, falls back to default access of the bucket

.google.cloud.dataproc.v1.DiagnoseClusterRequest.TarballAccess tarball_access = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for tarballAccess.

getTarballGcsDir()

public String getTarballGcsDir()

Optional. (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.

string tarball_gcs_dir = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The tarballGcsDir.

getTarballGcsDirBytes()

public ByteString getTarballGcsDirBytes()

Optional. (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.

string tarball_gcs_dir = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for tarballGcsDir.

getYarnApplicationIds(int index)

public String getYarnApplicationIds(int index)

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

repeated string yarn_application_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The yarnApplicationIds at the given index.

getYarnApplicationIdsBytes(int index)

public ByteString getYarnApplicationIdsBytes(int index)

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

repeated string yarn_application_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the yarnApplicationIds at the given index.

getYarnApplicationIdsCount()

public int getYarnApplicationIdsCount()

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

repeated string yarn_application_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of yarnApplicationIds.

getYarnApplicationIdsList()

public ProtocolStringList getYarnApplicationIdsList()

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

repeated string yarn_application_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the yarnApplicationIds.

hasDiagnosisInterval()

public boolean hasDiagnosisInterval()

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

.google.type.Interval diagnosis_interval = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the diagnosisInterval field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DiagnoseClusterRequest.Builder newBuilderForType()
Returns
Type Description
DiagnoseClusterRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DiagnoseClusterRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DiagnoseClusterRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DiagnoseClusterRequest.Builder toBuilder()
Returns
Type Description
DiagnoseClusterRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException