Struct: s3.ListPartsInput

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

Implemented Interfaces

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

Structure Field Summary collapse

Bucket *string

The name of the bucket to which the parts are being uploaded.
ExpectedBucketOwner *string

Ignored by COS.
Key *string

Object key for which the multipart upload was initiated.
MaxParts *int64

Sets the maximum number of parts to return.
PartNumberMarker *int64

Specifies the part after which listing should begin.
RequestPayer *string

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

Upload ID identifying the multipart upload whose parts are being listed.
_ struct{}

Service Operations collapse

GoString() string operation

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

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

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

SetKey sets the Key field's value.
SetMaxParts(int64) *ListPartsInput operation

SetMaxParts sets the MaxParts field's value.
SetPartNumberMarker(int64) *ListPartsInput operation

SetPartNumberMarker sets the PartNumberMarker field's value.
SetRequestPayer(string) *ListPartsInput operation

SetRequestPayer sets the RequestPayer field's value.
SetUploadId(string) *ListPartsInput operation

SetUploadId sets the UploadId 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 name of the bucket to which the parts are being uploaded.

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.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? (docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.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"`

Object key for which the multipart upload was initiated.

Key is a required field

MaxParts *int64 `location:"querystring" locationName:"max-parts" type:"integer"`

Sets the maximum number of parts to return.

PartNumberMarker *int64 `location:"querystring" locationName:"part-number-marker" type:"integer"`

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

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.

UploadId *string `location:"querystring" locationName:"uploadId" type:"string" required:"true"`

Upload ID identifying the multipart upload whose parts are being listed.

UploadId is a required field

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

Method Details

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



17600
17601
17602

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

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

func (s ListPartsInput) SetBucket(v string) ListPartsInput

SetBucket sets the Bucket field's value.

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

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

func (s ListPartsInput) SetExpectedBucketOwner(v string) ListPartsInput

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.

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

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

func (s ListPartsInput) SetKey(v string) ListPartsInput

SetKey sets the Key field's value.

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

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

func (s ListPartsInput) SetMaxParts(v int64) ListPartsInput

SetMaxParts sets the MaxParts field's value.

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

func (s *ListPartsInput) SetMaxParts(v int64) *ListPartsInput {
	s.MaxParts = &v
	return s
}

func (s ListPartsInput) SetPartNumberMarker(v int64) ListPartsInput

SetPartNumberMarker sets the PartNumberMarker field's value.

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

func (s *ListPartsInput) SetPartNumberMarker(v int64) *ListPartsInput {
	s.PartNumberMarker = &v
	return s
}

func (s ListPartsInput) SetRequestPayer(v string) ListPartsInput

SetRequestPayer sets the RequestPayer field's value.

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

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

func (s ListPartsInput) SetUploadId(v string) ListPartsInput

SetUploadId sets the UploadId field's value.

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

func (s *ListPartsInput) SetUploadId(v string) *ListPartsInput {
	s.UploadId = &v
	return s
}

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



17591
17592
17593

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

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

func (s *ListPartsInput) Validate() error

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

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

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

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