Interface GetObjectAnnotationRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<GetObjectAnnotationRequest.Builder,,GetObjectAnnotationRequest> S3Request.Builder,SdkBuilder<GetObjectAnnotationRequest.Builder,,GetObjectAnnotationRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
GetObjectAnnotationRequest
@Mutable
@NotThreadSafe
public static interface GetObjectAnnotationRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<GetObjectAnnotationRequest.Builder,GetObjectAnnotationRequest>
-
Method Summary
Modifier and TypeMethodDescriptionannotationName(String annotationName) The name of the annotation to retrieve.The name of the bucket that contains the object.checksumMode(String checksumMode) Set toENABLEDto validate the checksum of the annotation payload on retrieval.checksumMode(ChecksumMode checksumMode) Set toENABLEDto validate the checksum of the annotation payload on retrieval.expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.The object key.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.The version ID of the object.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
bucket
The name of the bucket that contains the object.
- Parameters:
bucket- The name of the bucket that contains the object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
key
The object key.
- Parameters:
key- The object key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
annotationName
The name of the annotation to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 512 bytes.
- Parameters:
annotationName- The name of the annotation to retrieve.Length Constraints: Minimum length of 1. Maximum length of 512 bytes.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionId
The version ID of the object.
- Parameters:
versionId- The version ID of the object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestPayer
Sets the value of the RequestPayer property for this object.- Parameters:
requestPayer- The new value for the RequestPayer property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
requestPayer
Sets the value of the RequestPayer property for this object.- Parameters:
requestPayer- The new value for the RequestPayer property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
expectedBucketOwner
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error.
- Parameters:
expectedBucketOwner- The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
checksumMode
Set to
ENABLEDto validate the checksum of the annotation payload on retrieval.- Parameters:
checksumMode- Set toENABLEDto validate the checksum of the annotation payload on retrieval.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
checksumMode
Set to
ENABLEDto validate the checksum of the annotation payload on retrieval.- Parameters:
checksumMode- Set toENABLEDto validate the checksum of the annotation payload on retrieval.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
GetObjectAnnotationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetObjectAnnotationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-