Package com.google.cloud.dataproc.v1

Interface DataprocMetricConfig.MetricOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DataprocMetricConfig.Metric, DataprocMetricConfig.Metric.Builder

Enclosing class:

DataprocMetricConfig

public static interface DataprocMetricConfig.MetricOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
String	getMetricOverrides(int index)	Optional.
com.google.protobuf.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.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getMetricSourceValue

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];

Returns:

The enum numeric value on the wire for metricSource.

getMetricSource

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];

Returns:

The metricSource.

getMetricOverridesList

List<String> 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];

Returns:

A list containing the metricOverrides.

getMetricOverridesCount

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];

Returns:

The count of metricOverrides.

getMetricOverrides

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];

Parameters:

index - The index of the element to return.

Returns:

The metricOverrides at the given index.

getMetricOverridesBytes

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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the metricOverrides at the given index.