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”.



13736
13737
13738
 
// File 'service/s3/api.go', line 13736


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

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

SetAcceptRanges sets the AcceptRanges field's value.



13741
13742
13743
13744
 
// File 'service/s3/api.go', line 13741


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.



13747
13748
13749
13750
 
// File 'service/s3/api.go', line 13747


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.



13753
13754
13755
13756
 
// File 'service/s3/api.go', line 13753


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.



13759
13760
13761
13762
 
// File 'service/s3/api.go', line 13759


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.



13765
13766
13767
13768
 
// File 'service/s3/api.go', line 13765


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.



13771
13772
13773
13774
 
// File 'service/s3/api.go', line 13771


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.



13777
13778
13779
13780
 
// File 'service/s3/api.go', line 13777


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.



13783
13784
13785
13786
 
// File 'service/s3/api.go', line 13783


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.



13789
13790
13791
13792
 
// File 'service/s3/api.go', line 13789


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.



13795
13796
13797
13798
 
// File 'service/s3/api.go', line 13795


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.



13801
13802
13803
13804
 
// File 'service/s3/api.go', line 13801


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.



13807
13808
13809
13810
 
// File 'service/s3/api.go', line 13807


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.



13813
13814
13815
13816
 
// File 'service/s3/api.go', line 13813


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.



13819
13820
13821
13822
 
// File 'service/s3/api.go', line 13819


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.



13825
13826
13827
13828
 
// File 'service/s3/api.go', line 13825


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.



13831
13832
13833
13834
 
// File 'service/s3/api.go', line 13831


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.



13837
13838
13839
13840
 
// File 'service/s3/api.go', line 13837


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.



13843
13844
13845
13846
 
// File 'service/s3/api.go', line 13843


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.



13849
13850
13851
13852
 
// File 'service/s3/api.go', line 13849


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.



13855
13856
13857
13858
 
// File 'service/s3/api.go', line 13855


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.



13861
13862
13863
13864
 
// File 'service/s3/api.go', line 13861


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.



13867
13868
13869
13870
 
// File 'service/s3/api.go', line 13867


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.



13873
13874
13875
13876
 
// File 'service/s3/api.go', line 13873


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.



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


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.



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


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.



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


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.



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


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.



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


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.



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


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.



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


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.



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


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.



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


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.



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


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.



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


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.



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


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.



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


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”.



13727
13728
13729
 
// File 'service/s3/api.go', line 13727


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