Struct: s3.HeadObjectOutput

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.

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.

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"`

Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock (docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).

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

The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock (docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).

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

The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

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 header if your request involves a bucket that is either a source or a destination in a replication rule.

In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

  • If requesting an object from the source bucket — Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication. For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

  • If requesting an object from a destination bucket — Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

  • When replicating objects to multiple destination buckets the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

For more information, see Replication (docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).

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"`

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject (docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request=“false”, expiry-date=“Fri, 21 Dec 2012 00:00:00 GMT”

If the object restoration is in progress, the header returns the value ongoing-request=“true”.

For more information about archiving objects, see Transitioning Objects: General Considerations (docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations).

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 HeadObjectOutput'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.

For more information, see Storage Classes (docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html).

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"`

Method Details

func (s HeadObjectOutput) 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”.



15127
15128
15129
 
// File 'service/s3/api.go', line 15127


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

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

SetAcceptRanges sets the AcceptRanges field's value.



15132
15133
15134
15135
 
// File 'service/s3/api.go', line 15132


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

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

SetCacheControl sets the CacheControl field's value.



15138
15139
15140
15141
 
// File 'service/s3/api.go', line 15138


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

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

SetContentDisposition sets the ContentDisposition field's value.



15144
15145
15146
15147
 
// File 'service/s3/api.go', line 15144


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

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

SetContentEncoding sets the ContentEncoding field's value.



15150
15151
15152
15153
 
// File 'service/s3/api.go', line 15150


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

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

SetContentLanguage sets the ContentLanguage field's value.



15156
15157
15158
15159
 
// File 'service/s3/api.go', line 15156


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

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

SetContentLength sets the ContentLength field's value.



15162
15163
15164
15165
 
// File 'service/s3/api.go', line 15162


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

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

SetContentType sets the ContentType field's value.



15168
15169
15170
15171
 
// File 'service/s3/api.go', line 15168


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

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

SetDeleteMarker sets the DeleteMarker field's value.



15174
15175
15176
15177
 
// File 'service/s3/api.go', line 15174


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

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

SetETag sets the ETag field's value.



15180
15181
15182
15183
 
// File 'service/s3/api.go', line 15180


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

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

SetExpiration sets the Expiration field's value.



15186
15187
15188
15189
 
// File 'service/s3/api.go', line 15186


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

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

SetExpires sets the Expires field's value.



15192
15193
15194
15195
 
// File 'service/s3/api.go', line 15192


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

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

SetIBMRestoredCopyStorageClass sets the IBMRestoredCopyStorageClass field's value.



15198
15199
15200
15201
 
// File 'service/s3/api.go', line 15198


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

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

SetIBMTransition sets the IBMTransition field's value.



15204
15205
15206
15207
 
// File 'service/s3/api.go', line 15204


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

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

SetLastModified sets the LastModified field's value.



15210
15211
15212
15213
 
// File 'service/s3/api.go', line 15210


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

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

SetMetadata sets the Metadata field's value.



15216
15217
15218
15219
 
// File 'service/s3/api.go', line 15216


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

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

SetMissingMeta sets the MissingMeta field's value.



15222
15223
15224
15225
 
// File 'service/s3/api.go', line 15222


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

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

SetObjectLockLegalHoldStatus sets the ObjectLockLegalHoldStatus field's value.



15228
15229
15230
15231
 
// File 'service/s3/api.go', line 15228


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

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

SetObjectLockMode sets the ObjectLockMode field's value.



15234
15235
15236
15237
 
// File 'service/s3/api.go', line 15234


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

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

SetObjectLockRetainUntilDate sets the ObjectLockRetainUntilDate field's value.



15240
15241
15242
15243
 
// File 'service/s3/api.go', line 15240


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

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

SetPartsCount sets the PartsCount field's value.



15246
15247
15248
15249
 
// File 'service/s3/api.go', line 15246


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

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

SetReplicationStatus sets the ReplicationStatus field's value.



15252
15253
15254
15255
 
// File 'service/s3/api.go', line 15252


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

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

SetRequestCharged sets the RequestCharged field's value.



15258
15259
15260
15261
 
// File 'service/s3/api.go', line 15258


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

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

SetRestore sets the Restore field's value.



15264
15265
15266
15267
 
// File 'service/s3/api.go', line 15264


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

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

SetRetentionExpirationDate sets the RetentionExpirationDate field's value.



15270
15271
15272
15273
 
// File 'service/s3/api.go', line 15270


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

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

SetRetentionLegalHoldCount sets the RetentionLegalHoldCount field's value.



15276
15277
15278
15279
 
// File 'service/s3/api.go', line 15276


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

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

SetRetentionPeriod sets the RetentionPeriod field's value.



15282
15283
15284
15285
 
// File 'service/s3/api.go', line 15282


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

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

SetServerSideEncryption sets the ServerSideEncryption field's value.



15306
15307
15308
15309
 
// File 'service/s3/api.go', line 15306


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

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

SetSSECustomerAlgorithm sets the SSECustomerAlgorithm field's value.



15288
15289
15290
15291
 
// File 'service/s3/api.go', line 15288


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

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

SetSSECustomerKeyMD5 sets the SSECustomerKeyMD5 field's value.



15294
15295
15296
15297
 
// File 'service/s3/api.go', line 15294


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

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

SetSSEKMSKeyId sets the SSEKMSKeyId field's value.



15300
15301
15302
15303
 
// File 'service/s3/api.go', line 15300


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

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

SetStorageClass sets the StorageClass field's value.



15312
15313
15314
15315
 
// File 'service/s3/api.go', line 15312


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

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

SetVersionId sets the VersionId field's value.



15318
15319
15320
15321
 
// File 'service/s3/api.go', line 15318


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

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

SetWebsiteRedirectLocation sets the WebsiteRedirectLocation field's value.



15324
15325
15326
15327
 
// File 'service/s3/api.go', line 15324


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

func (s HeadObjectOutput) 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”.



15118
15119
15120
 
// File 'service/s3/api.go', line 15118


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