Package software.amazon.awssdk.services.storagegateway.model

Class CacheReportFilter

java.lang.Object

software.amazon.awssdk.services.storagegateway.model.CacheReportFilter

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class CacheReportFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CacheReportFilter.Builder,CacheReportFilter>

A list of filter parameters and associated values that determine which files are included or excluded from a cache report created by a StartCacheReport request. Multiple instances of the same filter parameter are combined with an OR operation, while different parameters are combined with an AND operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CacheReportFilter.Builder

Method Summary

Modifier and Type	Method	Description
static CacheReportFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
CacheReportFilterName	name()	The parameter name for a filter that determines which files are included or excluded from a cache report.
String	nameAsString()	The parameter name for a filter that determines which files are included or excluded from a cache report.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CacheReportFilter.Builder>	serializableBuilderClass()
CacheReportFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The parameter value for a filter that determines which files are included or excluded from a cache report.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final CacheReportFilterName name()

The parameter name for a filter that determines which files are included or excluded from a cache report.

Valid Names:

UploadFailureReason | UploadState

If the service returns an enum value that is not available in the current SDK version, name will return CacheReportFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The parameter name for a filter that determines which files are included or excluded from a cache report.

Valid Names:

UploadFailureReason | UploadState

See Also:

CacheReportFilterName

nameAsString

public final String nameAsString()

The parameter name for a filter that determines which files are included or excluded from a cache report.

Valid Names:

UploadFailureReason | UploadState

If the service returns an enum value that is not available in the current SDK version, name will return CacheReportFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The parameter name for a filter that determines which files are included or excluded from a cache report.

Valid Names:

UploadFailureReason | UploadState

See Also:

CacheReportFilterName

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

values

public final List<String> values()

The parameter value for a filter that determines which files are included or excluded from a cache report.

Valid UploadFailureReason Values:

InaccessibleStorageClass | InvalidObjectState | ObjectMissing | S3AccessDenied

Valid UploadState Values:

FailingUpload

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

Returns:

The parameter value for a filter that determines which files are included or excluded from a cache report.

Valid UploadFailureReason Values:

InaccessibleStorageClass | InvalidObjectState | ObjectMissing | S3AccessDenied

Valid UploadState Values:

FailingUpload

toBuilder

public CacheReportFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CacheReportFilter.Builder,CacheReportFilter>

builder

public static CacheReportFilter.Builder builder()

serializableBuilderClass

public static Class<? extends CacheReportFilter.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo