Class GetJobOutputResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.glacier.model.GlacierResponse
-
- software.amazon.awssdk.services.glacier.model.GetJobOutputResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetJobOutputResponse.Builder,GetJobOutputResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetJobOutputResponse extends GlacierResponse implements ToCopyableBuilder<GetJobOutputResponse.Builder,GetJobOutputResponse>
Contains the Amazon S3 Glacier response to your request.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetJobOutputResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringacceptRanges()Indicates the range units accepted.StringarchiveDescription()The description of an archive.static GetJobOutputResponse.Builderbuilder()Stringchecksum()The checksum of the data in the response.StringcontentRange()The range of bytes returned by Amazon S3 Glacier.StringcontentType()The Content-Type depends on whether the job output is an archive or a vault inventory.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GetJobOutputResponse.Builder>serializableBuilderClass()Integerstatus()The HTTP response code for a job output request.GetJobOutputResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.glacier.model.GlacierResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
checksum
public final String 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:
- 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.
-
-
-
status
public final Integer status()
The HTTP response code for a job output request. The value depends on whether a range was specified in the request.
- Returns:
- The HTTP response code for a job output request. The value depends on whether a range was specified in the request.
-
contentRange
public final String contentRange()
The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.
- Returns:
- The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.
-
acceptRanges
public final String acceptRanges()
Indicates the range units accepted. For more information, see RFC2616.
- Returns:
- Indicates the range units accepted. For more information, see RFC2616.
-
contentType
public final String 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:
- 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.
-
archiveDescription
public final String archiveDescription()
The description of an archive.
- Returns:
- The description of an archive.
-
toBuilder
public GetJobOutputResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetJobOutputResponse.Builder,GetJobOutputResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetJobOutputResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetJobOutputResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-