Struct: s3.GetObjectOutput

import "../ibm-cos-sdk-go/service/s3"

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary collapse

Service Operations collapse

Structure Field Details

AcceptRanges *string `location:"header" locationName:"accept-ranges" type:"string"`

Indicates that a range of bytes was specified.

Body io.ReadCloser `type:"blob"`

Object data.

CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

Specifies caching behavior along the request/reply chain.

ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"`

Specifies presentational information for the object.

ContentEncoding *string `location:"header" locationName:"Content-Encoding" type:"string"`

Specifies 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 *string `location:"header" locationName:"Content-Language" type:"string"`

The language the content is in.

ContentLength *int64 `location:"header" locationName:"Content-Length" type:"long"`

Size of the body in bytes.

ContentRange *string `location:"header" locationName:"Content-Range" type:"string"`

The portion of the object returned in the response.

ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

A standard MIME type describing the format of the object data.

DeleteMarker *bool `location:"header" locationName:"x-amz-delete-marker" type:"boolean"`

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

ETag *string `location:"header" locationName:"ETag" type:"string"`

An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

Expiration *string `location:"header" locationName:"x-amz-expiration" type:"string"`

If the object expiration is configured (see PUT Bucket lifecycle), the response 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 *string `location:"header" locationName:"Expires" type:"string"`

The date and time at which the object is no longer cacheable.

IBMRestoredCopyStorageClass *string `location:"header" locationName:"x-ibm-restored-copy-storage-class" type:"string" enum:"StorageClass"`

IBMTransition *string `location:"header" locationName:"x-ibm-transition" type:"string"`

This header is only included if an object has transition metadata. This header will indicate the transition storage class and time of transition. If this header and the x-amz-restore header are both included, this header will indicate the time at which the object was originally archived.

LastModified *time.Time `location:"header" locationName:"Last-Modified" type:"timestamp"`

Creation date of the object.

Metadata map[string]*string `location:"headers" locationName:"x-amz-meta-" type:"map"`

A map of metadata to store with the object in S3.

By default unmarshaled keys are written as a map keys in following canonicalized format: the first letter and any letter following a hyphen will be capitalized, and the rest as lowercase. Set aws.Config.LowerCaseHeaderMaps to true to write unmarshaled keys to the map as lowercase.

MissingMeta *int64 `location:"header" locationName:"x-amz-missing-meta" type:"integer"`

This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

ObjectLockLegalHoldStatus *string `location:"header" locationName:"x-amz-object-lock-legal-hold" type:"string" enum:"ObjectLockLegalHoldStatus"`

Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object’s legal hold status.

ObjectLockMode *string `location:"header" locationName:"x-amz-object-lock-mode" type:"string" enum:"ObjectLockMode"`

The Object Lock mode currently in place for this object.

ObjectLockRetainUntilDate *time.Time `location:"header" locationName:"x-amz-object-lock-retain-until-date" type:"timestamp" timestampFormat:"iso8601"`

The date and time when this object’s Object Lock will expire.

PartsCount *int64 `location:"header" locationName:"x-amz-mp-parts-count" type:"integer"`

The count of parts this object has.

ReplicationStatus *string `location:"header" locationName:"x-amz-replication-status" type:"string" enum:"ReplicationStatus"`

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

RequestCharged *string `location:"header" locationName:"x-amz-request-charged" type:"string" enum:"RequestCharged"`

If present, indicates that the requester was successfully charged for the request.

Restore *string `location:"header" locationName:"x-amz-restore" type:"string"`

Provides information about object restoration action and expiration time of the restored object copy.

RetentionExpirationDate *time.Time `location:"header" locationName:"Retention-Expiration-Date" type:"timestamp"`

Date on which it will be legal to delete or modify the object. You can only specify this or the Retention-Period header. If both are specified a 400 error will be returned. If neither is specified the bucket’s DefaultRetention period will be used.

