Struct: s3.PutObjectLockConfigurationInput

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

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, request.Validator, s3manager.WriterReadFrom

Structure Field Summary collapse

Service Operations collapse

Structure Field Details

Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

The bucket whose Object Lock configuration you want to create or replace.

Bucket is a required field

ExpectedBucketOwner *string `location:"header" locationName:"x-amz-expected-bucket-owner" type:"string"`

Ignored by COS.

ObjectLockConfiguration *ObjectLockConfiguration `locationName:"ObjectLockConfiguration" type:"structure" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

The Object Lock configuration that you want to apply to the specified bucket.

RequestPayer *string `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"RequestPayer"`

Ignored by COS.

Token *string `location:"header" locationName:"x-amz-bucket-object-lock-token" type:"string"`

Ignored by COS.

_ struct{} `locationName:"PutObjectLockConfigurationRequest" type:"structure" payload:"ObjectLockConfiguration"`

Method Details

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



20347
20348
20349
// File 'service/s3/api.go', line 20347

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

func (s *PutObjectLockConfigurationInput) SetBucket(v string) *PutObjectLockConfigurationInput

SetBucket sets the Bucket field's value.



20368
20369
20370
20371
// File 'service/s3/api.go', line 20368

func (s *PutObjectLockConfigurationInput) SetBucket(v string) *PutObjectLockConfigurationInput { s.Bucket = &v return s }

func (s *PutObjectLockConfigurationInput) SetExpectedBucketOwner(v string) *PutObjectLockConfigurationInput

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.



20381
20382
20383
20384
// File 'service/s3/api.go', line 20381

func (s *PutObjectLockConfigurationInput) SetExpectedBucketOwner(v string) *PutObjectLockConfigurationInput { s.ExpectedBucketOwner = &v return s }

func (s *PutObjectLockConfigurationInput) SetObjectLockConfiguration(v *ObjectLockConfiguration) *PutObjectLockConfigurationInput

SetObjectLockConfiguration sets the ObjectLockConfiguration field's value.



20387
20388
20389
20390
// File 'service/s3/api.go', line 20387

func (s *PutObjectLockConfigurationInput) SetRequestPayer(v string) *PutObjectLockConfigurationInput

SetRequestPayer sets the RequestPayer field's value.



20393
20394
20395
20396
// File 'service/s3/api.go', line 20393

func (s *PutObjectLockConfigurationInput) SetRequestPayer(v string) *PutObjectLockConfigurationInput { s.RequestPayer = &v return s }

func (s *PutObjectLockConfigurationInput) SetToken(v string) *PutObjectLockConfigurationInput

SetToken sets the Token field's value.



20399
20400
20401
20402
// File 'service/s3/api.go', line 20399

func (s *PutObjectLockConfigurationInput) SetToken(v string) *PutObjectLockConfigurationInput { s.Token = &v return s }

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



20338
20339
20340
// File 'service/s3/api.go', line 20338

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

func (s *PutObjectLockConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.



20352
20353
20354
20355
20356
20357
20358
20359
20360
20361
20362
20363
20364
20365
// File 'service/s3/api.go', line 20352

func (s *PutObjectLockConfigurationInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "PutObjectLockConfigurationInput"} if s.Bucket == nil { invalidParams.Add(request.NewErrParamRequired("Bucket")) } if s.Bucket != nil && len(*s.Bucket) < 1 { invalidParams.Add(request.NewErrParamMinLen("Bucket", 1)) } if invalidParams.Len() > 0 { return invalidParams } return nil }