OBSListObjectsRequest Class Reference

Inherits from OBSCORSRequest : OBSBaseRequest : OBSAbstractModel : OBSMTLModel
Conforms to OBSListObjectsProtocol
Declared in OBSListObjectsModel.h
OBSListObjectsModel.m

Overview

Request for listing objects in a bucket

  bucketName

Bucket name

@property (nonatomic, strong, nonnull) NSString *bucketName

Declared In

OBSListObjectsModel.h

  prefix

Name prefix. Only objects whose names start with the prefix will be listed.

@property (nonatomic, strong, nonnull) NSString *prefix

Declared In

OBSListObjectsModel.h

  marker

Marker from which the listing begins in alphabetical order

@property (nonatomic, strong, nonnull) NSString *marker

Declared In

OBSListObjectsModel.h

  maxKeys

Maximum number of objects that will be returned. The value ranges from 1 to 1000. If you set a value larger than 1000, only 1000 objects will be returned.

@property (nonatomic, strong, nonnull) NSNumber *maxKeys

Declared In

OBSListObjectsModel.h

  delimiter

Character string used to group objects in the bucket. If you specify a prefix, all objects that contain the same string between the prefix and the first occurrence of the delimiter after the prefix are grouped under a single result element called “CommonPrefixes”.

@property (nonatomic, strong, nonnull) NSString *delimiter

Declared In

OBSListObjectsModel.h

  versionID

Version ID to start with when listing objects in a bucket. All objects are listed in alphabetical order. This parameter is used together with the “keyMarker” in the response. If the values of “VersionIdMarker” and “KeyMarker” are inconsistent, this parameter is ineffective.

@property (nonatomic, strong, nonnull) NSString *versionID

Declared In

OBSListObjectsModel.h

– initWithBucketName:

Initialize a request for listing objects in a bucket.

- (instancetype)initWithBucketName:(NSString *)bucketName

Parameters

bucketName

Bucket name

Return Value

Request for listing objects in a bucket

Declared In

OBSListObjectsModel.h