Struct: s3.RedirectAllRequestsTo

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

Overview

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

Implemented Interfaces

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

Structure Field Summary

• HostName *string

  Name of the host where requests are redirected.

• Protocol *string

  Protocol to use when redirecting requests.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetHostName(string) *RedirectAllRequestsTo operation

  SetHostName sets the HostName field's value.

• SetProtocol(string) *RedirectAllRequestsTo operation

  SetProtocol sets the Protocol 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

HostName *string `type:"string" required:"true"`

Name of the host where requests are redirected.

HostName is a required field

Protocol *string `type:"string" enum:"Protocol"`

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

_ struct{} `type:"structure"`

Method Details

func (s RedirectAllRequestsTo) 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 21335

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

func (s *RedirectAllRequestsTo) SetHostName(v string) *RedirectAllRequestsTo

SetHostName sets the HostName field's value.

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

func (s *RedirectAllRequestsTo) SetHostName(v string) *RedirectAllRequestsTo {
	s.HostName = &v
	return s
}

func (s *RedirectAllRequestsTo) SetProtocol(v string) *RedirectAllRequestsTo

SetProtocol sets the Protocol field's value.

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

func (s *RedirectAllRequestsTo) SetProtocol(v string) *RedirectAllRequestsTo {
	s.Protocol = &v
	return s
}

func (s RedirectAllRequestsTo) 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 21326

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

func (s *RedirectAllRequestsTo) Validate() error

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

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

func (s *RedirectAllRequestsTo) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "RedirectAllRequestsTo"}
	if s.HostName == nil {
		invalidParams.Add(request.NewErrParamRequired("HostName"))
	}

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