software.amazon.awssdk.services.s3.model

Class HeadObjectRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.s3.model.S3Request

software.amazon.awssdk.services.s3.model.HeadObjectRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class HeadObjectRequest
extends S3Request
implements ToCopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HeadObjectRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() Returns the value of the Bucket property for this object.
static HeadObjectRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	ifMatch() Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
Instant	ifModifiedSince() Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
String	ifNoneMatch() Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
Instant	ifUnmodifiedSince() Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
String	key() Returns the value of the Key property for this object.
Integer	partNumber() Part number of the object being read.
String	range() Downloads the specified range bytes of an object.
RequestPayer	requestPayer() Returns the value of the RequestPayer property for this object.
String	requestPayerAsString() Returns the value of the RequestPayer property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends HeadObjectRequest.Builder>	serializableBuilderClass()
String	sseCustomerAlgorithm() Specifies the algorithm to use to when encrypting the object (e.g., AES256).
String	sseCustomerKey() Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
String	sseCustomerKeyMD5() Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
HeadObjectRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	versionId() VersionId used to reference a specific version of the object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

bucket

public String bucket()

Returns the value of the Bucket property for this object.

Returns:

The value of the Bucket property for this object.

ifMatch

public String ifMatch()

Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

Returns:

Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

ifModifiedSince

public Instant ifModifiedSince()

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

Returns:

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

ifNoneMatch

public String ifNoneMatch()

Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

Returns:

Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

ifUnmodifiedSince

public Instant ifUnmodifiedSince()

Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

Returns:

Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

key

public String key()

Returns the value of the Key property for this object.

Returns:

The value of the Key property for this object.

range

public String range()

Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Returns:

Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

versionId

public String versionId()

VersionId used to reference a specific version of the object.

Returns:

VersionId used to reference a specific version of the object.

sseCustomerAlgorithm

public String sseCustomerAlgorithm()

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

Returns:

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

sseCustomerKey

public String sseCustomerKey()

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

Returns:

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

sseCustomerKeyMD5

public String sseCustomerKeyMD5()

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

Returns:

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

requestPayer

public RequestPayer requestPayer()

Returns the value of the RequestPayer property for this object.

If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

Returns:

The value of the RequestPayer property for this object.

See Also:

RequestPayer

requestPayerAsString

public String requestPayerAsString()

Returns the value of the RequestPayer property for this object.

If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

Returns:

The value of the RequestPayer property for this object.

See Also:

RequestPayer

partNumber

public Integer partNumber()

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

Returns:

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

toBuilder

public HeadObjectRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>

Specified by:

toBuilder in class S3Request

Returns:

a builder for type T

builder

public static HeadObjectRequest.Builder builder()

serializableBuilderClass

public static Class<? extends HeadObjectRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.