com.amazonaws.services.glacier.model.GetJobOutputResult Maven / Gradle / Ivy
/*
* Copyright 2010-2014 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;
/**
*
* Contains the Amazon Glacier response to your request.
*
*/
public class GetJobOutputResult implements Serializable {
/**
* The job data, either archive data or inventory data.
*
* This stream must implement mark/reset in order for signature calculation to be performed
* before this data is read for the request payload.
*/
private java.io.InputStream body;
/**
* The checksum of the data in the response. This header is returned only
* when retrieving the output for an archive retrieval job. Furthermore,
* this header appears only under the following conditions: - You
* get the entire range of the archive.
- You request a range to
* return of the archive that starts and ends on a multiple of 1 MB. For
* example, if you have an 3.1 MB archive and you specify a range to
* return that starts at 1 MB and ends at 2 MB, then the
* x-amz-sha256-tree-hash is returned as a response header.
- You
* request a range of the archive to return that starts on a multiple of
* 1 MB and goes to the end of the archive. For example, if you have a
* 3.1 MB archive and you specify a range that starts at 2 MB and ends at
* 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is
* returned as a response header.
*/
private String checksum;
/**
* The HTTP response code for a job output request. The value depends on
* whether a range was specified in the request.
*/
private Integer status;
/**
* The range of bytes returned by Amazon Glacier. If only partial output
* is downloaded, the response provides the range of bytes Amazon Glacier
* returned. For example, bytes 0-1048575/8388608 returns the first 1 MB
* from 8 MB.
*/
private String contentRange;
/**
* Indicates the range units accepted. For more information, go to RFC2616.
*/
private String acceptRanges;
/**
* The Content-Type depends on whether the job output is an archive or a
* vault inventory. For archive data, the Content-Type is
* application/octet-stream. For vault inventory, if you requested CSV
* format when you initiated the job, the Content-Type is text/csv.
* Otherwise, by default, vault inventory is returned as JSON, and the
* Content-Type is application/json.
*/
private String contentType;
/**
* The description of an archive.
*/
private String archiveDescription;
/**
* The job data, either archive data or inventory data.
*
* This stream must implement mark/reset in order for signature calculation to be performed
* before this data is read for the request payload.
*
* @return The job data, either archive data or inventory data.
*/
public java.io.InputStream getBody() {
return body;
}
/**
* The job data, either archive data or inventory data.
*
* This stream must implement mark/reset in order for signature calculation to be performed
* before this data is read for the request payload.
*
* @param body The job data, either archive data or inventory data.
*/
public void setBody(java.io.InputStream body) {
this.body = body;
}
/**
* The job data, either archive data or inventory data.
*
* This stream must implement mark/reset in order for signature calculation to be performed
* before this data is read for the request payload.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param body The job data, either archive data or inventory data.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public GetJobOutputResult withBody(java.io.InputStream body) {
this.body = body;
return this;
}
/**
* The checksum of the data in the response. This header is returned only
* when retrieving the output for an archive retrieval job. Furthermore,
* this header appears only under the following conditions:
- You
* get the entire range of the archive.
- You request a range to
* return of the archive that starts and ends on a multiple of 1 MB. For
* example, if you have an 3.1 MB archive and you specify a range to
* return that starts at 1 MB and ends at 2 MB, then the
* x-amz-sha256-tree-hash is returned as a response header.
- You
* request a range of the archive to return that starts on a multiple of
* 1 MB and goes to the end of the archive. For example, if you have a
* 3.1 MB archive and you specify a range that starts at 2 MB and ends at
* 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is
* returned as a response header.
*
* @return The checksum of the data in the response. This header is returned only
* when retrieving the output for an archive retrieval job. Furthermore,
* this header appears only under the following conditions: - You
* get the entire range of the archive.
- You request a range to
* return of the archive that starts and ends on a multiple of 1 MB. For
* example, if you have an 3.1 MB archive and you specify a range to
* return that starts at 1 MB and ends at 2 MB, then the
* x-amz-sha256-tree-hash is returned as a response header.
- You
* request a range of the archive to return that starts on a multiple of
* 1 MB and goes to the end of the archive. For example, if you have a
* 3.1 MB archive and you specify a range that starts at 2 MB and ends at
* 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is
* returned as a response header.
*/
public String getChecksum() {
return checksum;
}
/**
* The checksum of the data in the response. This header is returned only
* when retrieving the output for an archive retrieval job. Furthermore,
* this header appears only under the following conditions: - You
* get the entire range of the archive.
- You request a range to
* return of the archive that starts and ends on a multiple of 1 MB. For
* example, if you have an 3.1 MB archive and you specify a range to
* return that starts at 1 MB and ends at 2 MB, then the
* x-amz-sha256-tree-hash is returned as a response header.
- You
* request a range of the archive to return that starts on a multiple of
* 1 MB and goes to the end of the archive. For example, if you have a
* 3.1 MB archive and you specify a range that starts at 2 MB and ends at
* 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is
* returned as a response header.
*
* @param checksum The checksum of the data in the response. This header is returned only
* when retrieving the output for an archive retrieval job. Furthermore,
* this header appears only under the following conditions: - You
* get the entire range of the archive.
- You request a range to
* return of the archive that starts and ends on a multiple of 1 MB. For
* example, if you have an 3.1 MB archive and you specify a range to
* return that starts at 1 MB and ends at 2 MB, then the
* x-amz-sha256-tree-hash is returned as a response header.
- You
* request a range of the archive to return that starts on a multiple of
* 1 MB and goes to the end of the archive. For example, if you have a
* 3.1 MB archive and you specify a range that starts at 2 MB and ends at
* 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is
* returned as a response header.
*/
public void setChecksum(String checksum) {
this.checksum = checksum;
}
/**
* The checksum of the data in the response. This header is returned only
* when retrieving the output for an archive retrieval job. Furthermore,
* this header appears only under the following conditions: - You
* get the entire range of the archive.
- You request a range to
* return of the archive that starts and ends on a multiple of 1 MB. For
* example, if you have an 3.1 MB archive and you specify a range to
* return that starts at 1 MB and ends at 2 MB, then the
* x-amz-sha256-tree-hash is returned as a response header.
- You
* request a range of the archive to return that starts on a multiple of
* 1 MB and goes to the end of the archive. For example, if you have a
* 3.1 MB archive and you specify a range that starts at 2 MB and ends at
* 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is
* returned as a response header.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param checksum The checksum of the data in the response. This header is returned only
* when retrieving the output for an archive retrieval job. Furthermore,
* this header appears only under the following conditions:
- You
* get the entire range of the archive.
- You request a range to
* return of the archive that starts and ends on a multiple of 1 MB. For
* example, if you have an 3.1 MB archive and you specify a range to
* return that starts at 1 MB and ends at 2 MB, then the
* x-amz-sha256-tree-hash is returned as a response header.
- You
* request a range of the archive to return that starts on a multiple of
* 1 MB and goes to the end of the archive. For example, if you have a
* 3.1 MB archive and you specify a range that starts at 2 MB and ends at
* 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is
* returned as a response header.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public GetJobOutputResult withChecksum(String checksum) {
this.checksum = checksum;
return this;
}
/**
* The HTTP response code for a job output request. The value depends on
* whether a range was specified in the request.
*
* @return The HTTP response code for a job output request. The value depends on
* whether a range was specified in the request.
*/
public Integer getStatus() {
return status;
}
/**
* The HTTP response code for a job output request. The value depends on
* whether a range was specified in the request.
*
* @param status The HTTP response code for a job output request. The value depends on
* whether a range was specified in the request.
*/
public void setStatus(Integer status) {
this.status = status;
}
/**
* The HTTP response code for a job output request. The value depends on
* whether a range was specified in the request.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param status The HTTP response code for a job output request. The value depends on
* whether a range was specified in the request.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public GetJobOutputResult withStatus(Integer status) {
this.status = status;
return this;
}
/**
* The range of bytes returned by Amazon Glacier. If only partial output
* is downloaded, the response provides the range of bytes Amazon Glacier
* returned. For example, bytes 0-1048575/8388608 returns the first 1 MB
* from 8 MB.
*
* @return The range of bytes returned by Amazon Glacier. If only partial output
* is downloaded, the response provides the range of bytes Amazon Glacier
* returned. For example, bytes 0-1048575/8388608 returns the first 1 MB
* from 8 MB.
*/
public String getContentRange() {
return contentRange;
}
/**
* The range of bytes returned by Amazon Glacier. If only partial output
* is downloaded, the response provides the range of bytes Amazon Glacier
* returned. For example, bytes 0-1048575/8388608 returns the first 1 MB
* from 8 MB.
*
* @param contentRange The range of bytes returned by Amazon Glacier. If only partial output
* is downloaded, the response provides the range of bytes Amazon Glacier
* returned. For example, bytes 0-1048575/8388608 returns the first 1 MB
* from 8 MB.
*/
public void setContentRange(String contentRange) {
this.contentRange = contentRange;
}
/**
* The range of bytes returned by Amazon Glacier. If only partial output
* is downloaded, the response provides the range of bytes Amazon Glacier
* returned. For example, bytes 0-1048575/8388608 returns the first 1 MB
* from 8 MB.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param contentRange The range of bytes returned by Amazon Glacier. If only partial output
* is downloaded, the response provides the range of bytes Amazon Glacier
* returned. For example, bytes 0-1048575/8388608 returns the first 1 MB
* from 8 MB.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public GetJobOutputResult withContentRange(String contentRange) {
this.contentRange = contentRange;
return this;
}
/**
* Indicates the range units accepted. For more information, go to RFC2616.
*
* @return Indicates the range units accepted. For more information, go to RFC2616.
*/
public String getAcceptRanges() {
return acceptRanges;
}
/**
* Indicates the range units accepted. For more information, go to RFC2616.
*
* @param acceptRanges Indicates the range units accepted. For more information, go to RFC2616.
*/
public void setAcceptRanges(String acceptRanges) {
this.acceptRanges = acceptRanges;
}
/**
* Indicates the range units accepted. For more information, go to RFC2616.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param acceptRanges Indicates the range units accepted. For more information, go to RFC2616.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public GetJobOutputResult withAcceptRanges(String acceptRanges) {
this.acceptRanges = acceptRanges;
return this;
}
/**
* The Content-Type depends on whether the job output is an archive or a
* vault inventory. For archive data, the Content-Type is
* application/octet-stream. For vault inventory, if you requested CSV
* format when you initiated the job, the Content-Type is text/csv.
* Otherwise, by default, vault inventory is returned as JSON, and the
* Content-Type is application/json.
*
* @return The Content-Type depends on whether the job output is an archive or a
* vault inventory. For archive data, the Content-Type is
* application/octet-stream. For vault inventory, if you requested CSV
* format when you initiated the job, the Content-Type is text/csv.
* Otherwise, by default, vault inventory is returned as JSON, and the
* Content-Type is application/json.
*/
public String getContentType() {
return contentType;
}
/**
* The Content-Type depends on whether the job output is an archive or a
* vault inventory. For archive data, the Content-Type is
* application/octet-stream. For vault inventory, if you requested CSV
* format when you initiated the job, the Content-Type is text/csv.
* Otherwise, by default, vault inventory is returned as JSON, and the
* Content-Type is application/json.
*
* @param contentType The Content-Type depends on whether the job output is an archive or a
* vault inventory. For archive data, the Content-Type is
* application/octet-stream. For vault inventory, if you requested CSV
* format when you initiated the job, the Content-Type is text/csv.
* Otherwise, by default, vault inventory is returned as JSON, and the
* Content-Type is application/json.
*/
public void setContentType(String contentType) {
this.contentType = contentType;
}
/**
* The Content-Type depends on whether the job output is an archive or a
* vault inventory. For archive data, the Content-Type is
* application/octet-stream. For vault inventory, if you requested CSV
* format when you initiated the job, the Content-Type is text/csv.
* Otherwise, by default, vault inventory is returned as JSON, and the
* Content-Type is application/json.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param contentType The Content-Type depends on whether the job output is an archive or a
* vault inventory. For archive data, the Content-Type is
* application/octet-stream. For vault inventory, if you requested CSV
* format when you initiated the job, the Content-Type is text/csv.
* Otherwise, by default, vault inventory is returned as JSON, and the
* Content-Type is application/json.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public GetJobOutputResult withContentType(String contentType) {
this.contentType = contentType;
return this;
}
/**
* The description of an archive.
*
* @return The description of an archive.
*/
public String getArchiveDescription() {
return archiveDescription;
}
/**
* The description of an archive.
*
* @param archiveDescription The description of an archive.
*/
public void setArchiveDescription(String archiveDescription) {
this.archiveDescription = archiveDescription;
}
/**
* The description of an archive.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param archiveDescription The description of an archive.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public GetJobOutputResult withArchiveDescription(String archiveDescription) {
this.archiveDescription = archiveDescription;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getBody() != null) sb.append("Body: " + getBody() + ",");
if (getChecksum() != null) sb.append("Checksum: " + getChecksum() + ",");
if (getStatus() != null) sb.append("Status: " + getStatus() + ",");
if (getContentRange() != null) sb.append("ContentRange: " + getContentRange() + ",");
if (getAcceptRanges() != null) sb.append("AcceptRanges: " + getAcceptRanges() + ",");
if (getContentType() != null) sb.append("ContentType: " + getContentType() + ",");
if (getArchiveDescription() != null) sb.append("ArchiveDescription: " + getArchiveDescription() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBody() == null) ? 0 : getBody().hashCode());
hashCode = prime * hashCode + ((getChecksum() == null) ? 0 : getChecksum().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getContentRange() == null) ? 0 : getContentRange().hashCode());
hashCode = prime * hashCode + ((getAcceptRanges() == null) ? 0 : getAcceptRanges().hashCode());
hashCode = prime * hashCode + ((getContentType() == null) ? 0 : getContentType().hashCode());
hashCode = prime * hashCode + ((getArchiveDescription() == null) ? 0 : getArchiveDescription().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof GetJobOutputResult == false) return false;
GetJobOutputResult other = (GetJobOutputResult)obj;
if (other.getBody() == null ^ this.getBody() == null) return false;
if (other.getBody() != null && other.getBody().equals(this.getBody()) == false) return false;
if (other.getChecksum() == null ^ this.getChecksum() == null) return false;
if (other.getChecksum() != null && other.getChecksum().equals(this.getChecksum()) == false) return false;
if (other.getStatus() == null ^ this.getStatus() == null) return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false) return false;
if (other.getContentRange() == null ^ this.getContentRange() == null) return false;
if (other.getContentRange() != null && other.getContentRange().equals(this.getContentRange()) == false) return false;
if (other.getAcceptRanges() == null ^ this.getAcceptRanges() == null) return false;
if (other.getAcceptRanges() != null && other.getAcceptRanges().equals(this.getAcceptRanges()) == false) return false;
if (other.getContentType() == null ^ this.getContentType() == null) return false;
if (other.getContentType() != null && other.getContentType().equals(this.getContentType()) == false) return false;
if (other.getArchiveDescription() == null ^ this.getArchiveDescription() == null) return false;
if (other.getArchiveDescription() != null && other.getArchiveDescription().equals(this.getArchiveDescription()) == false) return false;
return true;
}
}