Struct: s3.ReplicationRuleFilter

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

Overview

A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix, Tag, or an And child element.

Implemented Interfaces

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

Structure Field Summary

• And *ReplicationRuleAndOperator

  A container for specifying rule filters.

• Prefix *string

  An object key name prefix that identifies the subset of objects to which the rule applies.

• Tag *Tag

  A container for specifying a tag key and value.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetAnd(*ReplicationRuleAndOperator) *ReplicationRuleFilter operation

  SetAnd sets the And field's value.

• SetPrefix(string) *ReplicationRuleFilter operation

  SetPrefix sets the Prefix field's value.

• SetTag(*Tag) *ReplicationRuleFilter operation

  SetTag sets the Tag 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

And *ReplicationRuleAndOperator `type:"structure"`

A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example:

• If you specify both a Prefix and a Tag filter, wrap these filters in an And tag.

• If you specify a filter based on multiple tags, wrap the Tag elements in an And tag.

Prefix *string `type:"string"`

An object key name prefix that identifies the subset of objects to which the rule applies.

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

Tag *Tag `type:"structure"`

A container for specifying a tag key and value.

The rule applies only to objects that have the tag in their tag set.

_ struct{} `type:"structure"`

Method Details

func (s ReplicationRuleFilter) 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 21479

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

func (s *ReplicationRuleFilter) SetAnd(v *ReplicationRuleAndOperator) *ReplicationRuleFilter

SetAnd sets the And field's value.

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

func (s *ReplicationRuleFilter) SetAnd(v *ReplicationRuleAndOperator) *ReplicationRuleFilter {
	s.And = v
	return s
}

func (s *ReplicationRuleFilter) SetPrefix(v string) *ReplicationRuleFilter

SetPrefix sets the Prefix field's value.

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

func (s *ReplicationRuleFilter) SetPrefix(v string) *ReplicationRuleFilter {
	s.Prefix = &v
	return s
}

func (s *ReplicationRuleFilter) SetTag(v *Tag) *ReplicationRuleFilter

SetTag sets the Tag field's value.

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

func (s *ReplicationRuleFilter) SetTag(v *Tag) *ReplicationRuleFilter {
	s.Tag = v
	return s
}

func (s ReplicationRuleFilter) 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 21470

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

func (s *ReplicationRuleFilter) Validate() error

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

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

func (s *ReplicationRuleFilter) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "ReplicationRuleFilter"}
	if s.And != nil {
		if err := s.And.Validate(); err != nil {
			invalidParams.AddNested("And", err.(request.ErrInvalidParams))
		}
	}
	if s.Tag != nil {
		if err := s.Tag.Validate(); err != nil {
			invalidParams.AddNested("Tag", err.(request.ErrInvalidParams))
		}
	}

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