- 4.50.0 (latest)
- 4.49.0
- 4.48.0
- 4.46.0
- 4.45.0
- 4.44.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.34.0
- 4.33.0
- 4.32.0
- 4.31.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.16.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.0
- 4.8.0
- 4.6.0
- 4.5.0
- 4.4.0
- 4.3.0
- 4.2.0
- 4.1.0
- 4.0.8
- 3.1.2
- 3.0.3
- 2.3.1
public static final class DataprocMetricConfig.Metric.Builder extends GeneratedMessageV3.Builder<DataprocMetricConfig.Metric.Builder> implements DataprocMetricConfig.MetricOrBuilderA Dataproc OSS metric.
Protobuf type google.cloud.dataproc.v1.DataprocMetricConfig.Metric
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DataprocMetricConfig.Metric.BuilderImplements
DataprocMetricConfig.MetricOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllMetricOverrides(Iterable<String> values)
public DataprocMetricConfig.Metric.Builder addAllMetricOverrides(Iterable<String> values) 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 |
values | Iterable<String>The metricOverrides to add. |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | This builder for chaining. |
addMetricOverrides(String value)
public DataprocMetricConfig.Metric.Builder addMetricOverrides(String value) 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 |
value | StringThe metricOverrides to add. |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | This builder for chaining. |
addMetricOverridesBytes(ByteString value)
public DataprocMetricConfig.Metric.Builder addMetricOverridesBytes(ByteString value) 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 |
value | ByteStringThe bytes of the metricOverrides to add. |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DataprocMetricConfig.Metric.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |
build()
public DataprocMetricConfig.Metric build()| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric | |
buildPartial()
public DataprocMetricConfig.Metric buildPartial()| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric | |
clear()
public DataprocMetricConfig.Metric.Builder clear()| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |
clearField(Descriptors.FieldDescriptor field)
public DataprocMetricConfig.Metric.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |
clearMetricOverrides()
public DataprocMetricConfig.Metric.Builder clearMetricOverrides() 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 |
DataprocMetricConfig.Metric.Builder | This builder for chaining. |
clearMetricSource()
public DataprocMetricConfig.Metric.Builder clearMetricSource() 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.Metric.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public DataprocMetricConfig.Metric.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |
clone()
public DataprocMetricConfig.Metric.Builder clone()| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |
getDefaultInstanceForType()
public DataprocMetricConfig.Metric getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getMetricOverrides(int index)
public 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 | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The metricOverrides at the given index. |
getMetricOverridesBytes(int index)
public 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 | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the metricOverrides at the given index. |
getMetricOverridesCount()
public 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 ProtocolStringList 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 |
ProtocolStringList | A list containing the metricOverrides. |
getMetricSource()
public 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(DataprocMetricConfig.Metric other)
public DataprocMetricConfig.Metric.Builder mergeFrom(DataprocMetricConfig.Metric other)| Parameter | |
|---|---|
| Name | Description |
other | DataprocMetricConfig.Metric |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DataprocMetricConfig.Metric.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public DataprocMetricConfig.Metric.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DataprocMetricConfig.Metric.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public DataprocMetricConfig.Metric.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |
setMetricOverrides(int index, String value)
public DataprocMetricConfig.Metric.Builder setMetricOverrides(int index, String value) 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];
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe metricOverrides to set. |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | This builder for chaining. |
setMetricSource(DataprocMetricConfig.MetricSource value)
public DataprocMetricConfig.Metric.Builder setMetricSource(DataprocMetricConfig.MetricSource value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | DataprocMetricConfig.MetricSourceThe metricSource to set. |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | This builder for chaining. |
setMetricSourceValue(int value)
public DataprocMetricConfig.Metric.Builder setMetricSourceValue(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for metricSource to set. |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DataprocMetricConfig.Metric.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final DataprocMetricConfig.Metric.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DataprocMetricConfig.Metric.Builder | |