Struct: s3.PutBucketWebsiteInput

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.

• WebsiteConfiguration *WebsiteConfiguration

  Container for the request.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetBucket(string) *PutBucketWebsiteInput operation

  SetBucket sets the Bucket field’s value.

• SetExpectedBucketOwner(string) *PutBucketWebsiteInput operation

  SetExpectedBucketOwner sets the ExpectedBucketOwner field’s value.

• SetWebsiteConfiguration(*WebsiteConfiguration) *PutBucketWebsiteInput operation

  SetWebsiteConfiguration sets the WebsiteConfiguration 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.

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

Container for the request.

WebsiteConfiguration is a required field

_ struct{} `locationName:"PutBucketWebsiteRequest" type:"structure" payload:"WebsiteConfiguration"`

Method Details

func (s PutBucketWebsiteInput) 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 20159

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

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

SetBucket sets the Bucket field’s value.

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

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

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

SetExpectedBucketOwner sets the ExpectedBucketOwner field’s value.

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

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

func (s *PutBucketWebsiteInput) SetWebsiteConfiguration(v *WebsiteConfiguration) *PutBucketWebsiteInput

SetWebsiteConfiguration sets the WebsiteConfiguration field’s value.

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

func (s *PutBucketWebsiteInput) SetWebsiteConfiguration(v *WebsiteConfiguration) *PutBucketWebsiteInput {
	s.WebsiteConfiguration = v
	return s
}

func (s PutBucketWebsiteInput) 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 20150

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

func (s *PutBucketWebsiteInput) Validate() error

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

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

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

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