RetentionLegalHoldCount *int64 `location:"header" locationName:"Retention-Legal-Hold-Count" type:"integer"`

RetentionPeriod *int64 `location:"header" locationName:"Retention-Period" type:"integer"`

Retention period to store on the object in seconds. If this field and Retention-Expiration-Date are specified a 400 error is returned. If neither is specified the bucket’s DefaultRetention period will be used. 0 is a legal value assuming the bucket’s minimum retention period is also 0.

SSECustomerAlgorithm *string `location:"header" locationName:"x-amz-server-side-encryption-customer-algorithm" type:"string"`

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

SSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-server-side-encryption-customer-key-MD5" type:"string"`

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

SSEKMSKeyId *string `location:"header" locationName:"x-amz-server-side-encryption-aws-kms-key-id" type:"string" sensitive:"true"`

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

SSEKMSKeyId is a sensitive parameter and its value will be replaced with “sensitive” in string returned by GetObjectOutput’s String and GoString methods.

ServerSideEncryption *string `location:"header" locationName:"x-amz-server-side-encryption" type:"string" enum:"ServerSideEncryption"`

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

StorageClass *string `location:"header" locationName:"x-amz-storage-class" type:"string" enum:"StorageClass"`

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

TagCount *int64 `location:"header" locationName:"x-amz-tagging-count" type:"integer"`

The number of tags, if any, on the object.

VersionId *string `location:"header" locationName:"x-amz-version-id" type:"string"`

Version of the object.

WebsiteRedirectLocation *string `location:"header" locationName:"x-amz-website-redirect-location" type:"string"`

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.

_ struct{} `type:"structure" payload:"Body"`

Method Details

