HeadObjectRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`HeadObjectRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`bucket()` The name of the bucket containing the object.
`static HeadObjectRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`expectedBucketOwner()` The account id of the expected bucket owner.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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()` The object key.
`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 (for example, 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()`
`String`	`toString()` Returns a string representation of this object.
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - bucket
```
public String bucket()
```
    The name of the bucket containing the object.
    
    Returns:
    
    The name of the bucket containing the 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()
```
    The object key.
    
    Returns:
    
    The object key.
  - range
```
public String range()
```
    Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
    
    Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
    
    Returns:
    
    Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
    
    Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
  - 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 (for example, AES256).
    
    Returns:
    
    Specifies the algorithm to use to when encrypting the object (for example, 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 S3 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 S3 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 that 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 that 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.
  - expectedBucketOwner
```
public String expectedBucketOwner()
```
    The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
    
    Returns:
    
    The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
  - toBuilder
```
public HeadObjectRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>
    
    Specified by:
    
    toBuilder in class S3Request
  - builder
```
public static HeadObjectRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends HeadObjectRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class HeadObjectRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

bucket

ifMatch

ifModifiedSince

ifNoneMatch

ifUnmodifiedSince

key

range

versionId

sseCustomerAlgorithm

sseCustomerKey

sseCustomerKeyMD5

requestPayer

requestPayerAsString

partNumber

expectedBucketOwner

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields