com.amazonaws.services.glacier.model.GlacierJobDescription Maven / Gradle / Ivy
Show all versions of aws-java-sdk-glacier Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.glacier.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains the description of an Amazon S3 Glacier job.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GlacierJobDescription implements Serializable, Cloneable, StructuredPojo {
/**
*
* An opaque string that identifies an Amazon S3 Glacier job.
*
*/
private String jobId;
/**
*
* The job description provided when initiating the job.
*
*/
private String jobDescription;
/**
*
* The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
* Select.
*
*/
private String action;
/**
*
* The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
*
*/
private String archiveId;
/**
*
* The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
*
*/
private String vaultARN;
/**
*
* 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".
*
*/
private String creationDate;
/**
*
* The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
*
*/
private Boolean completed;
/**
*
* The status code can be InProgress, Succeeded, or Failed, and indicates the
* status of the job.
*
*/
private String statusCode;
/**
*
* A friendly message that describes the job status.
*
*/
private String statusMessage;
/**
*
* 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.
*
*/
private Long archiveSizeInBytes;
/**
*
* 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.
*
*/
private Long inventorySizeInBytes;
/**
*
* An Amazon SNS topic that receives notification.
*
*/
private String sNSTopic;
/**
*
* The UTC time that the job request completed. While the job is in progress, the value is null.
*
*/
private String completionDate;
/**
*
* 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
*
*
*
*/
private String sHA256TreeHash;
/**
*
* The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this
* field is null.
*
*/
private String archiveSHA256TreeHash;
/**
*
* 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.
*
*/
private String retrievalByteRange;
/**
*
* The tier to use for a select or an archive retrieval. Valid values are Expedited,
* Standard, or Bulk. Standard is the default.
*
*/
private String tier;
/**
*
* Parameters used for range inventory retrieval.
*
*/
private InventoryRetrievalJobDescription inventoryRetrievalParameters;
/**
*
* Contains the job output location.
*
*/
private String jobOutputPath;
/**
*
* Contains the parameters used for a select.
*
*/
private SelectParameters selectParameters;
/**
*
* Contains the location where the data from the select job is stored.
*
*/
private OutputLocation outputLocation;
/**
*
* An opaque string that identifies an Amazon S3 Glacier job.
*
*
* @param jobId
* An opaque string that identifies an Amazon S3 Glacier job.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* An opaque string that identifies an Amazon S3 Glacier job.
*
*
* @return An opaque string that identifies an Amazon S3 Glacier job.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* An opaque string that identifies an Amazon S3 Glacier job.
*
*
* @param jobId
* An opaque string that identifies an Amazon S3 Glacier job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
*
* The job description provided when initiating the job.
*
*
* @param jobDescription
* The job description provided when initiating the job.
*/
public void setJobDescription(String jobDescription) {
this.jobDescription = jobDescription;
}
/**
*
* The job description provided when initiating the job.
*
*
* @return The job description provided when initiating the job.
*/
public String getJobDescription() {
return this.jobDescription;
}
/**
*
* The job description provided when initiating the job.
*
*
* @param jobDescription
* The job description provided when initiating the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withJobDescription(String jobDescription) {
setJobDescription(jobDescription);
return this;
}
/**
*
* The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
* Select.
*
*
* @param action
* The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
* Select.
* @see ActionCode
*/
public void setAction(String action) {
this.action = action;
}
/**
*
* The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
* Select.
*
*
* @return The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
* Select.
* @see ActionCode
*/
public String getAction() {
return this.action;
}
/**
*
* The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
* Select.
*
*
* @param action
* The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
* Select.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionCode
*/
public GlacierJobDescription withAction(String action) {
setAction(action);
return this;
}
/**
*
* The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
* Select.
*
*
* @param action
* The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
* Select.
* @see ActionCode
*/
public void setAction(ActionCode action) {
withAction(action);
}
/**
*
* The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
* Select.
*
*
* @param action
* The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
* Select.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionCode
*/
public GlacierJobDescription withAction(ActionCode action) {
this.action = action.toString();
return this;
}
/**
*
* The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
*
*
* @param archiveId
* The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
*/
public void setArchiveId(String archiveId) {
this.archiveId = archiveId;
}
/**
*
* The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
*
*
* @return The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
*/
public String getArchiveId() {
return this.archiveId;
}
/**
*
* The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
*
*
* @param archiveId
* The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withArchiveId(String archiveId) {
setArchiveId(archiveId);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
*
*
* @param vaultARN
* The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
*/
public void setVaultARN(String vaultARN) {
this.vaultARN = vaultARN;
}
/**
*
* The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
*
*
* @return The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
*/
public String getVaultARN() {
return this.vaultARN;
}
/**
*
* The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
*
*
* @param vaultARN
* The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withVaultARN(String vaultARN) {
setVaultARN(vaultARN);
return this;
}
/**
*
* 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".
*
*
* @param 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".
*/
public void setCreationDate(String creationDate) {
this.creationDate = 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".
*
*
* @return 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".
*/
public String getCreationDate() {
return this.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".
*
*
* @param 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".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withCreationDate(String creationDate) {
setCreationDate(creationDate);
return this;
}
/**
*
* The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
*
*
* @param completed
* The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
*/
public void setCompleted(Boolean completed) {
this.completed = completed;
}
/**
*
* The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
*
*
* @return The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
*/
public Boolean getCompleted() {
return this.completed;
}
/**
*
* The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
*
*
* @param completed
* The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withCompleted(Boolean completed) {
setCompleted(completed);
return this;
}
/**
*
* The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
*
*
* @return The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
*/
public Boolean isCompleted() {
return this.completed;
}
/**
*
* The status code can be InProgress, Succeeded, or Failed, and indicates the
* status of the job.
*
*
* @param statusCode
* The status code can be InProgress, Succeeded, or Failed, and
* indicates the status of the job.
* @see StatusCode
*/
public void setStatusCode(String statusCode) {
this.statusCode = statusCode;
}
/**
*
* The status code can be InProgress, Succeeded, or Failed, and indicates the
* status of the job.
*
*
* @return The status code can be InProgress, Succeeded, or Failed, and
* indicates the status of the job.
* @see StatusCode
*/
public String getStatusCode() {
return this.statusCode;
}
/**
*
* The status code can be InProgress, Succeeded, or Failed, and indicates the
* status of the job.
*
*
* @param statusCode
* The status code can be InProgress, Succeeded, or Failed, and
* indicates the status of the job.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusCode
*/
public GlacierJobDescription withStatusCode(String statusCode) {
setStatusCode(statusCode);
return this;
}
/**
*
* The status code can be InProgress, Succeeded, or Failed, and indicates the
* status of the job.
*
*
* @param statusCode
* The status code can be InProgress, Succeeded, or Failed, and
* indicates the status of the job.
* @see StatusCode
*/
public void setStatusCode(StatusCode statusCode) {
withStatusCode(statusCode);
}
/**
*
* The status code can be InProgress, Succeeded, or Failed, and indicates the
* status of the job.
*
*
* @param statusCode
* The status code can be InProgress, Succeeded, or Failed, and
* indicates the status of the job.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusCode
*/
public GlacierJobDescription withStatusCode(StatusCode statusCode) {
this.statusCode = statusCode.toString();
return this;
}
/**
*
* A friendly message that describes the job status.
*
*
* @param statusMessage
* A friendly message that describes the job status.
*/
public void setStatusMessage(String statusMessage) {
this.statusMessage = statusMessage;
}
/**
*
* A friendly message that describes the job status.
*
*
* @return A friendly message that describes the job status.
*/
public String getStatusMessage() {
return this.statusMessage;
}
/**
*
* A friendly message that describes the job status.
*
*
* @param statusMessage
* A friendly message that describes the job status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withStatusMessage(String statusMessage) {
setStatusMessage(statusMessage);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setArchiveSizeInBytes(Long archiveSizeInBytes) {
this.archiveSizeInBytes = 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.
*
*
* @return 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.
*/
public Long getArchiveSizeInBytes() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withArchiveSizeInBytes(Long archiveSizeInBytes) {
setArchiveSizeInBytes(archiveSizeInBytes);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setInventorySizeInBytes(Long inventorySizeInBytes) {
this.inventorySizeInBytes = 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.
*
*
* @return 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.
*/
public Long getInventorySizeInBytes() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withInventorySizeInBytes(Long inventorySizeInBytes) {
setInventorySizeInBytes(inventorySizeInBytes);
return this;
}
/**
*
* An Amazon SNS topic that receives notification.
*
*
* @param sNSTopic
* An Amazon SNS topic that receives notification.
*/
public void setSNSTopic(String sNSTopic) {
this.sNSTopic = sNSTopic;
}
/**
*
* An Amazon SNS topic that receives notification.
*
*
* @return An Amazon SNS topic that receives notification.
*/
public String getSNSTopic() {
return this.sNSTopic;
}
/**
*
* An Amazon SNS topic that receives notification.
*
*
* @param sNSTopic
* An Amazon SNS topic that receives notification.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withSNSTopic(String sNSTopic) {
setSNSTopic(sNSTopic);
return this;
}
/**
*
* The UTC time that the job request completed. While the job is in progress, the value is null.
*
*
* @param completionDate
* The UTC time that the job request completed. While the job is in progress, the value is null.
*/
public void setCompletionDate(String completionDate) {
this.completionDate = completionDate;
}
/**
*
* The UTC time that the job request completed. While the job is in progress, the value is null.
*
*
* @return The UTC time that the job request completed. While the job is in progress, the value is null.
*/
public String getCompletionDate() {
return this.completionDate;
}
/**
*
* The UTC time that the job request completed. While the job is in progress, the value is null.
*
*
* @param completionDate
* The UTC time that the job request completed. While the job is in progress, the value is null.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withCompletionDate(String completionDate) {
setCompletionDate(completionDate);
return this;
}
/**
*
* 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
*
*
*
*
* @param 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
*
*
*/
public void setSHA256TreeHash(String sHA256TreeHash) {
this.sHA256TreeHash = 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
*
*
*
*
* @return 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
*
*
*/
public String getSHA256TreeHash() {
return this.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
*
*
*
*
* @param 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
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withSHA256TreeHash(String sHA256TreeHash) {
setSHA256TreeHash(sHA256TreeHash);
return this;
}
/**
*
* The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this
* field is null.
*
*
* @param archiveSHA256TreeHash
* The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select
* jobs, this field is null.
*/
public void setArchiveSHA256TreeHash(String archiveSHA256TreeHash) {
this.archiveSHA256TreeHash = archiveSHA256TreeHash;
}
/**
*
* The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this
* field is null.
*
*
* @return The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select
* jobs, this field is null.
*/
public String getArchiveSHA256TreeHash() {
return this.archiveSHA256TreeHash;
}
/**
*
* The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this
* field is null.
*
*
* @param archiveSHA256TreeHash
* The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select
* jobs, this field is null.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withArchiveSHA256TreeHash(String archiveSHA256TreeHash) {
setArchiveSHA256TreeHash(archiveSHA256TreeHash);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setRetrievalByteRange(String retrievalByteRange) {
this.retrievalByteRange = 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.
*
*
* @return 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.
*/
public String getRetrievalByteRange() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withRetrievalByteRange(String retrievalByteRange) {
setRetrievalByteRange(retrievalByteRange);
return this;
}
/**
*
* The tier to use for a select or an archive retrieval. Valid values are Expedited,
* Standard, or Bulk. Standard is the default.
*
*
* @param tier
* The tier to use for a select or an archive retrieval. Valid values are Expedited,
* Standard, or Bulk. Standard is the default.
*/
public void setTier(String tier) {
this.tier = tier;
}
/**
*
* The tier to use for a select or an archive retrieval. Valid values are Expedited,
* Standard, or Bulk. Standard is the default.
*
*
* @return The tier to use for a select or an archive retrieval. Valid values are Expedited,
* Standard, or Bulk. Standard is the default.
*/
public String getTier() {
return this.tier;
}
/**
*
* The tier to use for a select or an archive retrieval. Valid values are Expedited,
* Standard, or Bulk. Standard is the default.
*
*
* @param tier
* The tier to use for a select or an archive retrieval. Valid values are Expedited,
* Standard, or Bulk. Standard is the default.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withTier(String tier) {
setTier(tier);
return this;
}
/**
*
* Parameters used for range inventory retrieval.
*
*
* @param inventoryRetrievalParameters
* Parameters used for range inventory retrieval.
*/
public void setInventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters) {
this.inventoryRetrievalParameters = inventoryRetrievalParameters;
}
/**
*
* Parameters used for range inventory retrieval.
*
*
* @return Parameters used for range inventory retrieval.
*/
public InventoryRetrievalJobDescription getInventoryRetrievalParameters() {
return this.inventoryRetrievalParameters;
}
/**
*
* Parameters used for range inventory retrieval.
*
*
* @param inventoryRetrievalParameters
* Parameters used for range inventory retrieval.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withInventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters) {
setInventoryRetrievalParameters(inventoryRetrievalParameters);
return this;
}
/**
*
* Contains the job output location.
*
*
* @param jobOutputPath
* Contains the job output location.
*/
public void setJobOutputPath(String jobOutputPath) {
this.jobOutputPath = jobOutputPath;
}
/**
*
* Contains the job output location.
*
*
* @return Contains the job output location.
*/
public String getJobOutputPath() {
return this.jobOutputPath;
}
/**
*
* Contains the job output location.
*
*
* @param jobOutputPath
* Contains the job output location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withJobOutputPath(String jobOutputPath) {
setJobOutputPath(jobOutputPath);
return this;
}
/**
*
* Contains the parameters used for a select.
*
*
* @param selectParameters
* Contains the parameters used for a select.
*/
public void setSelectParameters(SelectParameters selectParameters) {
this.selectParameters = selectParameters;
}
/**
*
* Contains the parameters used for a select.
*
*
* @return Contains the parameters used for a select.
*/
public SelectParameters getSelectParameters() {
return this.selectParameters;
}
/**
*
* Contains the parameters used for a select.
*
*
* @param selectParameters
* Contains the parameters used for a select.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withSelectParameters(SelectParameters selectParameters) {
setSelectParameters(selectParameters);
return this;
}
/**
*
* Contains the location where the data from the select job is stored.
*
*
* @param outputLocation
* Contains the location where the data from the select job is stored.
*/
public void setOutputLocation(OutputLocation outputLocation) {
this.outputLocation = outputLocation;
}
/**
*
* Contains the location where the data from the select job is stored.
*
*
* @return Contains the location where the data from the select job is stored.
*/
public OutputLocation getOutputLocation() {
return this.outputLocation;
}
/**
*
* Contains the location where the data from the select job is stored.
*
*
* @param outputLocation
* Contains the location where the data from the select job is stored.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlacierJobDescription withOutputLocation(OutputLocation outputLocation) {
setOutputLocation(outputLocation);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getJobId() != null)
sb.append("JobId: ").append(getJobId()).append(",");
if (getJobDescription() != null)
sb.append("JobDescription: ").append(getJobDescription()).append(",");
if (getAction() != null)
sb.append("Action: ").append(getAction()).append(",");
if (getArchiveId() != null)
sb.append("ArchiveId: ").append(getArchiveId()).append(",");
if (getVaultARN() != null)
sb.append("VaultARN: ").append(getVaultARN()).append(",");
if (getCreationDate() != null)
sb.append("CreationDate: ").append(getCreationDate()).append(",");
if (getCompleted() != null)
sb.append("Completed: ").append(getCompleted()).append(",");
if (getStatusCode() != null)
sb.append("StatusCode: ").append(getStatusCode()).append(",");
if (getStatusMessage() != null)
sb.append("StatusMessage: ").append(getStatusMessage()).append(",");
if (getArchiveSizeInBytes() != null)
sb.append("ArchiveSizeInBytes: ").append(getArchiveSizeInBytes()).append(",");
if (getInventorySizeInBytes() != null)
sb.append("InventorySizeInBytes: ").append(getInventorySizeInBytes()).append(",");
if (getSNSTopic() != null)
sb.append("SNSTopic: ").append(getSNSTopic()).append(",");
if (getCompletionDate() != null)
sb.append("CompletionDate: ").append(getCompletionDate()).append(",");
if (getSHA256TreeHash() != null)
sb.append("SHA256TreeHash: ").append(getSHA256TreeHash()).append(",");
if (getArchiveSHA256TreeHash() != null)
sb.append("ArchiveSHA256TreeHash: ").append(getArchiveSHA256TreeHash()).append(",");
if (getRetrievalByteRange() != null)
sb.append("RetrievalByteRange: ").append(getRetrievalByteRange()).append(",");
if (getTier() != null)
sb.append("Tier: ").append(getTier()).append(",");
if (getInventoryRetrievalParameters() != null)
sb.append("InventoryRetrievalParameters: ").append(getInventoryRetrievalParameters()).append(",");
if (getJobOutputPath() != null)
sb.append("JobOutputPath: ").append(getJobOutputPath()).append(",");
if (getSelectParameters() != null)
sb.append("SelectParameters: ").append(getSelectParameters()).append(",");
if (getOutputLocation() != null)
sb.append("OutputLocation: ").append(getOutputLocation());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GlacierJobDescription == false)
return false;
GlacierJobDescription other = (GlacierJobDescription) obj;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false)
return false;
if (other.getJobDescription() == null ^ this.getJobDescription() == null)
return false;
if (other.getJobDescription() != null && other.getJobDescription().equals(this.getJobDescription()) == false)
return false;
if (other.getAction() == null ^ this.getAction() == null)
return false;
if (other.getAction() != null && other.getAction().equals(this.getAction()) == false)
return false;
if (other.getArchiveId() == null ^ this.getArchiveId() == null)
return false;
if (other.getArchiveId() != null && other.getArchiveId().equals(this.getArchiveId()) == false)
return false;
if (other.getVaultARN() == null ^ this.getVaultARN() == null)
return false;
if (other.getVaultARN() != null && other.getVaultARN().equals(this.getVaultARN()) == false)
return false;
if (other.getCreationDate() == null ^ this.getCreationDate() == null)
return false;
if (other.getCreationDate() != null && other.getCreationDate().equals(this.getCreationDate()) == false)
return false;
if (other.getCompleted() == null ^ this.getCompleted() == null)
return false;
if (other.getCompleted() != null && other.getCompleted().equals(this.getCompleted()) == false)
return false;
if (other.getStatusCode() == null ^ this.getStatusCode() == null)
return false;
if (other.getStatusCode() != null && other.getStatusCode().equals(this.getStatusCode()) == false)
return false;
if (other.getStatusMessage() == null ^ this.getStatusMessage() == null)
return false;
if (other.getStatusMessage() != null && other.getStatusMessage().equals(this.getStatusMessage()) == false)
return false;
if (other.getArchiveSizeInBytes() == null ^ this.getArchiveSizeInBytes() == null)
return false;
if (other.getArchiveSizeInBytes() != null && other.getArchiveSizeInBytes().equals(this.getArchiveSizeInBytes()) == false)
return false;
if (other.getInventorySizeInBytes() == null ^ this.getInventorySizeInBytes() == null)
return false;
if (other.getInventorySizeInBytes() != null && other.getInventorySizeInBytes().equals(this.getInventorySizeInBytes()) == false)
return false;
if (other.getSNSTopic() == null ^ this.getSNSTopic() == null)
return false;
if (other.getSNSTopic() != null && other.getSNSTopic().equals(this.getSNSTopic()) == false)
return false;
if (other.getCompletionDate() == null ^ this.getCompletionDate() == null)
return false;
if (other.getCompletionDate() != null && other.getCompletionDate().equals(this.getCompletionDate()) == false)
return false;
if (other.getSHA256TreeHash() == null ^ this.getSHA256TreeHash() == null)
return false;
if (other.getSHA256TreeHash() != null && other.getSHA256TreeHash().equals(this.getSHA256TreeHash()) == false)
return false;
if (other.getArchiveSHA256TreeHash() == null ^ this.getArchiveSHA256TreeHash() == null)
return false;
if (other.getArchiveSHA256TreeHash() != null && other.getArchiveSHA256TreeHash().equals(this.getArchiveSHA256TreeHash()) == false)
return false;
if (other.getRetrievalByteRange() == null ^ this.getRetrievalByteRange() == null)
return false;
if (other.getRetrievalByteRange() != null && other.getRetrievalByteRange().equals(this.getRetrievalByteRange()) == false)
return false;
if (other.getTier() == null ^ this.getTier() == null)
return false;
if (other.getTier() != null && other.getTier().equals(this.getTier()) == false)
return false;
if (other.getInventoryRetrievalParameters() == null ^ this.getInventoryRetrievalParameters() == null)
return false;
if (other.getInventoryRetrievalParameters() != null && other.getInventoryRetrievalParameters().equals(this.getInventoryRetrievalParameters()) == false)
return false;
if (other.getJobOutputPath() == null ^ this.getJobOutputPath() == null)
return false;
if (other.getJobOutputPath() != null && other.getJobOutputPath().equals(this.getJobOutputPath()) == false)
return false;
if (other.getSelectParameters() == null ^ this.getSelectParameters() == null)
return false;
if (other.getSelectParameters() != null && other.getSelectParameters().equals(this.getSelectParameters()) == false)
return false;
if (other.getOutputLocation() == null ^ this.getOutputLocation() == null)
return false;
if (other.getOutputLocation() != null && other.getOutputLocation().equals(this.getOutputLocation()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode + ((getJobDescription() == null) ? 0 : getJobDescription().hashCode());
hashCode = prime * hashCode + ((getAction() == null) ? 0 : getAction().hashCode());
hashCode = prime * hashCode + ((getArchiveId() == null) ? 0 : getArchiveId().hashCode());
hashCode = prime * hashCode + ((getVaultARN() == null) ? 0 : getVaultARN().hashCode());
hashCode = prime * hashCode + ((getCreationDate() == null) ? 0 : getCreationDate().hashCode());
hashCode = prime * hashCode + ((getCompleted() == null) ? 0 : getCompleted().hashCode());
hashCode = prime * hashCode + ((getStatusCode() == null) ? 0 : getStatusCode().hashCode());
hashCode = prime * hashCode + ((getStatusMessage() == null) ? 0 : getStatusMessage().hashCode());
hashCode = prime * hashCode + ((getArchiveSizeInBytes() == null) ? 0 : getArchiveSizeInBytes().hashCode());
hashCode = prime * hashCode + ((getInventorySizeInBytes() == null) ? 0 : getInventorySizeInBytes().hashCode());
hashCode = prime * hashCode + ((getSNSTopic() == null) ? 0 : getSNSTopic().hashCode());
hashCode = prime * hashCode + ((getCompletionDate() == null) ? 0 : getCompletionDate().hashCode());
hashCode = prime * hashCode + ((getSHA256TreeHash() == null) ? 0 : getSHA256TreeHash().hashCode());
hashCode = prime * hashCode + ((getArchiveSHA256TreeHash() == null) ? 0 : getArchiveSHA256TreeHash().hashCode());
hashCode = prime * hashCode + ((getRetrievalByteRange() == null) ? 0 : getRetrievalByteRange().hashCode());
hashCode = prime * hashCode + ((getTier() == null) ? 0 : getTier().hashCode());
hashCode = prime * hashCode + ((getInventoryRetrievalParameters() == null) ? 0 : getInventoryRetrievalParameters().hashCode());
hashCode = prime * hashCode + ((getJobOutputPath() == null) ? 0 : getJobOutputPath().hashCode());
hashCode = prime * hashCode + ((getSelectParameters() == null) ? 0 : getSelectParameters().hashCode());
hashCode = prime * hashCode + ((getOutputLocation() == null) ? 0 : getOutputLocation().hashCode());
return hashCode;
}
@Override
public GlacierJobDescription clone() {
try {
return (GlacierJobDescription) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.glacier.model.transform.GlacierJobDescriptionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}