com.ibm.cos.v2.services.s3.model

Class AnalyticsConfiguration

java.lang.Object

com.ibm.cos.v2.services.s3.model.AnalyticsConfiguration

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AnalyticsConfiguration.Builder,AnalyticsConfiguration>, Serializable

@Generated(value="com.ibm.cos.v2:codegen")
public final class AnalyticsConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalyticsConfiguration.Builder,AnalyticsConfiguration>

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AnalyticsConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static AnalyticsConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
AnalyticsFilter	filter() The filter used to describe a set of objects for analyses.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The ID that identifies the analytics configuration.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AnalyticsConfiguration.Builder>	serializableBuilderClass()
StorageClassAnalysis	storageClassAnalysis() Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.
AnalyticsConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public final String id()

The ID that identifies the analytics configuration.

Returns:

The ID that identifies the analytics configuration.

filter

public final AnalyticsFilter filter()

The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

Returns:

The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

storageClassAnalysis

public final StorageClassAnalysis storageClassAnalysis()

Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

Returns:

Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

toBuilder

public AnalyticsConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AnalyticsConfiguration.Builder,AnalyticsConfiguration>

Returns:

a builder for type T

builder

public static AnalyticsConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends AnalyticsConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.