Struct: s3.Condition

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

Overview

A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary

• HttpErrorCodeReturnedEquals *string

  The HTTP error code when the redirect is applied.

• KeyPrefixEquals *string

  The object key name prefix when the redirect is applied.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetHttpErrorCodeReturnedEquals(string) *Condition operation

  SetHttpErrorCodeReturnedEquals sets the HttpErrorCodeReturnedEquals field's value.

• SetKeyPrefixEquals(string) *Condition operation

  SetKeyPrefixEquals sets the KeyPrefixEquals field's value.

• String() string operation

  String returns the string representation.

Structure Field Details

HttpErrorCodeReturnedEquals *string `type:"string"`

The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

KeyPrefixEquals *string `type:"string"`

The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.

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

_ struct{} `type:"structure"`

Method Details

func (s Condition) 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 8297

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

func (s *Condition) SetHttpErrorCodeReturnedEquals(v string) *Condition

SetHttpErrorCodeReturnedEquals sets the HttpErrorCodeReturnedEquals field's value.

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

func (s *Condition) SetHttpErrorCodeReturnedEquals(v string) *Condition {
	s.HttpErrorCodeReturnedEquals = &v
	return s
}

func (s *Condition) SetKeyPrefixEquals(v string) *Condition

SetKeyPrefixEquals sets the KeyPrefixEquals field's value.

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

func (s *Condition) SetKeyPrefixEquals(v string) *Condition {
	s.KeyPrefixEquals = &v
	return s
}

func (s Condition) 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 8288

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