func (s GetObjectOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.



13887
13888
13889
 
// File 'service/s3/api.go', line 13887


func (s GetObjectOutput) GoString() string {
	return s.String()
}

func (s *GetObjectOutput) SetAcceptRanges(v string) *GetObjectOutput

SetAcceptRanges sets the AcceptRanges field’s value.



13892
13893
13894
13895
 
// File 'service/s3/api.go', line 13892


func (s *GetObjectOutput) SetAcceptRanges(v string) *GetObjectOutput {
	s.AcceptRanges = &v
	return s
}

func (s *GetObjectOutput) SetBody(v io.ReadCloser) *GetObjectOutput

SetBody sets the Body field’s value.



13898
13899
13900
13901
 
// File 'service/s3/api.go', line 13898


func (s *GetObjectOutput) SetBody(v io.ReadCloser) *GetObjectOutput {
	s.Body = v
	return s
}

func (s *GetObjectOutput) SetCacheControl(v string) *GetObjectOutput

SetCacheControl sets the CacheControl field’s value.



13904
13905
13906
13907
 
// File 'service/s3/api.go', line 13904


func (s *GetObjectOutput) SetCacheControl(v string) *GetObjectOutput {
	s.CacheControl = &v
	return s
}

func (s *GetObjectOutput) SetContentDisposition(v string) *GetObjectOutput

SetContentDisposition sets the ContentDisposition field’s value.



13910
13911
13912
13913
 
// File 'service/s3/api.go', line 13910


func (s *GetObjectOutput) SetContentDisposition(v string) *GetObjectOutput {
	s.ContentDisposition = &v
	return s
}

func (s *GetObjectOutput) SetContentEncoding(v string) *GetObjectOutput

SetContentEncoding sets the ContentEncoding field’s value.



13916
13917
13918
13919
 
// File 'service/s3/api.go', line 13916


func (s *GetObjectOutput) SetContentEncoding(v string) *GetObjectOutput {
	s.ContentEncoding = &v
	return s
}

func (s *GetObjectOutput) SetContentLanguage(v string) *GetObjectOutput

SetContentLanguage sets the ContentLanguage field’s value.



13922
13923
13924
13925
 
// File 'service/s3/api.go', line 13922


func (s *GetObjectOutput) SetContentLanguage(v string) *GetObjectOutput {
	s.ContentLanguage = &v
	return s
}

func (s *GetObjectOutput) SetContentLength(v int64) *GetObjectOutput

SetContentLength sets the ContentLength field’s value.



13928
13929
13930
13931
 
// File 'service/s3/api.go', line 13928


func (s *GetObjectOutput) SetContentLength(v int64) *GetObjectOutput {
	s.ContentLength = &v
	return s
}

func (s *GetObjectOutput) SetContentRange(v string) *GetObjectOutput

SetContentRange sets the ContentRange field’s value.



13934
13935
13936
13937
 
// File 'service/s3/api.go', line 13934


func (s *GetObjectOutput) SetContentRange(v string) *GetObjectOutput {
	s.ContentRange = &v
	return s
}

func (s *GetObjectOutput) SetContentType(v string) *GetObjectOutput

SetContentType sets the ContentType field’s value.



13940
13941
13942
13943
 
// File 'service/s3/api.go', line 13940


func (s *GetObjectOutput) SetContentType(v string) *GetObjectOutput {
	s.ContentType = &v
	return s
}

func (s *GetObjectOutput) SetDeleteMarker(v bool) *GetObjectOutput

SetDeleteMarker sets the DeleteMarker field’s value.



13946
13947
13948
13949
 
// File 'service/s3/api.go', line 13946


func (s *GetObjectOutput) SetDeleteMarker(v bool) *GetObjectOutput {
	s.DeleteMarker = &v
	return s
}

func (s *GetObjectOutput) SetETag(v string) *GetObjectOutput

SetETag sets the ETag field’s value.



13952
13953
13954
13955
 
// File 'service/s3/api.go', line 13952


func (s *GetObjectOutput) SetETag(v string) *GetObjectOutput {
	s.ETag = &v
	return s
}

func (s *GetObjectOutput) SetExpiration(v string) *GetObjectOutput

SetExpiration sets the Expiration field’s value.



13958
13959
13960
13961
 
// File 'service/s3/api.go', line 13958


func (s *GetObjectOutput) SetExpiration(v string) *GetObjectOutput {
	s.Expiration = &v
	return s
}

func (s *GetObjectOutput) SetExpires(v string) *GetObjectOutput

SetExpires sets the Expires field’s value.



13964
13965
13966
13967
 
// File 'service/s3/api.go', line 13964


func (s *GetObjectOutput) SetExpires(v string) *GetObjectOutput {
	s.Expires = &v
	return s
}

func (s *GetObjectOutput) SetIBMRestoredCopyStorageClass(v string) *GetObjectOutput

SetIBMRestoredCopyStorageClass sets the IBMRestoredCopyStorageClass field’s value.



13970
13971
13972
13973
 
// File 'service/s3/api.go', line 13970


func (s *GetObjectOutput) SetIBMRestoredCopyStorageClass(v string) *GetObjectOutput {
	s.IBMRestoredCopyStorageClass = &v
	return s
}

func (s *GetObjectOutput) SetIBMTransition(v string) *GetObjectOutput

SetIBMTransition sets the IBMTransition field’s value.



13976
13977
13978
13979
 
// File 'service/s3/api.go', line 13976


func (s *GetObjectOutput) SetIBMTransition(v string) *GetObjectOutput {
	s.IBMTransition = &v
	return s
}

func (s *GetObjectOutput) SetLastModified(v time.Time) *GetObjectOutput

SetLastModified sets the LastModified field’s value.



13982
13983
13984
13985
 
// File 'service/s3/api.go', line 13982


func (s *GetObjectOutput) SetLastModified(v time.Time) *GetObjectOutput {
	s.LastModified = &v
	return s
}

func (s *GetObjectOutput) SetMetadata(v map[string]*string) *GetObjectOutput

SetMetadata sets the Metadata field’s value.



13988
13989
13990
13991
 
// File 'service/s3/api.go', line 13988


func (s *GetObjectOutput) SetMetadata(v map[string]*string) *GetObjectOutput {
	s.Metadata = v
	return s
}

func (s *GetObjectOutput) SetMissingMeta(v int64) *GetObjectOutput

SetMissingMeta sets the MissingMeta field’s value.



13994
13995
13996
13997
 
// File 'service/s3/api.go', line 13994


func (s *GetObjectOutput) SetMissingMeta(v int64) *GetObjectOutput {
	s.MissingMeta = &v
	return s
}

func (s *GetObjectOutput) SetObjectLockLegalHoldStatus(v string) *GetObjectOutput

SetObjectLockLegalHoldStatus sets the ObjectLockLegalHoldStatus field’s value.



14000
14001
14002
14003
 
// File 'service/s3/api.go', line 14000


func (s *GetObjectOutput) SetObjectLockLegalHoldStatus(v string) *GetObjectOutput {
	s.ObjectLockLegalHoldStatus = &v
	return s
}

func (s *GetObjectOutput) SetObjectLockMode(v string) *GetObjectOutput

SetObjectLockMode sets the ObjectLockMode field’s value.



14006
14007
14008
14009
 
// File 'service/s3/api.go', line 14006


func (s *GetObjectOutput) SetObjectLockMode(v string) *GetObjectOutput {
	s.ObjectLockMode = &v
	return s
}

func (s *GetObjectOutput) SetObjectLockRetainUntilDate(v time.Time) *GetObjectOutput

SetObjectLockRetainUntilDate sets the ObjectLockRetainUntilDate field’s value.



14012
14013
14014
14015
 
// File 'service/s3/api.go', line 14012


func (s *GetObjectOutput) SetObjectLockRetainUntilDate(v time.Time) *GetObjectOutput {
	s.ObjectLockRetainUntilDate = &v
	return s
}

func (s *GetObjectOutput) SetPartsCount(v int64) *GetObjectOutput

SetPartsCount sets the PartsCount field’s value.



14018
14019
14020
14021
 
// File 'service/s3/api.go', line 14018


func (s *GetObjectOutput) SetPartsCount(v int64) *GetObjectOutput {
	s.PartsCount = &v
	return s
}

func (s *GetObjectOutput) SetReplicationStatus(v string) *GetObjectOutput

SetReplicationStatus sets the ReplicationStatus field’s value.



14024
14025
14026
14027
 
// File 'service/s3/api.go', line 14024


func (s *GetObjectOutput) SetReplicationStatus(v string) *GetObjectOutput {
	s.ReplicationStatus = &v
	return s
}

func (s *GetObjectOutput) SetRequestCharged(v string) *GetObjectOutput

SetRequestCharged sets the RequestCharged field’s value.



14030
14031
14032
14033
 
// File 'service/s3/api.go', line 14030


func (s *GetObjectOutput) SetRequestCharged(v string) *GetObjectOutput {
	s.RequestCharged = &v
	return s
}

func (s *GetObjectOutput) SetRestore(v string) *GetObjectOutput

SetRestore sets the Restore field’s value.



14036
14037
14038
14039
 
// File 'service/s3/api.go', line 14036


func (s *GetObjectOutput) SetRestore(v string) *GetObjectOutput {
	s.Restore = &v
	return s
}

func (s *GetObjectOutput) SetRetentionExpirationDate(v time.Time) *GetObjectOutput

SetRetentionExpirationDate sets the RetentionExpirationDate field’s value.



14042
14043
14044
14045
 
// File 'service/s3/api.go', line 14042


func (s *GetObjectOutput) SetRetentionExpirationDate(v time.Time) *GetObjectOutput {
	s.RetentionExpirationDate = &v
	return s
}

func (s *GetObjectOutput) SetRetentionLegalHoldCount(v int64) *GetObjectOutput

SetRetentionLegalHoldCount sets the RetentionLegalHoldCount field’s value.



14048
14049
14050
14051
 
// File 'service/s3/api.go', line 14048


func (s *GetObjectOutput) SetRetentionLegalHoldCount(v int64) *GetObjectOutput {
	s.RetentionLegalHoldCount = &v
	return s
}

func (s *GetObjectOutput) SetRetentionPeriod(v int64) *GetObjectOutput

SetRetentionPeriod sets the RetentionPeriod field’s value.



14054
14055
14056
14057
 
// File 'service/s3/api.go', line 14054


func (s *GetObjectOutput) SetRetentionPeriod(v int64) *GetObjectOutput {
	s.RetentionPeriod = &v
	return s
}

func (s *GetObjectOutput) SetServerSideEncryption(v string) *GetObjectOutput

SetServerSideEncryption sets the ServerSideEncryption field’s value.



14078
14079
14080
14081
 
// File 'service/s3/api.go', line 14078


func (s *GetObjectOutput) SetServerSideEncryption(v string) *GetObjectOutput {
	s.ServerSideEncryption = &v
	return s
}

func (s *GetObjectOutput) SetSSECustomerAlgorithm(v string) *GetObjectOutput

SetSSECustomerAlgorithm sets the SSECustomerAlgorithm field’s value.



14060
14061
14062
14063
 
// File 'service/s3/api.go', line 14060


func (s *GetObjectOutput) SetSSECustomerAlgorithm(v string) *GetObjectOutput {
	s.SSECustomerAlgorithm = &v
	return s
}

func (s *GetObjectOutput) SetSSECustomerKeyMD5(v string) *GetObjectOutput

SetSSECustomerKeyMD5 sets the SSECustomerKeyMD5 field’s value.



14066
14067
14068
14069
 
// File 'service/s3/api.go', line 14066


func (s *GetObjectOutput) SetSSECustomerKeyMD5(v string) *GetObjectOutput {
	s.SSECustomerKeyMD5 = &v
	return s
}

func (s *GetObjectOutput) SetSSEKMSKeyId(v string) *GetObjectOutput

SetSSEKMSKeyId sets the SSEKMSKeyId field’s value.



14072
14073
14074
14075
 
// File 'service/s3/api.go', line 14072


func (s *GetObjectOutput) SetSSEKMSKeyId(v string) *GetObjectOutput {
	s.SSEKMSKeyId = &v
	return s
}

func (s *GetObjectOutput) SetStorageClass(v string) *GetObjectOutput

SetStorageClass sets the StorageClass field’s value.



14084
14085
14086
14087
 
// File 'service/s3/api.go', line 14084


func (s *GetObjectOutput) SetStorageClass(v string) *GetObjectOutput {
	s.StorageClass = &v
	return s
}

func (s *GetObjectOutput) SetTagCount(v int64) *GetObjectOutput

SetTagCount sets the TagCount field’s value.



14090
14091
14092
14093
 
// File 'service/s3/api.go', line 14090


func (s *GetObjectOutput) SetTagCount(v int64) *GetObjectOutput {
	s.TagCount = &v
	return s
}

func (s *GetObjectOutput) SetVersionId(v string) *GetObjectOutput

SetVersionId sets the VersionId field’s value.



14096
14097
14098
14099
 
// File 'service/s3/api.go', line 14096


func (s *GetObjectOutput) SetVersionId(v string) *GetObjectOutput {
	s.VersionId = &v
	return s
}

func (s *GetObjectOutput) SetWebsiteRedirectLocation(v string) *GetObjectOutput

SetWebsiteRedirectLocation sets the WebsiteRedirectLocation field’s value.



14102
14103
14104
14105
 
// File 'service/s3/api.go', line 14102


func (s *GetObjectOutput) SetWebsiteRedirectLocation(v string) *GetObjectOutput {
	s.WebsiteRedirectLocation = &v
	return s
}

func (s GetObjectOutput) String() string

String returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.



13878
13879
13880
 
// File 'service/s3/api.go', line 13878


func (s GetObjectOutput) String() string {
	return awsutil.Prettify(s)
}