Class DataprocMetricConfig.Metric (4.50.0)

public static final class DataprocMetricConfig.Metric extends GeneratedMessageV3 implements DataprocMetricConfig.MetricOrBuilder

A Dataproc custom metric.

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

Inheritance

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

Implements

DataprocMetricConfig.MetricOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

METRIC_OVERRIDES_FIELD_NUMBER

public static final int METRIC_OVERRIDES_FIELD_NUMBER

Field Value
Type	Description
`int`

METRIC_SOURCE_FIELD_NUMBER

public static final int METRIC_SOURCE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static DataprocMetricConfig.Metric getDefaultInstance()

Returns
Type	Description
`DataprocMetricConfig.Metric`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static DataprocMetricConfig.Metric.Builder newBuilder()

Returns
Type	Description
`DataprocMetricConfig.Metric.Builder`

newBuilder(DataprocMetricConfig.Metric prototype)

public static DataprocMetricConfig.Metric.Builder newBuilder(DataprocMetricConfig.Metric prototype)

Parameter
Name	Description
`prototype`	`DataprocMetricConfig.Metric`

Returns
Type	Description
`DataprocMetricConfig.Metric.Builder`

parseDelimitedFrom(InputStream input)

public static DataprocMetricConfig.Metric parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataprocMetricConfig.Metric parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static DataprocMetricConfig.Metric parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataprocMetricConfig.Metric parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static DataprocMetricConfig.Metric parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataprocMetricConfig.Metric parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static DataprocMetricConfig.Metric parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataprocMetricConfig.Metric parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static DataprocMetricConfig.Metric parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataprocMetricConfig.Metric parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static DataprocMetricConfig.Metric parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataprocMetricConfig.Metric parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DataprocMetricConfig.Metric`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<DataprocMetricConfig.Metric> parser()

Returns
Type	Description
`Parser<Metric>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public DataprocMetricConfig.Metric getDefaultInstanceForType()

Returns
Type	Description
`DataprocMetricConfig.Metric`

getMetricOverrides(int index)

public String getMetricOverrides(int index)

Optional. Specify one or more Custom 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.used

Notes:



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

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics are not
collected. The collection of the metrics for other enabled custom
metric sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all YARN metrics are 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)

Optional. Specify one or more Custom 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.used

Notes:



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

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics are not
collected. The collection of the metrics for other enabled custom
metric sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all YARN metrics are 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()

Optional. Specify one or more Custom 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.used

Notes:



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

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics are not
collected. The collection of the metrics for other enabled custom
metric sources is unaffected. For example, if both

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

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

Returns
Type	Description
`int`	The count of metricOverrides.

getMetricOverridesList()

public ProtocolStringList getMetricOverridesList()

Optional. Specify one or more Custom 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.used

Notes:



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

spark:executive

 metrics
are listed as metric overrides, other

SPARK

 metrics are not
collected. The collection of the metrics for other enabled custom
metric sources is unaffected. For example, if both

SPARK andd YARN` metric sources are enabled, and overrides are provided for Spark metrics only, all YARN metrics are 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. A standard set of metrics is collected unless metricOverrides are specified for the metric source (see Custom 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. A standard set of metrics is collected unless metricOverrides are specified for the metric source (see Custom 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.

getParserForType()

public Parser<DataprocMetricConfig.Metric> getParserForType()

Returns
Type	Description
`Parser<Metric>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public DataprocMetricConfig.Metric.Builder newBuilderForType()

Returns
Type	Description
`DataprocMetricConfig.Metric.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataprocMetricConfig.Metric.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`DataprocMetricConfig.Metric.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public DataprocMetricConfig.Metric.Builder toBuilder()

Returns
Type	Description
`DataprocMetricConfig.Metric.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`