target.apidocs.com.google.api.services.dataproc.model.Metric.html Maven / Gradle / Ivy
Metric (Cloud Dataproc API v1-rev20240605-2.0.0)
com.google.api.services.dataproc.model
Class Metric
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.dataproc.model.Metric
-
public final class Metric
extends com.google.api.client.json.GenericJson
A Dataproc custom metric.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Cloud Dataproc API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Metric()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Metric
clone()
List<String>
getMetricOverrides()
Optional.
String
getMetricSource()
Required.
Metric
set(String fieldName,
Object value)
Metric
setMetricOverrides(List<String> metricOverrides)
Optional.
Metric
setMetricSource(String metricSource)
Required.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getMetricOverrides
public List<String> getMetricOverrides()
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: METRIC_SOURCE: INSTANCE:GROUP:METRIC 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.
- Returns:
- value or
null
for none
-
setMetricOverrides
public Metric setMetricOverrides(List<String> metricOverrides)
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: METRIC_SOURCE: INSTANCE:GROUP:METRIC 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.
- Parameters:
metricOverrides
- metricOverrides or null
for none
-
getMetricSource
public String 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).
- Returns:
- value or
null
for none
-
setMetricSource
public Metric setMetricSource(String metricSource)
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).
- Parameters:
metricSource
- metricSource or null
for none
-
set
public Metric set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public Metric clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy