GetObjectArgs class
Arguments for getObject. Arguments for getObject.
Constructors
-
GetObjectArgs({required Input<
String> bucket, Input<String?> ? checksumMode, Input<String?> ? downloadBody, required Input<String> key, Input<String?> ? range, Input<String?> ? region, Input<Map< ? tags, Input<String, String> ?>String?> ? versionId}) -
Creates a new GetObjectArgs.
bucketName of the bucket to read the object from. Alternatively, an S3 access point ARN can be specifiedchecksumModeTo retrieve the object's checksum, this argument must beENABLED. If you enablechecksumModeand the object is encrypted with KMS, you must have permission to use thekms:Decryptaction. Valid values:ENABLEDdownloadBodySet totrueto always download object data tobodyBase64attribute. If unset and conditions described above are met,bodywill be available butbodyBase64will not be. If set tofalse, the body is not downloaded and neitherbodynorbodyBase64is available, which may improve performance.keyFull path to the object inside the bucketrangeByte range of the object to retrieve, in the format expected by the HTTPRangeheader.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.tagsMap of tags assigned to the object.versionIdSpecific version ID of the object returned (defaults to latest version)const -
GetObjectArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
bucket
→ Input<
String> -
Name of the bucket to read the object from. Alternatively, an S3 access point ARN can be specified
final
-
checksumMode
→ Input<
String?> ? -
To retrieve the object's checksum, this argument must be
ENABLED. If you enablechecksumModeand the object is encrypted with KMS, you must have permission to use thekms:Decryptaction. Valid values:ENABLEDfinal -
downloadBody
→ Input<
String?> ? -
Set to
trueto always download object data tobodyBase64attribute. If unset and conditions described above are met,bodywill be available butbodyBase64will not be. If set tofalse, the body is not downloaded and neitherbodynorbodyBase64is available, which may improve performance.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
key
→ Input<
String> -
Full path to the object inside the bucket
final
-
range
→ Input<
String?> ? -
Byte range of the object to retrieve, in the format expected by the HTTP
Rangeheader.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Map of tags assigned to the object.
final
-
versionId
→ Input<
String?> ? -
Specific version ID of the object returned (defaults to latest version)
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited