ObjectPrefix Property

A prefix used to restrict the results returned when listing objects.

Object Oriented Interface

public function getObjectPrefix();
public function setObjectPrefix($value);

Procedural Interface

ipworkss3_s3client_get($res, 29 );
ipworkss3_s3client_set($res, 29, $value );

Default Value

''

Remarks

This property, if non-empty, is used to restrict the results returned by ListObjects (or ListVersions) to only the objects (or object versions) whose names begin with the given value.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

  • MyCompany
  • MyCompany/Department1
  • MyCompany/Department2
  • MyCompany/Department2/EmployeeA
  • MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

ObjectPrefix Value Objects Returned Prefixes Returned
(empty) MyCompany MyCompany/
MyCompany/ MyCompany/Department1
MyCompany/Department2
MyCompany/Department2/
MyCompany/Department2/ MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB
(none)

This property is not available at design time.

Data Type

String

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks S3 2020 PHP Edition - Version 20.0 [Build 7722]