Package software.amazon.awssdk.services.glacier.model

Interface InventoryRetrievalJobDescription.Builder

    • Method Detail

      • format

        InventoryRetrievalJobDescription.Builder format​(String format)

        The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

        Parameters:
        format - The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startDate

        InventoryRetrievalJobDescription.Builder startDate​(String startDate)

        The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

        Parameters:
        startDate - The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endDate

        InventoryRetrievalJobDescription.Builder endDate​(String endDate)

        The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

        Parameters:
        endDate - The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • limit

        InventoryRetrievalJobDescription.Builder limit​(String limit)

        The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

        Parameters:
        limit - The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • marker

        InventoryRetrievalJobDescription.Builder marker​(String marker)

        An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

        Parameters:
        marker - An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.
        Returns:
        Returns a reference to this object so that method calls can be chained together.