Struct: s3.GetObjectAclInput

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

Implemented Interfaces

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

Structure Field Summary collapse

Bucket *string

The bucket name that contains the object for which to get the ACL information.
ExpectedBucketOwner *string

Ignored by COS.
Key *string

The key of the object for which to get the ACL information.
RequestPayer *string

Confirms that the requester knows that they will be charged for the request.
VersionId *string

VersionId used to reference a specific version of the object.
_ struct{}

Service Operations collapse

GoString() string operation

GoString returns the string representation.
SetBucket(string) *GetObjectAclInput operation

SetBucket sets the Bucket field's value.
SetExpectedBucketOwner(string) *GetObjectAclInput operation

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.
SetKey(string) *GetObjectAclInput operation

SetKey sets the Key field's value.
SetRequestPayer(string) *GetObjectAclInput operation

SetRequestPayer sets the RequestPayer field's value.
SetVersionId(string) *GetObjectAclInput 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

Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

The bucket name that contains the object for which to get the ACL information.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points (docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) in the Amazon S3 User Guide.

Bucket is a required field

ExpectedBucketOwner *string `location:"header" locationName:"x-amz-expected-bucket-owner" type:"string"`

Ignored by COS.

Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`

The key of the object for which to get the ACL information.

Key is a required field

RequestPayer *string `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"RequestPayer"`

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets (docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the Amazon S3 User Guide.

VersionId *string `location:"querystring" locationName:"versionId" type:"string"`

VersionId used to reference a specific version of the object.

_ struct{} `locationName:"GetObjectAclRequest" type:"structure"`

Method Details

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



12923
12924
12925

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

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

func (s GetObjectAclInput) SetBucket(v string) GetObjectAclInput

SetBucket sets the Bucket field's value.

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

func (s *GetObjectAclInput) SetBucket(v string) *GetObjectAclInput {
	s.Bucket = &v
	return s
}

func (s GetObjectAclInput) SetExpectedBucketOwner(v string) GetObjectAclInput

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.

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

func (s *GetObjectAclInput) SetExpectedBucketOwner(v string) *GetObjectAclInput {
	s.ExpectedBucketOwner = &v
	return s
}

func (s GetObjectAclInput) SetKey(v string) GetObjectAclInput

SetKey sets the Key field's value.

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

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

func (s GetObjectAclInput) SetRequestPayer(v string) GetObjectAclInput

SetRequestPayer sets the RequestPayer field's value.

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

func (s *GetObjectAclInput) SetRequestPayer(v string) *GetObjectAclInput {
	s.RequestPayer = &v
	return s
}

func (s GetObjectAclInput) SetVersionId(v string) GetObjectAclInput

SetVersionId sets the VersionId field's value.

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

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

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



12914
12915
12916

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

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

func (s *GetObjectAclInput) Validate() error

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

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

func (s *GetObjectAclInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "GetObjectAclInput"}
	if s.Bucket == nil {
		invalidParams.Add(request.NewErrParamRequired("Bucket"))
	}
	if s.Bucket != nil && len(*s.Bucket) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("Bucket", 1))
	}
	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
}