Struct: s3.PutBucketLoggingInput

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

Implemented Interfaces

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

Structure Field Summary

• Bucket *string

  The name of the bucket for which to set the logging parameters.

• BucketLoggingStatus *BucketLoggingStatus

  Container for logging status information.

• ExpectedBucketOwner *string

  Ignored by COS.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetBucket(string) *PutBucketLoggingInput operation

  SetBucket sets the Bucket field's value.

• SetBucketLoggingStatus(*BucketLoggingStatus) *PutBucketLoggingInput operation

  SetBucketLoggingStatus sets the BucketLoggingStatus field's value.

• SetExpectedBucketOwner(string) *PutBucketLoggingInput operation

  SetExpectedBucketOwner sets the ExpectedBucketOwner 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 name of the bucket for which to set the logging parameters.

Bucket is a required field

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

Container for logging status information.

BucketLoggingStatus is a required field

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

Ignored by COS.

_ struct{} `locationName:"PutBucketLoggingRequest" type:"structure" payload:"BucketLoggingStatus"`

Method Details

func (s PutBucketLoggingInput) 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 18977

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

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

SetBucket sets the Bucket field's value.

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

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

func (s *PutBucketLoggingInput) SetBucketLoggingStatus(v *BucketLoggingStatus) *PutBucketLoggingInput

SetBucketLoggingStatus sets the BucketLoggingStatus field's value.

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

func (s *PutBucketLoggingInput) SetBucketLoggingStatus(v *BucketLoggingStatus) *PutBucketLoggingInput {
	s.BucketLoggingStatus = v
	return s
}

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

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.

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

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

func (s PutBucketLoggingInput) 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 18968

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

func (s *PutBucketLoggingInput) Validate() error

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

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

func (s *PutBucketLoggingInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "PutBucketLoggingInput"}
	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.BucketLoggingStatus == nil {
		invalidParams.Add(request.NewErrParamRequired("BucketLoggingStatus"))
	}
	if s.BucketLoggingStatus != nil {
		if err := s.BucketLoggingStatus.Validate(); err != nil {
			invalidParams.AddNested("BucketLoggingStatus", err.(request.ErrInvalidParams))
		}
	}

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