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

Interface JobParameters.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JobParameters.Builder,JobParameters>, SdkBuilder<JobParameters.Builder,JobParameters>, SdkPojo
Enclosing class:
JobParameters
public static interface JobParameters.Builder extends SdkPojo, CopyableBuilder<JobParameters.Builder,JobParameters>

  • Method Details

    • format

      JobParameters.Builder format(String format)

      When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

      Parameters:
      format - When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      JobParameters.Builder type(String type)

      The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

      Parameters:
      type - The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • archiveId

      JobParameters.Builder archiveId(String archiveId)

      The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

      Parameters:
      archiveId - The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      JobParameters.Builder description(String description)

      The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

      Parameters:
      description - The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snsTopic

      JobParameters.Builder snsTopic(String snsTopic)

      The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

      Parameters:
      snsTopic - The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retrievalByteRange

      JobParameters.Builder retrievalByteRange(String retrievalByteRange)

      The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

      An error occurs if you specify this field for an inventory retrieval job request.

      Parameters:
      retrievalByteRange - The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

      An error occurs if you specify this field for an inventory retrieval job request.

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

    • tier

      JobParameters.Builder tier(String tier)

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

      Parameters:
      tier - The tier to use for a select or an archive retrieval job. 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

      JobParameters.Builder inventoryRetrievalParameters(InventoryRetrievalJobInput inventoryRetrievalParameters)

      Input parameters used for range inventory retrieval.

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

    • inventoryRetrievalParameters

      default JobParameters.Builder inventoryRetrievalParameters(Consumer<InventoryRetrievalJobInput.Builder> inventoryRetrievalParameters)

      Input parameters used for range inventory retrieval.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inventoryRetrievalParameters(InventoryRetrievalJobInput).

      Parameters:
      inventoryRetrievalParameters - a consumer that will call methods on InventoryRetrievalJobInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • selectParameters

      JobParameters.Builder selectParameters(SelectParameters selectParameters)

      Contains the parameters that define a job.

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

    • selectParameters

      default JobParameters.Builder selectParameters(Consumer<SelectParameters.Builder> selectParameters)

      Contains the parameters that define a job.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to selectParameters(SelectParameters).

      Parameters:
      selectParameters - a consumer that will call methods on SelectParameters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputLocation

      JobParameters.Builder outputLocation(OutputLocation outputLocation)

      Contains information about the location where the select job results are stored.

      Parameters:
      outputLocation - Contains information about the location where the select job results are stored.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputLocation

      default JobParameters.Builder outputLocation(Consumer<OutputLocation.Builder> outputLocation)

      Contains information about the location where the select job results are stored.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputLocation(OutputLocation).

      Parameters:
      outputLocation - a consumer that will call methods on OutputLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: