Struct: s3.ListObjectsOutput

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

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary collapse

Service Operations collapse

Structure Field Details

CommonPrefixes []*CommonPrefix `type:"list" flattened:"true"`

All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/), as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

Contents []*Object `type:"list" flattened:"true"`

Metadata about each object returned.

Delimiter *string `type:"string"`

Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

EncodingType *string `type:"string" enum:"EncodingType"`

Encoding type used by Amazon S3 to encode object keys in the response.

IBMSSEKPCrkId *string `location:"header" locationName:"ibm-sse-kp-customer-root-key-crn" type:"string"`

The root key used by Key Protect to encrypt this bucket. This value must be the full CRN of the root key.

IBMSSEKPEnabled *bool `location:"header" locationName:"ibm-sse-kp-enabled" type:"boolean"`

Specifies whether the Bucket has Key Protect enabled.

IsTruncated *bool `type:"boolean"`

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.

Marker *string `type:"string"`

Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

MaxKeys *int64 `type:"integer"`

The maximum number of keys returned in the response body.

Name *string `type:"string"`

The bucket name.

NextMarker *string `type:"string"`

When the response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as the marker parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.

This element is returned only if you have the delimiter request parameter specified. If the response does not include the NextMarker element and it is truncated, you can use the value of the last Key element in the response as the marker parameter in the subsequent request to get the next set of object keys.

Prefix *string `type:"string"`

Keys that begin with the indicated prefix.

_ struct{} `type:"structure"`

Method Details

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



17381
17382
17383
 
// File 'service/s3/api.go', line 17381


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

func (s *ListObjectsOutput) SetCommonPrefixes(v []*CommonPrefix) *ListObjectsOutput

SetCommonPrefixes sets the CommonPrefixes field’s value.



17386
17387
17388
17389
 
// File 'service/s3/api.go', line 17386


func (s *ListObjectsOutput) SetCommonPrefixes(v []*CommonPrefix) *ListObjectsOutput {
	s.CommonPrefixes = v
	return s
}

func (s *ListObjectsOutput) SetContents(v []*Object) *ListObjectsOutput

SetContents sets the Contents field’s value.



17392
17393
17394
17395
 
// File 'service/s3/api.go', line 17392


func (s *ListObjectsOutput) SetContents(v []*Object) *ListObjectsOutput {
	s.Contents = v
	return s
}

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

SetDelimiter sets the Delimiter field’s value.



17398
17399
17400
17401
 
// File 'service/s3/api.go', line 17398


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

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

SetEncodingType sets the EncodingType field’s value.



17404
17405
17406
17407
 
// File 'service/s3/api.go', line 17404


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

func (s *ListObjectsOutput) SetIBMSSEKPCrkId(v string) *ListObjectsOutput

SetIBMSSEKPCrkId sets the IBMSSEKPCrkId field’s value.



17410
17411
17412
17413
 
// File 'service/s3/api.go', line 17410


func (s *ListObjectsOutput) SetIBMSSEKPCrkId(v string) *ListObjectsOutput {
	s.IBMSSEKPCrkId = &v
	return s
}

func (s *ListObjectsOutput) SetIBMSSEKPEnabled(v bool) *ListObjectsOutput

SetIBMSSEKPEnabled sets the IBMSSEKPEnabled field’s value.



17416
17417
17418
17419
 
// File 'service/s3/api.go', line 17416


func (s *ListObjectsOutput) SetIBMSSEKPEnabled(v bool) *ListObjectsOutput {
	s.IBMSSEKPEnabled = &v
	return s
}

func (s *ListObjectsOutput) SetIsTruncated(v bool) *ListObjectsOutput

SetIsTruncated sets the IsTruncated field’s value.



17422
17423
17424
17425
 
// File 'service/s3/api.go', line 17422


func (s *ListObjectsOutput) SetIsTruncated(v bool) *ListObjectsOutput {
	s.IsTruncated = &v
	return s
}

func (s *ListObjectsOutput) SetMarker(v string) *ListObjectsOutput

SetMarker sets the Marker field’s value.



17428
17429
17430
17431
 
// File 'service/s3/api.go', line 17428


func (s *ListObjectsOutput) SetMarker(v string) *ListObjectsOutput {
	s.Marker = &v
	return s
}

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

SetMaxKeys sets the MaxKeys field’s value.



17434
17435
17436
17437
 
// File 'service/s3/api.go', line 17434


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

func (s *ListObjectsOutput) SetName(v string) *ListObjectsOutput

SetName sets the Name field’s value.



17440
17441
17442
17443
 
// File 'service/s3/api.go', line 17440


func (s *ListObjectsOutput) SetName(v string) *ListObjectsOutput {
	s.Name = &v
	return s
}

func (s *ListObjectsOutput) SetNextMarker(v string) *ListObjectsOutput

SetNextMarker sets the NextMarker field’s value.



17446
17447
17448
17449
 
// File 'service/s3/api.go', line 17446


func (s *ListObjectsOutput) SetNextMarker(v string) *ListObjectsOutput {
	s.NextMarker = &v
	return s
}

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

SetPrefix sets the Prefix field’s value.



17452
17453
17454
17455
 
// File 'service/s3/api.go', line 17452


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

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



17372
17373
17374
 
// File 'service/s3/api.go', line 17372


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