com.ibm.cloud.objectstorage.config.resource_configuration.v1.model

Class MetricsMonitoring

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.objectstorage.config.resource_configuration.v1.model.MetricsMonitoring

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class MetricsMonitoring
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in. (Recommended) When the `metrics_monitoring_crn` is not populated, then enabled metrics are sent to the Monitoring instance at the container's location unless otherwise specified in the Metrics Router service configuration. (Legacy) When the `metrics_monitoring_crn` is populated, then enabled metrics are sent to the Monitoring instance defined in the `metrics_monitoring_crn` field.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricsMonitoring.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	metricsMonitoringCrn
protected java.lang.Boolean	requestMetricsEnabled
protected java.lang.Boolean	usageMetricsEnabled

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetricsMonitoring()
protected	MetricsMonitoring(MetricsMonitoring.Builder builder)

Method Summary

Modifier and Type	Method and Description
java.lang.String	metricsMonitoringCrn() Gets the metricsMonitoringCrn.
MetricsMonitoring.Builder	newBuilder() New builder.
java.lang.Boolean	requestMetricsEnabled() Gets the requestMetricsEnabled.
java.lang.Boolean	usageMetricsEnabled() Gets the usageMetricsEnabled.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

usageMetricsEnabled

@SerializedName(value="usage_metrics_enabled")
protected java.lang.Boolean usageMetricsEnabled

requestMetricsEnabled

@SerializedName(value="request_metrics_enabled")
protected java.lang.Boolean requestMetricsEnabled

metricsMonitoringCrn

@SerializedName(value="metrics_monitoring_crn")
protected java.lang.String metricsMonitoringCrn

Constructor Detail

MetricsMonitoring

protected MetricsMonitoring()

MetricsMonitoring

protected MetricsMonitoring(MetricsMonitoring.Builder builder)

Method Detail

newBuilder

public MetricsMonitoring.Builder newBuilder()

New builder.

Returns:

a MetricsMonitoring builder

usageMetricsEnabled

public java.lang.Boolean usageMetricsEnabled()

Gets the usageMetricsEnabled. If set to `true`, all usage metrics (i.e. `bytes_used`) will be sent to the monitoring service.

Returns:

the usageMetricsEnabled

requestMetricsEnabled

public java.lang.Boolean requestMetricsEnabled()

Gets the requestMetricsEnabled. If set to `true`, all request metrics (i.e. `rest.object.head`) will be sent to the monitoring service.

Returns:

the requestMetricsEnabled

metricsMonitoringCrn

public java.lang.String metricsMonitoringCrn()

Gets the metricsMonitoringCrn. When the `metrics_monitoring_crn` is not populated, then enabled metrics are sent to the monitoring instance associated to the container's location unless otherwise specified in the Metrics Router service configuration. If `metrics_monitoring_crn` is populated, then enabled events are sent to the Metrics Monitoring instance specified.

Returns:

the metricsMonitoringCrn