Struct: s3.Delete

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

Overview

Container for the objects to delete.

Implemented Interfaces

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

Structure Field Summary

• Objects []*ObjectIdentifier

  The object to delete.

• Quiet *bool

  Element to enable quiet mode for the request.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetObjects([]*ObjectIdentifier) *Delete operation

  SetObjects sets the Objects field's value.

• SetQuiet(bool) *Delete operation

  SetQuiet sets the Quiet 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

Objects []*ObjectIdentifier `locationName:"Object" type:"list" flattened:"true" required:"true"`

The object to delete.

Objects is a required field

Quiet *bool `type:"boolean"`

Element to enable quiet mode for the request. When you add this element, you must set its value to true.

_ struct{} `type:"structure"`

Method Details

func (s Delete) 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 9893

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

func (s *Delete) SetObjects(v []*ObjectIdentifier) *Delete

SetObjects sets the Objects field's value.

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

func (s *Delete) SetObjects(v []*ObjectIdentifier) *Delete {
	s.Objects = v
	return s
}

func (s *Delete) SetQuiet(v bool) *Delete

SetQuiet sets the Quiet field's value.

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

func (s *Delete) SetQuiet(v bool) *Delete {
	s.Quiet = &v
	return s
}

func (s Delete) 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 9884

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

func (s *Delete) Validate() error

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

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

func (s *Delete) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "Delete"}
	if s.Objects == nil {
		invalidParams.Add(request.NewErrParamRequired("Objects"))
	}
	if s.Objects != nil {
		for i, v := range s.Objects {
			if v == nil {
				continue
			}
			if err := v.Validate(); err != nil {
				invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Objects", i), err.(request.ErrInvalidParams))
			}
		}
	}

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