Struct: s3.ErrorDocument

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

Overview

The error information.

Implemented Interfaces

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

Structure Field Summary

• Key *string

  The object key name to use when a 4XX class error occurs.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetKey(string) *ErrorDocument operation

  SetKey sets the Key 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

Key *string `min:"1" type:"string" required:"true"`

The object key name to use when a 4XX class error occurs.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints (docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).

Key is a required field

_ struct{} `type:"structure"`

Method Details

func (s ErrorDocument) 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 11772

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

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

SetKey sets the Key field's value.

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

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

func (s ErrorDocument) 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 11763

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

func (s *ErrorDocument) Validate() error

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

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

func (s *ErrorDocument) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "ErrorDocument"}
	if s.Key == nil {
		invalidParams.Add(request.NewErrParamRequired("Key"))
	}
	if s.Key != nil && len(*s.Key) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("Key", 1))
	}

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