Class DataprocMetricConfig.Metric.Builder (4.2.0)

public static final class DataprocMetricConfig.Metric.Builder extends GeneratedMessageV3.Builder<DataprocMetricConfig.Metric.Builder> implements DataprocMetricConfig.MetricOrBuilder

A Dataproc OSS metric.

Protobuf type google.cloud.dataproc.v1.DataprocMetricConfig.Metric

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DataprocMetricConfig.Metric.Builder

Implements

DataprocMetricConfig.MetricOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllMetricOverrides(Iterable<String> values)

public DataprocMetricConfig.Metric.Builder addAllMetricOverrides(Iterable<String> values)

Optional. Specify one or more available OSS metrics to collect for the metric course (for the SPARK metric source, any Spark metric can be specified). Provide metrics in the following format: <code><var>METRIC_SOURCE</var>:<var>INSTANCE</var>:<var>GROUP</var>:<var>METRIC</var></code> Use camelcase as appropriate. Examples: `yarn:ResourceManager:QueueMetrics:AppsCompleted spark:driver:DAGScheduler:job.allJobs sparkHistoryServer:JVM:Memory:NonHeapMemoryUsage.committed hiveserver2:JVM:Memory:NonHeapMemoryUsage.usedNotes:


Only the specified overridden metrics will be collected for the
metric source. For example, if one or more

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics will not be
collected. The collection of the default metrics for other OSS metric
sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
values	`Iterable<String>` The metricOverrides to add.

Returns

Type	Description
DataprocMetricConfig.Metric.Builder	This builder for chaining.

addMetricOverrides(String value)

public DataprocMetricConfig.Metric.Builder addMetricOverrides(String value)


Only the specified overridden metrics will be collected for the
metric source. For example, if one or more

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics will not be
collected. The collection of the default metrics for other OSS metric
sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`String` The metricOverrides to add.

Returns

Type	Description
DataprocMetricConfig.Metric.Builder	This builder for chaining.

addMetricOverridesBytes(ByteString value)

public DataprocMetricConfig.Metric.Builder addMetricOverridesBytes(ByteString value)


Only the specified overridden metrics will be collected for the
metric source. For example, if one or more

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics will not be
collected. The collection of the default metrics for other OSS metric
sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`ByteString` The bytes of the metricOverrides to add.

Returns

Type	Description
DataprocMetricConfig.Metric.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataprocMetricConfig.Metric.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DataprocMetricConfig.Metric build()

Returns

Type	Description
DataprocMetricConfig.Metric

buildPartial()

public DataprocMetricConfig.Metric buildPartial()

Returns

Type	Description
DataprocMetricConfig.Metric

clear()

public DataprocMetricConfig.Metric.Builder clear()

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public DataprocMetricConfig.Metric.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMetricOverrides()

public DataprocMetricConfig.Metric.Builder clearMetricOverrides()


Only the specified overridden metrics will be collected for the
metric source. For example, if one or more

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics will not be
collected. The collection of the default metrics for other OSS metric
sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
DataprocMetricConfig.Metric.Builder	This builder for chaining.

clearMetricSource()

public DataprocMetricConfig.Metric.Builder clearMetricSource()

Required. Default metrics are collected unless metricOverrides are specified for the metric source (see Available OSS metrics for more information).

.google.cloud.dataproc.v1.DataprocMetricConfig.MetricSource metric_source = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
DataprocMetricConfig.Metric.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DataprocMetricConfig.Metric.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public DataprocMetricConfig.Metric.Builder clone()

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public DataprocMetricConfig.Metric getDefaultInstanceForType()

Returns

Type	Description
DataprocMetricConfig.Metric

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMetricOverrides(int index)

public String getMetricOverrides(int index)


Only the specified overridden metrics will be collected for the
metric source. For example, if one or more

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics will not be
collected. The collection of the default metrics for other OSS metric
sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The metricOverrides at the given index.

getMetricOverridesBytes(int index)

public ByteString getMetricOverridesBytes(int index)


Only the specified overridden metrics will be collected for the
metric source. For example, if one or more

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics will not be
collected. The collection of the default metrics for other OSS metric
sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected.

repeated string metric_overrides = 2 [(.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 metricOverrides at the given index.

getMetricOverridesCount()

public int getMetricOverridesCount()


Only the specified overridden metrics will be collected for the
metric source. For example, if one or more

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics will not be
collected. The collection of the default metrics for other OSS metric
sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int	The count of metricOverrides.

getMetricOverridesList()

public ProtocolStringList getMetricOverridesList()


Only the specified overridden metrics will be collected for the
metric source. For example, if one or more

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics will not be
collected. The collection of the default metrics for other OSS metric
sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ProtocolStringList	A list containing the metricOverrides.

getMetricSource()

public DataprocMetricConfig.MetricSource getMetricSource()

Required. Default metrics are collected unless metricOverrides are specified for the metric source (see Available OSS metrics for more information).

.google.cloud.dataproc.v1.DataprocMetricConfig.MetricSource metric_source = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
DataprocMetricConfig.MetricSource	The metricSource.

getMetricSourceValue()

public int getMetricSourceValue()

Required. Default metrics are collected unless metricOverrides are specified for the metric source (see Available OSS metrics for more information).

.google.cloud.dataproc.v1.DataprocMetricConfig.MetricSource metric_source = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
int	The enum numeric value on the wire for metricSource.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(DataprocMetricConfig.Metric other)

public DataprocMetricConfig.Metric.Builder mergeFrom(DataprocMetricConfig.Metric other)

Parameter

Name	Description
other	`DataprocMetricConfig.Metric`

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataprocMetricConfig.Metric.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public DataprocMetricConfig.Metric.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataprocMetricConfig.Metric.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public DataprocMetricConfig.Metric.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMetricOverrides(int index, String value)

public DataprocMetricConfig.Metric.Builder setMetricOverrides(int index, String value)


Only the specified overridden metrics will be collected for the
metric source. For example, if one or more

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics will not be
collected. The collection of the default metrics for other OSS metric
sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected.

repeated string metric_overrides = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The metricOverrides to set.

Returns

Type	Description
DataprocMetricConfig.Metric.Builder	This builder for chaining.

setMetricSource(DataprocMetricConfig.MetricSource value)

public DataprocMetricConfig.Metric.Builder setMetricSource(DataprocMetricConfig.MetricSource value)

Required. Default metrics are collected unless metricOverrides are specified for the metric source (see Available OSS metrics for more information).

.google.cloud.dataproc.v1.DataprocMetricConfig.MetricSource metric_source = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`DataprocMetricConfig.MetricSource` The metricSource to set.

Returns

Type	Description
DataprocMetricConfig.Metric.Builder	This builder for chaining.

setMetricSourceValue(int value)

public DataprocMetricConfig.Metric.Builder setMetricSourceValue(int value)

Required. Default metrics are collected unless metricOverrides are specified for the metric source (see Available OSS metrics for more information).

.google.cloud.dataproc.v1.DataprocMetricConfig.MetricSource metric_source = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`int` The enum numeric value on the wire for metricSource to set.

Returns

Type	Description
DataprocMetricConfig.Metric.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DataprocMetricConfig.Metric.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final DataprocMetricConfig.Metric.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
DataprocMetricConfig.Metric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)