Interface DataprocMetricConfig.MetricOrBuilder (4.16.0)

public static interface DataprocMetricConfig.MetricOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getMetricOverrides(int index)

public abstract String getMetricOverrides(int index)

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

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 abstract ByteString getMetricOverridesBytes(int index)

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

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 abstract int getMetricOverridesCount()

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.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
Type	Description
`int`	The count of metricOverrides.

getMetricOverridesList()

public abstract List<String> getMetricOverridesList()

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.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
Type	Description
`List<String>`	A list containing the metricOverrides.

getMetricSource()

public abstract 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 abstract 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.