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<String, String>?>? tags, Input<String?>? versionId})
Creates a new GetObjectArgs. bucket Name of the bucket to read the object from. Alternatively, an S3 access point ARN can be specified checksumMode To retrieve the object's checksum, this argument must be ENABLED. If you enable checksumMode and the object is encrypted with KMS, you must have permission to use the kms:Decrypt action. Valid values: ENABLED downloadBody Set to true to always download object data to bodyBase64 attribute. If unset and conditions described above are met, body will be available but bodyBase64 will not be. If set to false, the body is not downloaded and neither body nor bodyBase64 is available, which may improve performance. key Full path to the object inside the bucket range Byte range of the object to retrieve, in the format expected by the HTTP Range header. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. tags Map of tags assigned to the object. versionId Specific 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 enable checksumMode and the object is encrypted with KMS, you must have permission to use the kms:Decrypt action. Valid values: ENABLED
final
downloadBody → Input<String?>?
Set to true to always download object data to bodyBase64 attribute. If unset and conditions described above are met, body will be available but bodyBase64 will not be. If set to false, the body is not downloaded and neither body nor bodyBase64 is 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 Range header.
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
tags → Input<Map<String, String>?>?
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