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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StartCacheReportRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`bucketRegion()`	The Amazon Web Services Region of the Amazon S3 bucket associated with the file share for which you want to generate the cache report.
`static StartCacheReportRequest.Builder`	`builder()`
`String`	`clientToken()`	A unique identifier that you use to ensure idempotent report generation if you need to retry an unsuccessful `StartCacheReport` request.
`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 where the cache report will be saved.
`String`	`role()`	The ARN of the IAM role used when saving the cache report to Amazon S3.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartCacheReportRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	A list of up to 50 key/value tags that you can assign to the cache report.
`StartCacheReportRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`vpcEndpointDNSName()`	The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - 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 the cache report will be saved.
    
    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 the cache report will be saved.
    
    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 associated with the file share for which you want to generate the cache report.
    
    Returns:
    
    The Amazon Web Services Region of the Amazon S3 bucket associated with the file share for which you want to generate 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartCacheReportRequest.Builder,StartCacheReportRequest>
    
    Specified by:
    
    toBuilder in class StorageGatewayRequest
  - 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)
```
    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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - 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 StartCacheReportRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

fileShareARN

role

locationARN

bucketRegion

vpcEndpointDNSName

hasInclusionFilters

inclusionFilters

hasExclusionFilters

exclusionFilters

clientToken

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField