Package | Description |
---|---|
software.amazon.awssdk.services.s3 |
|
software.amazon.awssdk.services.s3.model | |
software.amazon.awssdk.services.s3.waiters |
Modifier and Type | Method and Description |
---|---|
default HeadObjectResponse |
S3Client.headObject(Consumer<HeadObjectRequest.Builder> headObjectRequest)
The HEAD action retrieves metadata from an object without returning the object itself.
|
default CompletableFuture<HeadObjectResponse> |
S3AsyncClient.headObject(Consumer<HeadObjectRequest.Builder> headObjectRequest)
The HEAD action retrieves metadata from an object without returning the object itself.
|
Modifier and Type | Method and Description |
---|---|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.bucket(String bucket)
The name of the bucket containing the object.
|
static HeadObjectRequest.Builder |
HeadObjectRequest.builder() |
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.checksumMode(ChecksumMode checksumMode)
To retrieve the checksum, this parameter must be enabled.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.checksumMode(String checksumMode)
To retrieve the checksum, this parameter must be enabled.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.ifMatch(String ifMatch)
Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412
(precondition failed) error.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.ifModifiedSince(Instant ifModifiedSince)
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not
modified) error.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.ifNoneMatch(String ifNoneMatch)
Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304
(not modified) error.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.ifUnmodifiedSince(Instant ifUnmodifiedSince)
Return the object only if it has not been modified since the specified time; otherwise, return a 412
(precondition failed) error.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.key(String key)
The object key.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.partNumber(Integer partNumber)
Part number of the object being read.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.range(String range)
Because
HeadObject returns only the metadata for an object, this parameter has no effect. |
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use to when encrypting the object (for example, AES256).
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.sseCustomerKey(String sseCustomerKey)
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
|
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.sseCustomerKeyMD5(String sseCustomerKeyMD5)
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
HeadObjectRequest.Builder |
HeadObjectRequest.toBuilder() |
HeadObjectRequest.Builder |
HeadObjectRequest.Builder.versionId(String versionId)
VersionId used to reference a specific version of the object.
|
Modifier and Type | Method and Description |
---|---|
static Class<? extends HeadObjectRequest.Builder> |
HeadObjectRequest.serializableBuilderClass() |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<WaiterResponse<HeadObjectResponse>> |
S3AsyncWaiter.waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)
Polls
S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists is met, or until it
is determined that the resource will never enter into the desired state. |
default WaiterResponse<HeadObjectResponse> |
S3Waiter.waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)
Polls
S3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists is met, or until it is
determined that the resource will never enter into the desired state. |
default CompletableFuture<WaiterResponse<HeadObjectResponse>> |
S3AsyncWaiter.waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest,
Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
Polls
S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists is met, or until it
is determined that the resource will never enter into the desired state. |
default WaiterResponse<HeadObjectResponse> |
S3Waiter.waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest,
Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
Polls
S3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists is met, or until it is
determined that the resource will never enter into the desired state. |
default CompletableFuture<WaiterResponse<HeadObjectResponse>> |
S3AsyncWaiter.waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)
Polls
S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists is met, or until
it is determined that the resource will never enter into the desired state. |
default WaiterResponse<HeadObjectResponse> |
S3Waiter.waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)
Polls
S3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists is met, or until it is
determined that the resource will never enter into the desired state. |
default CompletableFuture<WaiterResponse<HeadObjectResponse>> |
S3AsyncWaiter.waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest,
Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
Polls
S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists is met, or until
it is determined that the resource will never enter into the desired state. |
default WaiterResponse<HeadObjectResponse> |
S3Waiter.waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest,
Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
Polls
S3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists is met, or until it is
determined that the resource will never enter into the desired state. |
Copyright © 2023. All rights reserved.