Struct: s3.IndexDocument

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

Overview

Container for the Suffix element.

Implemented Interfaces

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

Structure Field Summary

• Suffix *string

  A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetSuffix(string) *IndexDocument operation

  SetSuffix sets the Suffix 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

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

A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.

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).

Suffix is a required field

_ struct{} `type:"structure"`

Method Details

func (s IndexDocument) 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 15512

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

func (s *IndexDocument) SetSuffix(v string) *IndexDocument

SetSuffix sets the Suffix field’s value.

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

func (s *IndexDocument) SetSuffix(v string) *IndexDocument {
	s.Suffix = &v
	return s
}

func (s IndexDocument) 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 15503

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

func (s *IndexDocument) Validate() error

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

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

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

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