com.ibm.cloud.objectstorage.services.s3.model.metrics

Class MetricsConfiguration

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.model.metrics.MetricsConfiguration

All Implemented Interfaces:

Serializable

public class MetricsConfiguration
extends Object
implements Serializable

Class to specify the metrics configuration.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetricsConfiguration()

Method Summary

Modifier and Type	Method and Description
MetricsFilter	getFilter() Returns the metrics configuration filter.
String	getId() Returns the ID used to identify the metrics configuration.
void	setFilter(MetricsFilter filter) Sets a metrics configuration filter.
void	setId(String id) Sets the ID used to identify the metrics configuration.
MetricsConfiguration	withFilter(MetricsFilter filter) Sets a metrics configuration filter and returns MetricsConfiguration object for method chaining.
MetricsConfiguration	withId(String id) Sets the ID used to identify the metrics configuration and returns this object for method chaining.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsConfiguration

public MetricsConfiguration()

Method Detail

getId

public String getId()

Returns the ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

setId

public void setId(String id)

Sets the ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

withId

public MetricsConfiguration withId(String id)

Sets the ID used to identify the metrics configuration and returns this object for method chaining. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

getFilter

public MetricsFilter getFilter()

Returns the metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A null filter indicates that the metrics are computed for the entire bucket.

setFilter

public void setFilter(MetricsFilter filter)

Sets a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. The filter may be omitted to get metrics for the entire bucket.

withFilter

public MetricsConfiguration withFilter(MetricsFilter filter)

Sets a metrics configuration filter and returns MetricsConfiguration object for method chaining. The metrics configuration will only include objects that meet the filter's criteria. The filter may be omitted to get metrics for the entire bucket.