Struct: s3.ObjectLockConfiguration

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

Overview

The container element for Object Lock configuration parameters.

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary

• ObjectLockEnabled *string

  Indicates whether this bucket has an Object Lock configuration enabled.

• Rule *ObjectLockRule

  Specifies the Object Lock rule for the specified object.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetObjectLockEnabled(string) *ObjectLockConfiguration operation

  SetObjectLockEnabled sets the ObjectLockEnabled field's value.

• SetRule(*ObjectLockRule) *ObjectLockConfiguration operation

  SetRule sets the Rule field's value.

• String() string operation

  String returns the string representation.

Structure Field Details

ObjectLockEnabled *string `type:"string" enum:"ObjectLockEnabled"`

Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

Rule *ObjectLockRule `type:"structure"`

Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

_ struct{} `type:"structure"`

Method Details

func (s ObjectLockConfiguration) 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 18317

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

func (s *ObjectLockConfiguration) SetObjectLockEnabled(v string) *ObjectLockConfiguration

SetObjectLockEnabled sets the ObjectLockEnabled field's value.

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

func (s *ObjectLockConfiguration) SetObjectLockEnabled(v string) *ObjectLockConfiguration {
	s.ObjectLockEnabled = &v
	return s
}

func (s *ObjectLockConfiguration) SetRule(v *ObjectLockRule) *ObjectLockConfiguration

SetRule sets the Rule field's value.

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

func (s *ObjectLockConfiguration) SetRule(v *ObjectLockRule) *ObjectLockConfiguration {
	s.Rule = v
	return s
}

func (s ObjectLockConfiguration) 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 18308

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