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

Service Operations collapse

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



14518
14519
14520
// File 'service/s3/api.go', line 14518

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

func (s *Grantee) SetDisplayName(v string) *Grantee

SetDisplayName sets the DisplayName field's value.



14536
14537
14538
14539
// File 'service/s3/api.go', line 14536

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.



14542
14543
14544
14545
// File 'service/s3/api.go', line 14542

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.



14548
14549
14550
14551
// File 'service/s3/api.go', line 14548

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.



14554
14555
14556
14557
// File 'service/s3/api.go', line 14554

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.



14560
14561
14562
14563
// File 'service/s3/api.go', line 14560

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



14509
14510
14511
// File 'service/s3/api.go', line 14509

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.



14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
// File 'service/s3/api.go', line 14523

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 }