Struct: s3.Grant

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

Overview

Container for grant information.

Implemented Interfaces

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

Structure Field Summary

• Grantee *Grantee

  The person being granted permissions.

• Permission *string

  Specifies the permission given to the grantee.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetGrantee(*Grantee) *Grant operation

  SetGrantee sets the Grantee field’s value.

• SetPermission(string) *Grant operation

  SetPermission sets the Permission 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

Grantee *Grantee `type:"structure" xmlPrefix:"xsi" xmlURI:"http://www.w3.org/2001/XMLSchema-instance"`

The person being granted permissions.

Permission *string `type:"string" enum:"Permission"`

Specifies the permission given to the grantee.

_ struct{} `type:"structure"`

Method Details

func (s Grant) 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 14579

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

func (s *Grant) SetGrantee(v *Grantee) *Grant

SetGrantee sets the Grantee field’s value.

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

func (s *Grant) SetGrantee(v *Grantee) *Grant {
	s.Grantee = v
	return s
}

func (s *Grant) SetPermission(v string) *Grant

SetPermission sets the Permission field’s value.

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

func (s *Grant) SetPermission(v string) *Grant {
	s.Permission = &v
	return s
}

func (s Grant) 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 14570

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

func (s *Grant) Validate() error

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

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

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

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