com.google.cloud.dataproc.v1

Class DataprocMetricConfig.Metric

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dataproc.v1.DataprocMetricConfig.Metric

All Implemented Interfaces:

DataprocMetricConfig.MetricOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

DataprocMetricConfig

public static final class DataprocMetricConfig.Metric
extends com.google.protobuf.GeneratedMessageV3
implements DataprocMetricConfig.MetricOrBuilder

 A Dataproc custom metric.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataprocMetricConfig.Metric.Builder A Dataproc custom metric.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	METRIC_OVERRIDES_FIELD_NUMBER
static int	METRIC_SOURCE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static DataprocMetricConfig.Metric	getDefaultInstance()
DataprocMetricConfig.Metric	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getMetricOverrides(int index) Optional.
com.google.protobuf.ByteString	getMetricOverridesBytes(int index) Optional.
int	getMetricOverridesCount() Optional.
com.google.protobuf.ProtocolStringList	getMetricOverridesList() Optional.
DataprocMetricConfig.MetricSource	getMetricSource() Required.
int	getMetricSourceValue() Required.
com.google.protobuf.Parser<DataprocMetricConfig.Metric>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DataprocMetricConfig.Metric.Builder	newBuilder()
static DataprocMetricConfig.Metric.Builder	newBuilder(DataprocMetricConfig.Metric prototype)
DataprocMetricConfig.Metric.Builder	newBuilderForType()
protected DataprocMetricConfig.Metric.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DataprocMetricConfig.Metric	parseDelimitedFrom(InputStream input)
static DataprocMetricConfig.Metric	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataprocMetricConfig.Metric	parseFrom(byte[] data)
static DataprocMetricConfig.Metric	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataprocMetricConfig.Metric	parseFrom(ByteBuffer data)
static DataprocMetricConfig.Metric	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataprocMetricConfig.Metric	parseFrom(com.google.protobuf.ByteString data)
static DataprocMetricConfig.Metric	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataprocMetricConfig.Metric	parseFrom(com.google.protobuf.CodedInputStream input)
static DataprocMetricConfig.Metric	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataprocMetricConfig.Metric	parseFrom(InputStream input)
static DataprocMetricConfig.Metric	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DataprocMetricConfig.Metric>	parser()
DataprocMetricConfig.Metric.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

METRIC_SOURCE_FIELD_NUMBER

public static final int METRIC_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

METRIC_OVERRIDES_FIELD_NUMBER

public static final int METRIC_OVERRIDES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getMetricSourceValue

public int getMetricSourceValue()

 Required. A standard set of metrics is collected unless `metricOverrides`
 are specified for the metric source (see [Custom metrics]
 (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics)
 for more information).
 

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

Specified by:

getMetricSourceValue in interface DataprocMetricConfig.MetricOrBuilder

Returns:

The enum numeric value on the wire for metricSource.

getMetricSource

public DataprocMetricConfig.MetricSource getMetricSource()

 Required. A standard set of metrics is collected unless `metricOverrides`
 are specified for the metric source (see [Custom metrics]
 (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics)
 for more information).
 

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

Specified by:

getMetricSource in interface DataprocMetricConfig.MetricOrBuilder

Returns:

The metricSource.

getMetricOverridesList

public com.google.protobuf.ProtocolStringList getMetricOverridesList()

 Optional. Specify one or more [Custom metrics]
 (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics)
 to collect for the metric course (for the `SPARK` metric source (any
 [Spark metric]
 (https://spark.apache.org/docs/latest/monitoring.html#metrics) 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];

Specified by:

getMetricOverridesList in interface DataprocMetricConfig.MetricOrBuilder

Returns:

A list containing the metricOverrides.

getMetricOverridesCount

public int getMetricOverridesCount()

 Optional. Specify one or more [Custom metrics]
 (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics)
 to collect for the metric course (for the `SPARK` metric source (any
 [Spark metric]
 (https://spark.apache.org/docs/latest/monitoring.html#metrics) 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];

Specified by:

getMetricOverridesCount in interface DataprocMetricConfig.MetricOrBuilder

Returns:

The count of metricOverrides.

getMetricOverrides

public String getMetricOverrides(int index)

 Optional. Specify one or more [Custom metrics]
 (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics)
 to collect for the metric course (for the `SPARK` metric source (any
 [Spark metric]
 (https://spark.apache.org/docs/latest/monitoring.html#metrics) 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];

Specified by:

getMetricOverrides in interface DataprocMetricConfig.MetricOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The metricOverrides at the given index.

getMetricOverridesBytes

public com.google.protobuf.ByteString getMetricOverridesBytes(int index)

 Optional. Specify one or more [Custom metrics]
 (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics)
 to collect for the metric course (for the `SPARK` metric source (any
 [Spark metric]
 (https://spark.apache.org/docs/latest/monitoring.html#metrics) 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];

Specified by:

getMetricOverridesBytes in interface DataprocMetricConfig.MetricOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the metricOverrides at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DataprocMetricConfig.Metric parseFrom(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataprocMetricConfig.Metric parseFrom(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataprocMetricConfig.Metric parseFrom(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataprocMetricConfig.Metric parseFrom(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataprocMetricConfig.Metric parseFrom(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataprocMetricConfig.Metric parseFrom(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataprocMetricConfig.Metric parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static DataprocMetricConfig.Metric parseFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static DataprocMetricConfig.Metric parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static DataprocMetricConfig.Metric parseDelimitedFrom(InputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Throws:

IOException

parseFrom

public static DataprocMetricConfig.Metric parseFrom(com.google.protobuf.CodedInputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static DataprocMetricConfig.Metric parseFrom(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

newBuilderForType

public DataprocMetricConfig.Metric.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DataprocMetricConfig.Metric.Builder newBuilder()

newBuilder

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

toBuilder

public DataprocMetricConfig.Metric.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DataprocMetricConfig.Metric.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DataprocMetricConfig.Metric getDefaultInstance()

parser

public static com.google.protobuf.Parser<DataprocMetricConfig.Metric> parser()

getParserForType

public com.google.protobuf.Parser<DataprocMetricConfig.Metric> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DataprocMetricConfig.Metric getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder