Struct: s3.ObjectIdentifier

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

Overview

Object Identifier is unique value to identify objects.

Implemented Interfaces

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

Structure Field Summary

• Key *string

  Key name of the object.

• VersionId *string

  VersionId for the specific version of the object to delete.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetKey(string) *ObjectIdentifier operation

  SetKey sets the Key field's value.

• SetVersionId(string) *ObjectIdentifier operation

  SetVersionId sets the VersionId 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"`

Key name of the object.

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

VersionId *string `type:"string"`

VersionId for the specific version of the object to delete.

_ struct{} `type:"structure"`

Method Details

func (s ObjectIdentifier) 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 18019

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

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

SetKey sets the Key field's value.

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

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

func (s *ObjectIdentifier) SetVersionId(v string) *ObjectIdentifier

SetVersionId sets the VersionId field's value.

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

func (s *ObjectIdentifier) SetVersionId(v string) *ObjectIdentifier {
	s.VersionId = &v
	return s
}

func (s ObjectIdentifier) 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 18010

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

func (s *ObjectIdentifier) Validate() error

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

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

func (s *ObjectIdentifier) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "ObjectIdentifier"}
	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
}