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

Interface DescribeJobResponse.Builder

    • Method Detail

      • jobId

        DescribeJobResponse.Builder jobId​(String jobId)

        An opaque string that identifies an Amazon S3 Glacier job.

        Parameters:
        jobId - An opaque string that identifies an Amazon S3 Glacier job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobDescription

        DescribeJobResponse.Builder jobDescription​(String jobDescription)

        The job description provided when initiating the job.

        Parameters:
        jobDescription - The job description provided when initiating the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • action

        DescribeJobResponse.Builder action​(String action)

        The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

        Parameters:
        action - The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ActionCode, ActionCode

      • action

        DescribeJobResponse.Builder action​(ActionCode action)

        The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

        Parameters:
        action - The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ActionCode, ActionCode

      • archiveId

        DescribeJobResponse.Builder archiveId​(String archiveId)

        The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

        Parameters:
        archiveId - The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vaultARN

        DescribeJobResponse.Builder vaultARN​(String vaultARN)

        The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

        Parameters:
        vaultARN - The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationDate

        DescribeJobResponse.Builder creationDate​(String creationDate)

        The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z".

        Parameters:
        creationDate - The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z".
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • completed

        DescribeJobResponse.Builder completed​(Boolean completed)

        The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

        Parameters:
        completed - The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusCode

        DescribeJobResponse.Builder statusCode​(String statusCode)

        The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

        Parameters:
        statusCode - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StatusCode, StatusCode

      • statusCode

        DescribeJobResponse.Builder statusCode​(StatusCode statusCode)

        The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

        Parameters:
        statusCode - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StatusCode, StatusCode

      • statusMessage

        DescribeJobResponse.Builder statusMessage​(String statusMessage)

        A friendly message that describes the job status.

        Parameters:
        statusMessage - A friendly message that describes the job status.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • archiveSizeInBytes

        DescribeJobResponse.Builder archiveSizeInBytes​(Long archiveSizeInBytes)

        For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

        Parameters:
        archiveSizeInBytes - For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inventorySizeInBytes

        DescribeJobResponse.Builder inventorySizeInBytes​(Long inventorySizeInBytes)

        For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

        Parameters:
        inventorySizeInBytes - For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snsTopic

        DescribeJobResponse.Builder snsTopic​(String snsTopic)

        An Amazon SNS topic that receives notification.

        Parameters:
        snsTopic - An Amazon SNS topic that receives notification.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • completionDate

        DescribeJobResponse.Builder completionDate​(String completionDate)

        The UTC time that the job request completed. While the job is in progress, the value is null.

        Parameters:
        completionDate - The UTC time that the job request completed. While the job is in progress, the value is null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sha256TreeHash

        DescribeJobResponse.Builder sha256TreeHash​(String sha256TreeHash)

        For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

        The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

        If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

        This field is null for the following:

        • Archive retrieval jobs that specify a range that is not tree-hash aligned

        • Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress

        • Inventory jobs

        • Select jobs

        Parameters:
        sha256TreeHash - For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

        The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

        If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

        This field is null for the following:

        • Archive retrieval jobs that specify a range that is not tree-hash aligned

        • Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress

        • Inventory jobs

        • Select jobs

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • archiveSHA256TreeHash

        DescribeJobResponse.Builder archiveSHA256TreeHash​(String archiveSHA256TreeHash)

        The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

        Parameters:
        archiveSHA256TreeHash - The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • retrievalByteRange

        DescribeJobResponse.Builder retrievalByteRange​(String retrievalByteRange)

        The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

        Parameters:
        retrievalByteRange - The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tier

        DescribeJobResponse.Builder tier​(String tier)

        The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

        Parameters:
        tier - The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inventoryRetrievalParameters

        DescribeJobResponse.Builder inventoryRetrievalParameters​(InventoryRetrievalJobDescription inventoryRetrievalParameters)

        Parameters used for range inventory retrieval.

        Parameters:
        inventoryRetrievalParameters - Parameters used for range inventory retrieval.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobOutputPath

        DescribeJobResponse.Builder jobOutputPath​(String jobOutputPath)

        Contains the job output location.

        Parameters:
        jobOutputPath - Contains the job output location.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • selectParameters

        DescribeJobResponse.Builder selectParameters​(SelectParameters selectParameters)

        Contains the parameters used for a select.

        Parameters:
        selectParameters - Contains the parameters used for a select.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputLocation

        DescribeJobResponse.Builder outputLocation​(OutputLocation outputLocation)

        Contains the location where the data from the select job is stored.

        Parameters:
        outputLocation - Contains the location where the data from the select job is stored.
        Returns:
        Returns a reference to this object so that method calls can be chained together.