Struct: s3.ObjectLockRetention

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

Overview

A Retention configuration for an object.

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary

• Mode *string

  Indicates the Retention mode for the specified object.

• RetainUntilDate *time.Time

  The date on which this Object Lock Retention will expire.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetMode(string) *ObjectLockRetention operation

  SetMode sets the Mode field’s value.

• SetRetainUntilDate(time.Time) *ObjectLockRetention operation

  SetRetainUntilDate sets the RetainUntilDate field’s value.

• String() string operation

  String returns the string representation.

Structure Field Details

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

Indicates the Retention mode for the specified object.

RetainUntilDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`

The date on which this Object Lock Retention will expire.

_ struct{} `type:"structure"`

Method Details

func (s ObjectLockRetention) 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 18767

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

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

SetMode sets the Mode field’s value.

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

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

func (s *ObjectLockRetention) SetRetainUntilDate(v time.Time) *ObjectLockRetention

SetRetainUntilDate sets the RetainUntilDate field’s value.

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

func (s *ObjectLockRetention) SetRetainUntilDate(v time.Time) *ObjectLockRetention {
	s.RetainUntilDate = &v
	return s
}

func (s ObjectLockRetention) 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 18758

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