Class DiagnoseClusterRequest (4.38.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
TypeDescription
int

DIAGNOSIS_INTERVAL_FIELD_NUMBER

public static final int DIAGNOSIS_INTERVAL_FIELD_NUMBER
Field Value
TypeDescription
int

JOBS_FIELD_NUMBER

public static final int JOBS_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
TypeDescription
int

TARBALL_GCS_DIR_FIELD_NUMBER

public static final int TARBALL_GCS_DIR_FIELD_NUMBER
Field Value
TypeDescription
int

YARN_APPLICATION_IDS_FIELD_NUMBER

public static final int YARN_APPLICATION_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DiagnoseClusterRequest getDefaultInstance()
Returns
TypeDescription
DiagnoseClusterRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DiagnoseClusterRequest.Builder newBuilder()
Returns
TypeDescription
DiagnoseClusterRequest.Builder

newBuilder(DiagnoseClusterRequest prototype)

public static DiagnoseClusterRequest.Builder newBuilder(DiagnoseClusterRequest prototype)
Parameter
NameDescription
prototypeDiagnoseClusterRequest
Returns
TypeDescription
DiagnoseClusterRequest.Builder

parseDelimitedFrom(InputStream input)

public static DiagnoseClusterRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DiagnoseClusterRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DiagnoseClusterRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DiagnoseClusterRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DiagnoseClusterRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DiagnoseClusterRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DiagnoseClusterRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DiagnoseClusterRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DiagnoseClusterRequest> parser()
Returns
TypeDescription
Parser<DiagnoseClusterRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getClusterName()

public String getClusterName()

Required. The cluster name.

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

Returns
TypeDescription
String

The clusterName.

getClusterNameBytes()

public ByteString getClusterNameBytes()

Required. The cluster name.

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

Returns
TypeDescription
ByteString

The bytes for clusterName.

getDefaultInstanceForType()

public DiagnoseClusterRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the jobs.

getParserForType()

public Parser<DiagnoseClusterRequest> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for region.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTarballGcsDir()

public String 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.

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

Returns
TypeDescription
String

The tarballGcsDir.

getTarballGcsDirBytes()

public ByteString getTarballGcsDirBytes()

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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the diagnosisInterval field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DiagnoseClusterRequest.Builder newBuilderForType()
Returns
TypeDescription
DiagnoseClusterRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DiagnoseClusterRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DiagnoseClusterRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DiagnoseClusterRequest.Builder toBuilder()
Returns
TypeDescription
DiagnoseClusterRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException