java.lang.Object
- software.amazon.awssdk.services.storagegateway.model.CacheReportInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CacheReportInfo.Builder,CacheReportInfo>
```
@Generated("software.amazon.awssdk:codegen")
public final class CacheReportInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CacheReportInfo.Builder,CacheReportInfo>
```
Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CacheReportInfo.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CacheReportInfo.Builder`	`builder()`
`String`	`cacheReportARN()`	The Amazon Resource Name (ARN) of the cache report you want to describe.
`CacheReportStatus`	`cacheReportStatus()`	The status of the specified cache report.
`String`	`cacheReportStatusAsString()`	The status of the specified cache report.
`Instant`	`endTime()`	The time at which the gateway stopped generating the cache report.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<CacheReportFilter>`	`exclusionFilters()`	The list of filters and parameters that determine which files are excluded from the report.
`String`	`fileShareARN()`	Returns the value of the FileShareARN property for this object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExclusionFilters()`	For responses, this returns true if the service returned a value for the ExclusionFilters property.
`int`	`hashCode()`
`boolean`	`hasInclusionFilters()`	For responses, this returns true if the service returned a value for the InclusionFilters property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`List<CacheReportFilter>`	`inclusionFilters()`	The list of filters and parameters that determine which files are included in the report.
`String`	`locationARN()`	The ARN of the Amazon S3 bucket location where the cache report is saved.
`Integer`	`reportCompletionPercent()`	The percentage of the report generation process that has been completed at time of inquiry.
`String`	`reportName()`	The file name of the completed cache report object stored in Amazon S3.
`String`	`role()`	Returns the value of the Role property for this object.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CacheReportInfo.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	The time at which the gateway started generating the cache report.
`List<Tag>`	`tags()`	The list of key/value tags associated with the report.
`CacheReportInfo.Builder`	`toBuilder()`
`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 software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - cacheReportARN
```
public final String cacheReportARN()
```
    The Amazon Resource Name (ARN) of the cache report you want to describe.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the cache report you want to describe.
  - cacheReportStatus
```
public final CacheReportStatus cacheReportStatus()
```
    The status of the specified cache report.
    
    If the service returns an enum value that is not available in the current SDK version, cacheReportStatus will return CacheReportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cacheReportStatusAsString().
    
    Returns:
    
    The status of the specified cache report.
    
    See Also:
    
    CacheReportStatus
  - cacheReportStatusAsString
```
public final String cacheReportStatusAsString()
```
    The status of the specified cache report.
    
    If the service returns an enum value that is not available in the current SDK version, cacheReportStatus will return CacheReportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cacheReportStatusAsString().
    
    Returns:
    
    The status of the specified cache report.
    
    See Also:
    
    CacheReportStatus
  - reportCompletionPercent
```
public final Integer reportCompletionPercent()
```
    The percentage of the report generation process that has been completed at time of inquiry.
    
    Returns:
    
    The percentage of the report generation process that has been completed at time of inquiry.
  - endTime
```
public final Instant endTime()
```
    The time at which the gateway stopped generating the cache report.
    
    Returns:
    
    The time at which the gateway stopped generating the cache report.
  - role
```
public final String role()
```
    Returns the value of the Role property for this object.
    
    Returns:
    
    The value of the Role property for this object.
  - fileShareARN
```
public final String fileShareARN()
```
    Returns the value of the FileShareARN property for this object.
    
    Returns:
    
    The value of the FileShareARN property for this object.
  - locationARN
```
public final String locationARN()
```
    The ARN of the Amazon S3 bucket location where the cache report is saved.
    
    Returns:
    
    The ARN of the Amazon S3 bucket location where the cache report is saved.
  - startTime
```
public final Instant startTime()
```
    The time at which the gateway started generating the cache report.
    
    Returns:
    
    The time at which the gateway started generating the cache report.
  - hasInclusionFilters
```
public final boolean hasInclusionFilters()
```
    For responses, this returns true if the service returned a value for the InclusionFilters 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.
  - inclusionFilters
```
public final List<CacheReportFilter> inclusionFilters()
```
    The list of filters and parameters that determine which files are included in the report.
    
    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 hasInclusionFilters() method.
    
    Returns:
    
    The list of filters and parameters that determine which files are included in the report.
  - hasExclusionFilters
```
public final boolean hasExclusionFilters()
```
    For responses, this returns true if the service returned a value for the ExclusionFilters 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.
  - exclusionFilters
```
public final List<CacheReportFilter> exclusionFilters()
```
    The list of filters and parameters that determine which files are excluded from the report.
    
    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 hasExclusionFilters() method.
    
    Returns:
    
    The list of filters and parameters that determine which files are excluded from the report.
  - reportName
```
public final String reportName()
```
    The file name of the completed cache report object stored in Amazon S3.
    
    Returns:
    
    The file name of the completed cache report object stored in Amazon S3.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    The list of key/value tags associated with the report.
    
    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 hasTags() method.
    
    Returns:
    
    The list of key/value tags associated with the report.
  - toBuilder
```
public CacheReportInfo.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CacheReportInfo.Builder,CacheReportInfo>
  - builder
```
public static CacheReportInfo.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CacheReportInfo.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

Class CacheReportInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

cacheReportARN

cacheReportStatus

cacheReportStatusAsString

reportCompletionPercent

endTime

role

fileShareARN

locationARN

startTime

hasInclusionFilters

inclusionFilters

hasExclusionFilters

exclusionFilters

reportName

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField