Struct: s3.ListLegalHoldsOutput

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

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary

• CreateTime *time.Time
• LegalHolds []*LegalHold
• RetentionPeriod *int64

  Retention period to store on the object in seconds.

• RetentionPeriodExpirationDate *time.Time
• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetCreateTime(time.Time) *ListLegalHoldsOutput operation

  SetCreateTime sets the CreateTime field's value.

• SetLegalHolds([]*LegalHold) *ListLegalHoldsOutput operation

  SetLegalHolds sets the LegalHolds field's value.

• SetRetentionPeriod(int64) *ListLegalHoldsOutput operation

  SetRetentionPeriod sets the RetentionPeriod field's value.

• SetRetentionPeriodExpirationDate(time.Time) *ListLegalHoldsOutput operation

  SetRetentionPeriodExpirationDate sets the RetentionPeriodExpirationDate field's value.

• String() string operation

  String returns the string representation.

Structure Field Details

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

LegalHolds []*LegalHold `type:"list"`

RetentionPeriod *int64 `type:"integer"`

Retention period to store on the object in seconds. The object can be neither overwritten nor deleted until the amount of time specified in the retention period has elapsed. If this field and Retention-Expiration-Date are specified a 400 error is returned. If neither is specified the bucket's DefaultRetention period will be used. 0 is a legal value assuming the bucket's minimum retention period is also 0.

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

_ struct{} `type:"structure"`

Method Details

func (s ListLegalHoldsOutput) 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 16048

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

func (s *ListLegalHoldsOutput) SetCreateTime(v time.Time) *ListLegalHoldsOutput

SetCreateTime sets the CreateTime field's value.

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

func (s *ListLegalHoldsOutput) SetCreateTime(v time.Time) *ListLegalHoldsOutput {
	s.CreateTime = &v
	return s
}

func (s *ListLegalHoldsOutput) SetLegalHolds(v []*LegalHold) *ListLegalHoldsOutput

SetLegalHolds sets the LegalHolds field's value.

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

func (s *ListLegalHoldsOutput) SetLegalHolds(v []*LegalHold) *ListLegalHoldsOutput {
	s.LegalHolds = v
	return s
}

func (s *ListLegalHoldsOutput) SetRetentionPeriod(v int64) *ListLegalHoldsOutput

SetRetentionPeriod sets the RetentionPeriod field's value.

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

func (s *ListLegalHoldsOutput) SetRetentionPeriod(v int64) *ListLegalHoldsOutput {
	s.RetentionPeriod = &v
	return s
}

func (s *ListLegalHoldsOutput) SetRetentionPeriodExpirationDate(v time.Time) *ListLegalHoldsOutput

SetRetentionPeriodExpirationDate sets the RetentionPeriodExpirationDate field's value.

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

func (s *ListLegalHoldsOutput) SetRetentionPeriodExpirationDate(v time.Time) *ListLegalHoldsOutput {
	s.RetentionPeriodExpirationDate = &v
	return s
}

func (s ListLegalHoldsOutput) 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 16039

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