Struct: s3.DeleteLegalHoldInput

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

Implemented Interfaces

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

Structure Field Summary collapse

Service Operations collapse

Structure Field Details

Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

Bucket is a required field

Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

Key is a required field

RetentionLegalHoldId *string `location:"querystring" locationName:"remove" type:"string" required:"true"`

RetentionLegalHoldId is a required field

_ struct{} `locationName:"DeleteLegalHoldRequest" type:"structure"`

Method Details

func (s DeleteLegalHoldInput) 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”.



10394
10395
10396
// File 'service/s3/api.go', line 10394

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

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

SetBucket sets the Bucket field's value.



10424
10425
10426
10427
// File 'service/s3/api.go', line 10424

func (s *DeleteLegalHoldInput) SetBucket(v string) *DeleteLegalHoldInput { s.Bucket = &v return s }

func (s *DeleteLegalHoldInput) SetKey(v string) *DeleteLegalHoldInput

SetKey sets the Key field's value.



10437
10438
10439
10440
// File 'service/s3/api.go', line 10437

func (s *DeleteLegalHoldInput) SetKey(v string) *DeleteLegalHoldInput { s.Key = &v return s }

func (s *DeleteLegalHoldInput) SetRetentionLegalHoldId(v string) *DeleteLegalHoldInput

SetRetentionLegalHoldId sets the RetentionLegalHoldId field's value.



10443
10444
10445
10446
// File 'service/s3/api.go', line 10443

func (s *DeleteLegalHoldInput) SetRetentionLegalHoldId(v string) *DeleteLegalHoldInput { s.RetentionLegalHoldId = &v return s }

func (s DeleteLegalHoldInput) 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”.



10385
10386
10387
// File 'service/s3/api.go', line 10385

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

func (s *DeleteLegalHoldInput) Validate() error

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



10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
// File 'service/s3/api.go', line 10399

func (s *DeleteLegalHoldInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DeleteLegalHoldInput"} if s.Bucket == nil { invalidParams.Add(request.NewErrParamRequired("Bucket")) } if s.Bucket != nil && len(*s.Bucket) < 1 { invalidParams.Add(request.NewErrParamMinLen("Bucket", 1)) } if s.Key == nil { invalidParams.Add(request.NewErrParamRequired("Key")) } if s.Key != nil && len(*s.Key) < 1 { invalidParams.Add(request.NewErrParamMinLen("Key", 1)) } if s.RetentionLegalHoldId == nil { invalidParams.Add(request.NewErrParamRequired("RetentionLegalHoldId")) } if invalidParams.Len() > 0 { return invalidParams } return nil }