Package com.pulumi.aws.s3.outputs
Class GetObjectResult
- java.lang.Object
-
- com.pulumi.aws.s3.outputs.GetObjectResult
-
public final class GetObjectResult extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGetObjectResult.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Stringarn()java.lang.Stringbody()java.lang.StringbodyBase64()java.lang.Stringbucket()java.lang.BooleanbucketKeyEnabled()static GetObjectResult.Builderbuilder()static GetObjectResult.Builderbuilder(GetObjectResult defaults)java.lang.StringcacheControl()java.lang.StringchecksumCrc32()java.lang.StringchecksumCrc32c()java.lang.StringchecksumCrc64nvme()java.util.Optional<java.lang.String>checksumMode()java.lang.StringchecksumSha1()java.lang.StringchecksumSha256()java.lang.StringcontentDisposition()java.lang.StringcontentEncoding()java.lang.StringcontentLanguage()java.lang.IntegercontentLength()java.lang.StringcontentType()java.util.Optional<java.lang.String>downloadBody()java.lang.Stringetag()java.lang.Stringexpiration()java.lang.Stringexpires()java.lang.Stringid()java.lang.Stringkey()java.lang.StringlastModified()java.util.Map<java.lang.String,java.lang.String>metadata()java.lang.StringobjectLockLegalHoldStatus()java.lang.StringobjectLockMode()java.lang.StringobjectLockRetainUntilDate()java.util.Optional<java.lang.String>range()java.lang.Stringregion()java.lang.StringserverSideEncryption()java.lang.StringsseKmsKeyId()java.lang.StringstorageClass()java.util.Map<java.lang.String,java.lang.String>tags()java.lang.StringversionId()java.lang.StringwebsiteRedirectLocation()
-
-
-
Method Detail
-
arn
public java.lang.String arn()
- Returns:
- ARN of the object.
-
body
public java.lang.String body()
- Returns:
- Object data (see **limitations above** to understand cases in which this field is actually available). If `downloadBody` is set to `false`, `body` is not available.
-
bodyBase64
public java.lang.String bodyBase64()
- Returns:
- Object data as base64 encoded string. **This is only available if `downloadBody` is set to `true`.**
-
bucket
public java.lang.String bucket()
-
bucketKeyEnabled
public java.lang.Boolean bucketKeyEnabled()
- Returns:
- Whether or not to use [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) for SSE-KMS.
-
cacheControl
public java.lang.String cacheControl()
- Returns:
- Caching behavior along the request/reply chain.
-
checksumCrc32
public java.lang.String checksumCrc32()
- Returns:
- Base64-encoded, 32-bit CRC32 checksum of the object.
-
checksumCrc32c
public java.lang.String checksumCrc32c()
- Returns:
- Base64-encoded, 32-bit CRC32C checksum of the object.
-
checksumCrc64nvme
public java.lang.String checksumCrc64nvme()
- Returns:
- Base64-encoded, 64-bit CRC64NVME checksum of the object.
-
checksumMode
public java.util.Optional<java.lang.String> checksumMode()
-
checksumSha1
public java.lang.String checksumSha1()
- Returns:
- Base64-encoded, 160-bit SHA-1 digest of the object.
-
checksumSha256
public java.lang.String checksumSha256()
- Returns:
- Base64-encoded, 256-bit SHA-256 digest of the object.
-
contentDisposition
public java.lang.String contentDisposition()
- Returns:
- Presentational information for the object.
-
contentEncoding
public java.lang.String contentEncoding()
- Returns:
- What content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
-
contentLanguage
public java.lang.String contentLanguage()
- Returns:
- Language the content is in.
-
contentLength
public java.lang.Integer contentLength()
- Returns:
- Size of the body in bytes.
-
contentType
public java.lang.String contentType()
- Returns:
- Standard MIME type describing the format of the object data.
-
downloadBody
public java.util.Optional<java.lang.String> downloadBody()
-
etag
public java.lang.String etag()
- Returns:
- [ETag](https://en.wikipedia.org/wiki/HTTP_ETag) generated for the object (an MD5 sum of the object content in case it's not encrypted)
-
expiration
public java.lang.String expiration()
- Returns:
- If the object expiration is configured (see [object lifecycle management](http://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html)), the field includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.
-
expires
public java.lang.String expires()
- Returns:
- Date and time at which the object is no longer cacheable.
-
id
public java.lang.String id()
- Returns:
- The provider-assigned unique ID for this managed resource.
-
key
public java.lang.String key()
-
lastModified
public java.lang.String lastModified()
- Returns:
- Last modified date of the object in RFC1123 format (e.g., `Mon, 02 Jan 2006 15:04:05 MST`)
-
metadata
public java.util.Map<java.lang.String,java.lang.String> metadata()
- Returns:
- Map of metadata stored with the object in S3. Keys are always returned in lowercase.
-
objectLockLegalHoldStatus
public java.lang.String objectLockLegalHoldStatus()
- Returns:
- Whether this object has an active [legal hold](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-legal-holds). This field is only returned if you have permission to view an object's legal hold status.
-
objectLockMode
public java.lang.String objectLockMode()
- Returns:
- Object lock [retention mode](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-retention-modes) currently in place for this object.
-
objectLockRetainUntilDate
public java.lang.String objectLockRetainUntilDate()
- Returns:
- Date and time when this object's object lock will expire.
-
range
public java.util.Optional<java.lang.String> range()
-
region
public java.lang.String region()
-
serverSideEncryption
public java.lang.String serverSideEncryption()
- Returns:
- If the object is stored using server-side encryption (KMS or Amazon S3-managed encryption key), this field includes the chosen encryption and algorithm used.
-
sseKmsKeyId
public java.lang.String sseKmsKeyId()
- Returns:
- If present, specifies the ID of the KMS master encryption key that was used for the object.
-
storageClass
public java.lang.String storageClass()
- Returns:
- [Storage class](http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) information of the object. Available for all objects except for `Standard` storage class objects.
-
tags
public java.util.Map<java.lang.String,java.lang.String> tags()
- Returns:
- Map of tags assigned to the object.
-
versionId
public java.lang.String versionId()
- Returns:
- Latest version ID of the object returned.
-
websiteRedirectLocation
public java.lang.String websiteRedirectLocation()
- Returns:
- If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
-
builder
public static GetObjectResult.Builder builder()
-
builder
public static GetObjectResult.Builder builder(GetObjectResult defaults)
-
-