Struct: s3.ListObjectVersionsInput

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

Implemented Interfaces

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

Structure Field Summary collapse

Service Operations collapse

Structure Field Details

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

The bucket name that contains the objects.

Bucket is a required field

Delimiter *string `location:"querystring" locationName:"delimiter" type:"string"`

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

EncodingType *string `location:"querystring" locationName:"encoding-type" type:"string" enum:"EncodingType"`

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

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

Ignored by COS.

KeyMarker *string `location:"querystring" locationName:"key-marker" type:"string"`

Specifies the key to start with when listing objects in a bucket.

MaxKeys *int64 `location:"querystring" locationName:"max-keys" type:"integer"`

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

Prefix *string `location:"querystring" locationName:"prefix" type:"string"`

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way that you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

VersionIdMarker *string `location:"querystring" locationName:"version-id-marker" type:"string"`

Specifies the object version you want to start listing from.

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

Method Details

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



16636
16637
16638
 
// File 'service/s3/api.go', line 16636


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

func (s *ListObjectVersionsInput) SetBucket(v string) *ListObjectVersionsInput

SetBucket sets the Bucket field's value.



16657
16658
16659
16660
 
// File 'service/s3/api.go', line 16657


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

func (s *ListObjectVersionsInput) SetDelimiter(v string) *ListObjectVersionsInput

SetDelimiter sets the Delimiter field's value.



16670
16671
16672
16673
 
// File 'service/s3/api.go', line 16670


func (s *ListObjectVersionsInput) SetDelimiter(v string) *ListObjectVersionsInput {
	s.Delimiter = &v
	return s
}

func (s *ListObjectVersionsInput) SetEncodingType(v string) *ListObjectVersionsInput

SetEncodingType sets the EncodingType field's value.



16676
16677
16678
16679
 
// File 'service/s3/api.go', line 16676


func (s *ListObjectVersionsInput) SetEncodingType(v string) *ListObjectVersionsInput {
	s.EncodingType = &v
	return s
}

func (s *ListObjectVersionsInput) SetExpectedBucketOwner(v string) *ListObjectVersionsInput

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.



16682
16683
16684
16685
 
// File 'service/s3/api.go', line 16682


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

func (s *ListObjectVersionsInput) SetKeyMarker(v string) *ListObjectVersionsInput

SetKeyMarker sets the KeyMarker field's value.



16688
16689
16690
16691
 
// File 'service/s3/api.go', line 16688


func (s *ListObjectVersionsInput) SetKeyMarker(v string) *ListObjectVersionsInput {
	s.KeyMarker = &v
	return s
}

func (s *ListObjectVersionsInput) SetMaxKeys(v int64) *ListObjectVersionsInput

SetMaxKeys sets the MaxKeys field's value.



16694
16695
16696
16697
 
// File 'service/s3/api.go', line 16694


func (s *ListObjectVersionsInput) SetMaxKeys(v int64) *ListObjectVersionsInput {
	s.MaxKeys = &v
	return s
}

func (s *ListObjectVersionsInput) SetPrefix(v string) *ListObjectVersionsInput

SetPrefix sets the Prefix field's value.



16700
16701
16702
16703
 
// File 'service/s3/api.go', line 16700


func (s *ListObjectVersionsInput) SetPrefix(v string) *ListObjectVersionsInput {
	s.Prefix = &v
	return s
}

func (s *ListObjectVersionsInput) SetVersionIdMarker(v string) *ListObjectVersionsInput

SetVersionIdMarker sets the VersionIdMarker field's value.



16706
16707
16708
16709
 
// File 'service/s3/api.go', line 16706


func (s *ListObjectVersionsInput) SetVersionIdMarker(v string) *ListObjectVersionsInput {
	s.VersionIdMarker = &v
	return s
}

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



16627
16628
16629
 
// File 'service/s3/api.go', line 16627


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

func (s *ListObjectVersionsInput) Validate() error

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



16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
 
// File 'service/s3/api.go', line 16641


func (s *ListObjectVersionsInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "ListObjectVersionsInput"}
	if s.Bucket == nil {
		invalidParams.Add(request.NewErrParamRequired("Bucket"))
	}
	if s.Bucket != nil && len(*s.Bucket) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("Bucket", 1))
	}

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