Struct: s3.Grantee

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

Overview

Container for the person being granted permissions.

Implemented Interfaces

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

Structure Field Summary collapse

DisplayName *string

Screen name of the grantee.
EmailAddress *string

Email address of the grantee.
ID *string

The canonical user ID of the grantee.
Type *string

Type of grantee.
URI *string

URI of the grantee group.
_ struct{}

Service Operations collapse

GoString() string operation

GoString returns the string representation.
SetDisplayName(string) *Grantee operation

SetDisplayName sets the DisplayName field’s value.
SetEmailAddress(string) *Grantee operation

SetEmailAddress sets the EmailAddress field’s value.
SetID(string) *Grantee operation

SetID sets the ID field’s value.
SetType(string) *Grantee operation

SetType sets the Type field’s value.
SetURI(string) *Grantee operation

SetURI sets the URI 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

DisplayName *string `type:"string"`

Screen name of the grantee.

EmailAddress *string `type:"string"`

Email address of the grantee.

Using email addresses to specify a grantee is only supported in the following AWS Regions:

US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints (docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the AWS General Reference.

ID *string `type:"string"`

The canonical user ID of the grantee.

Type *string `locationName:"xsi:type" type:"string" xmlAttribute:"true" required:"true" enum:"Type"`

Type of grantee

Type is a required field

URI *string `type:"string"`

URI of the grantee group.

_ struct{} `type:"structure" xmlPrefix:"xsi" xmlURI:"http://www.w3.org/2001/XMLSchema-instance"`

Method Details

func (s Grantee) 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”.



14669
14670
14671

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

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

func (s Grantee) SetDisplayName(v string) Grantee

SetDisplayName sets the DisplayName field’s value.

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

func (s *Grantee) SetDisplayName(v string) *Grantee {
	s.DisplayName = &v
	return s
}

func (s Grantee) SetEmailAddress(v string) Grantee

SetEmailAddress sets the EmailAddress field’s value.

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

func (s *Grantee) SetEmailAddress(v string) *Grantee {
	s.EmailAddress = &v
	return s
}

func (s Grantee) SetID(v string) Grantee

SetID sets the ID field’s value.

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

func (s *Grantee) SetID(v string) *Grantee {
	s.ID = &v
	return s
}

func (s Grantee) SetType(v string) Grantee

SetType sets the Type field’s value.

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

func (s *Grantee) SetType(v string) *Grantee {
	s.Type = &v
	return s
}

func (s Grantee) SetURI(v string) Grantee

SetURI sets the URI field’s value.

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

func (s *Grantee) SetURI(v string) *Grantee {
	s.URI = &v
	return s
}

func (s Grantee) 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”.



14660
14661
14662

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

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

func (s *Grantee) Validate() error

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

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

func (s *Grantee) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "Grantee"}
	if s.Type == nil {
		invalidParams.Add(request.NewErrParamRequired("Type"))
	}

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