Package com.google.cloud.dataproc.v1

Class DataprocMetricConfig.Metric.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<DataprocMetricConfig.Metric.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DataprocMetricConfig.Metric.Builder>

      • getDefaultInstanceForType

        public DataprocMetricConfig.Metric getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public DataprocMetricConfig.Metric build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public DataprocMetricConfig.Metric buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<DataprocMetricConfig.Metric.Builder>

      • mergeFrom

        public DataprocMetricConfig.Metric.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DataprocMetricConfig.Metric.Builder>
        Throws:
        IOException

      • getMetricSourceValue

        public 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];
        Specified by:
        getMetricSourceValue in interface DataprocMetricConfig.MetricOrBuilder
        Returns:
        The enum numeric value on the wire for metricSource.

      • setMetricSourceValue

        public DataprocMetricConfig.Metric.Builder setMetricSourceValue​(int value)
         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];
        Parameters:
        value - The enum numeric value on the wire for metricSource to set.
        Returns:
        This builder for chaining.

      • getMetricSource

        public 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];
        Specified by:
        getMetricSource in interface DataprocMetricConfig.MetricOrBuilder
        Returns:
        The metricSource.

      • setMetricSource

        public DataprocMetricConfig.Metric.Builder setMetricSource​(DataprocMetricConfig.MetricSource value)
         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];
        Parameters:
        value - The metricSource to set.
        Returns:
        This builder for chaining.

      • clearMetricSource

        public DataprocMetricConfig.Metric.Builder clearMetricSource()
         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:
        This builder for chaining.

      • getMetricOverridesList

        public com.google.protobuf.ProtocolStringList 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];
        Specified by:
        getMetricOverridesList in interface DataprocMetricConfig.MetricOrBuilder
        Returns:
        A list containing the metricOverrides.

      • getMetricOverridesCount

        public 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];
        Specified by:
        getMetricOverridesCount in interface DataprocMetricConfig.MetricOrBuilder
        Returns:
        The count of metricOverrides.

      • getMetricOverrides

        public 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];
        Specified by:
        getMetricOverrides in interface DataprocMetricConfig.MetricOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The metricOverrides at the given index.

      • getMetricOverridesBytes

        public 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];
        Specified by:
        getMetricOverridesBytes in interface DataprocMetricConfig.MetricOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the metricOverrides at the given index.

      • setMetricOverrides

        public DataprocMetricConfig.Metric.Builder setMetricOverrides​(int index,
                                                              String value)
         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 to set the value at.
        value - The metricOverrides to set.
        Returns:
        This builder for chaining.

      • addMetricOverrides

        public DataprocMetricConfig.Metric.Builder addMetricOverrides​(String value)
         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:
        value - The metricOverrides to add.
        Returns:
        This builder for chaining.

      • addAllMetricOverrides

        public DataprocMetricConfig.Metric.Builder addAllMetricOverrides​(Iterable<String> values)
         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:
        values - The metricOverrides to add.
        Returns:
        This builder for chaining.

      • clearMetricOverrides

        public DataprocMetricConfig.Metric.Builder clearMetricOverrides()
         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:
        This builder for chaining.

      • addMetricOverridesBytes

        public DataprocMetricConfig.Metric.Builder addMetricOverridesBytes​(com.google.protobuf.ByteString value)
         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:
        value - The bytes of the metricOverrides to add.
        Returns:
        This builder for chaining.

      • mergeUnknownFields

        public final DataprocMetricConfig.Metric.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DataprocMetricConfig.Metric.Builder>