Struct: s3.PutObjectLockConfigurationInput

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

Implemented Interfaces

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

Structure Field Summary

• Bucket *string

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

• ExpectedBucketOwner *string

  Ignored by COS.

• ObjectLockConfiguration *ObjectLockConfiguration

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

• RequestPayer *string

  Ignored by COS.

• Token *string

  Ignored by COS.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetBucket(string) *PutObjectLockConfigurationInput operation

  SetBucket sets the Bucket field's value.

• SetExpectedBucketOwner(string) *PutObjectLockConfigurationInput operation

  SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.

• SetObjectLockConfiguration(*ObjectLockConfiguration) *PutObjectLockConfigurationInput operation

  SetObjectLockConfiguration sets the ObjectLockConfiguration field's value.

• SetRequestPayer(string) *PutObjectLockConfigurationInput operation

  SetRequestPayer sets the RequestPayer field's value.

• SetToken(string) *PutObjectLockConfigurationInput operation

  SetToken sets the Token field's value.

• String() string operation

  String returns the string representation.

• Validate() error operation

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

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

// File 'service/s3/api.go', line 20584

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

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

SetBucket sets the Bucket field's value.

// File 'service/s3/api.go', line 20605

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.

// File 'service/s3/api.go', line 20618

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.

// File 'service/s3/api.go', line 20624

func (s *PutObjectLockConfigurationInput) SetObjectLockConfiguration(v *ObjectLockConfiguration) *PutObjectLockConfigurationInput {
	s.ObjectLockConfiguration = v
	return s
}

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

SetRequestPayer sets the RequestPayer field's value.

// File 'service/s3/api.go', line 20630

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.

// File 'service/s3/api.go', line 20636

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

// File 'service/s3/api.go', line 20575

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.

// File 'service/s3/api.go', line 20589

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
}