Struct: s3.PutBucketVersioningInput

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

Implemented Interfaces

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

Structure Field Summary

• Bucket *string

  The bucket name.

• ExpectedBucketOwner *string

  Ignored by COS.

• MFA *string

  The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

• VersioningConfiguration *VersioningConfiguration

  Container for setting the versioning state.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetBucket(string) *PutBucketVersioningInput operation

  SetBucket sets the Bucket field's value.

• SetExpectedBucketOwner(string) *PutBucketVersioningInput operation

  SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.

• SetMFA(string) *PutBucketVersioningInput operation

  SetMFA sets the MFA field's value.

• SetVersioningConfiguration(*VersioningConfiguration) *PutBucketVersioningInput operation

  SetVersioningConfiguration sets the VersioningConfiguration field's value.

• String() string operation

  String returns the string representation.

• Validate() error operation

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

Structure Field Details

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

The bucket name.

Bucket is a required field

ExpectedBucketOwner *string `location:"header" locationName:"x-amz-expected-bucket-owner" type:"string"`

Ignored by COS.

MFA *string `location:"header" locationName:"x-amz-mfa" type:"string"`

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

VersioningConfiguration *VersioningConfiguration `locationName:"VersioningConfiguration" type:"structure" required:"true" xmlURI:"http://s3.amazonaws.com/doc/2006-03-01/"`

Container for setting the versioning state.

VersioningConfiguration is a required field

_ struct{} `locationName:"PutBucketVersioningRequest" type:"structure" payload:"VersioningConfiguration"`

Method Details

func (s PutBucketVersioningInput) 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 19287

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

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

SetBucket sets the Bucket field's value.

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

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

func (s *PutBucketVersioningInput) SetExpectedBucketOwner(v string) *PutBucketVersioningInput

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.

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

func (s *PutBucketVersioningInput) SetExpectedBucketOwner(v string) *PutBucketVersioningInput {
	s.ExpectedBucketOwner = &v
	return s
}

func (s *PutBucketVersioningInput) SetMFA(v string) *PutBucketVersioningInput

SetMFA sets the MFA field's value.

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

func (s *PutBucketVersioningInput) SetMFA(v string) *PutBucketVersioningInput {
	s.MFA = &v
	return s
}

func (s *PutBucketVersioningInput) SetVersioningConfiguration(v *VersioningConfiguration) *PutBucketVersioningInput

SetVersioningConfiguration sets the VersioningConfiguration field's value.

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

func (s *PutBucketVersioningInput) SetVersioningConfiguration(v *VersioningConfiguration) *PutBucketVersioningInput {
	s.VersioningConfiguration = v
	return s
}

func (s PutBucketVersioningInput) 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 19278

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

func (s *PutBucketVersioningInput) Validate() error

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

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

func (s *PutBucketVersioningInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "PutBucketVersioningInput"}
	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.VersioningConfiguration == nil {
		invalidParams.Add(request.NewErrParamRequired("VersioningConfiguration"))
	}

	if invalidParams.Len() > 0 {
		return invalidParams
	}
	return nil
}