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

Interface StartCacheReportRequest.Builder

    • Method Detail

      • fileShareARN

        StartCacheReportRequest.Builder fileShareARN​(String fileShareARN)
        Sets the value of the FileShareARN property for this object.
        Parameters:
        fileShareARN - The new value for the FileShareARN property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • role

        StartCacheReportRequest.Builder role​(String role)

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

        Parameters:
        role - The ARN of the IAM role used when saving the cache report to Amazon S3.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • locationARN

        StartCacheReportRequest.Builder locationARN​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • bucketRegion

        StartCacheReportRequest.Builder bucketRegion​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • vpcEndpointDNSName

        StartCacheReportRequest.Builder vpcEndpointDNSName​(String vpcEndpointDNSName)

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

        Parameters:
        vpcEndpointDNSName - The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inclusionFilters

        StartCacheReportRequest.Builder inclusionFilters​(Collection<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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inclusionFilters

        StartCacheReportRequest.Builder inclusionFilters​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inclusionFilters

        StartCacheReportRequest.Builder inclusionFilters​(Consumer<CacheReportFilter.Builder>... 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.

        This is a convenience method that creates an instance of the CacheReportFilter.Builder avoiding the need to create one manually via CacheReportFilter.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #inclusionFilters(List).

        Parameters:
        inclusionFilters - a consumer that will call methods on CacheReportFilter.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #inclusionFilters(java.util.Collection)

      • exclusionFilters

        StartCacheReportRequest.Builder exclusionFilters​(Collection<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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exclusionFilters

        StartCacheReportRequest.Builder exclusionFilters​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exclusionFilters

        StartCacheReportRequest.Builder exclusionFilters​(Consumer<CacheReportFilter.Builder>... 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.

        This is a convenience method that creates an instance of the CacheReportFilter.Builder avoiding the need to create one manually via CacheReportFilter.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #exclusionFilters(List).

        Parameters:
        exclusionFilters - a consumer that will call methods on CacheReportFilter.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #exclusionFilters(java.util.Collection)

      • clientToken

        StartCacheReportRequest.Builder clientToken​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartCacheReportRequest.Builder tags​(Collection<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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartCacheReportRequest.Builder tags​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartCacheReportRequest.Builder tags​(Consumer<Tag.Builder>... 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.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)