com.google.cloud.dataproc.v1

Interface DataprocMetricConfig.MetricOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

DataprocMetricConfig.Metric, DataprocMetricConfig.Metric.Builder

Enclosing class:

DataprocMetricConfig

public static interface DataprocMetricConfig.MetricOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getMetricOverrides(int index) Optional.
ByteString	getMetricOverridesBytes(int index) Optional.
int	getMetricOverridesCount() Optional.
List<String>	getMetricOverridesList() Optional.
DataprocMetricConfig.MetricSource	getMetricSource() Required.
int	getMetricSourceValue() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getMetricSourceValue

int getMetricSourceValue()

 Required. Default metrics are collected unless `metricOverrides` are
 specified for the metric source (see [Available OSS metrics]
 (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_metrics)
 for more information).
 

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

Returns:

The enum numeric value on the wire for metricSource.

getMetricSource

DataprocMetricConfig.MetricSource getMetricSource()

 Required. Default metrics are collected unless `metricOverrides` are
 specified for the metric source (see [Available OSS metrics]
 (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_metrics)
 for more information).
 

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

Returns:

The metricSource.

getMetricOverridesList

List<String> getMetricOverridesList()

 Optional. Specify one or more [available OSS metrics]
 (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_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 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:

A list containing the metricOverrides.

getMetricOverridesCount

int getMetricOverridesCount()

 Optional. Specify one or more [available OSS metrics]
 (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_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 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:

The count of metricOverrides.

getMetricOverrides

String getMetricOverrides(int index)

 Optional. Specify one or more [available OSS metrics]
 (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_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 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:

index - The index of the element to return.

Returns:

The metricOverrides at the given index.

getMetricOverridesBytes

ByteString getMetricOverridesBytes(int index)

 Optional. Specify one or more [available OSS metrics]
 (https://cloud.google.com/dataproc/docs/guides/monitoring#available_oss_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 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:

index - The index of the value to return.

Returns:

The bytes of the metricOverrides at the given index.