Class StartCacheReportRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest
software.amazon.awssdk.services.storagegateway.model.StartCacheReportRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartCacheReportRequest.Builder,StartCacheReportRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartCacheReportRequest extends StorageGatewayRequest implements ToCopyableBuilder<StartCacheReportRequest.Builder,StartCacheReportRequest>

  • Method Details

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

    • role

      public final String role()

      The ARN of the IAM role used when saving the cache report to Amazon S3.

      Returns:
      The ARN of the IAM role used when saving the cache report to Amazon S3.

    • locationARN

      public final String locationARN()

      The ARN of the Amazon S3 bucket where you want to save the cache report.

      We do not recommend saving the cache report to the same Amazon S3 bucket for which you are generating the report.

      This field does not accept access point ARNs.

      Returns:
      The ARN of the Amazon S3 bucket where you want to save the cache report.

      We do not recommend saving the cache report to the same Amazon S3 bucket for which you are generating the report.

      This field does not accept access point ARNs.

    • bucketRegion

      public final String bucketRegion()

      The Amazon Web Services Region of the Amazon S3 bucket where you want to save the cache report.

      Returns:
      The Amazon Web Services Region of the Amazon S3 bucket where you want to save the cache report.

    • vpcEndpointDNSName

      public final String vpcEndpointDNSName()

      The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional.

      Returns:
      The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional.

    • 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. You must specify at least one value for InclusionFilters or ExclusionFilters in a StartCacheReport request.

      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. You must specify at least one value for InclusionFilters or ExclusionFilters in a StartCacheReport request.

    • 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. You must specify at least one value for InclusionFilters or ExclusionFilters in a StartCacheReport request.

      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. You must specify at least one value for InclusionFilters or ExclusionFilters in a StartCacheReport request.

    • clientToken

      public final String clientToken()

      A unique identifier that you use to ensure idempotent report generation if you need to retry an unsuccessful StartCacheReport request. If you retry a request, use the same ClientToken you specified in the initial request.

      Returns:
      A unique identifier that you use to ensure idempotent report generation if you need to retry an unsuccessful StartCacheReport request. If you retry a request, use the same ClientToken you specified in the initial request.

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

      A list of up to 50 key/value tags that you can assign to the cache report. Using tags can help you categorize your reports and more easily locate them in search results.

      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:
      A list of up to 50 key/value tags that you can assign to the cache report. Using tags can help you categorize your reports and more easily locate them in search results.

    • toBuilder

      public StartCacheReportRequest.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<StartCacheReportRequest.Builder,StartCacheReportRequest>
      Specified by:
      toBuilder in class StorageGatewayRequest
      Returns:
      a builder for type T

    • builder

      public static StartCacheReportRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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