Class CacheReportInfo

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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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<CacheReportInfo.Builder,CacheReportInfo>
      Returns:
      a builder for type T

    • 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)
      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.