Struct: s3.DefaultRetention

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

Overview

The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.

• The DefaultRetention settings require both a mode and a period.

• The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary

• Days *int64

  The number of days that you want to specify for the default retention period.

• Mode *string

  The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.

• Years *int64

  The number of years that you want to specify for the default retention period.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetDays(int64) *DefaultRetention operation

  SetDays sets the Days field's value.

• SetMode(string) *DefaultRetention operation

  SetMode sets the Mode field's value.

• SetYears(int64) *DefaultRetention operation

  SetYears sets the Years field's value.

• String() string operation

  String returns the string representation.

Structure Field Details

Days *int64 `type:"integer"`

The number of days that you want to specify for the default retention period. Must be used with Mode.

Mode *string `type:"string" enum:"ObjectLockRetentionMode"`

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

Years *int64 `type:"integer"`

The number of years that you want to specify for the default retention period. Must be used with Mode.

_ struct{} `type:"structure"`

Method Details

func (s DefaultRetention) 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 9843

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

func (s *DefaultRetention) SetDays(v int64) *DefaultRetention

SetDays sets the Days field's value.

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

func (s *DefaultRetention) SetDays(v int64) *DefaultRetention {
	s.Days = &v
	return s
}

func (s *DefaultRetention) SetMode(v string) *DefaultRetention

SetMode sets the Mode field's value.

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

func (s *DefaultRetention) SetMode(v string) *DefaultRetention {
	s.Mode = &v
	return s
}

func (s *DefaultRetention) SetYears(v int64) *DefaultRetention

SetYears sets the Years field's value.

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

func (s *DefaultRetention) SetYears(v int64) *DefaultRetention {
	s.Years = &v
	return s
}

func (s DefaultRetention) 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 9834

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