Data.Cloud.AmazonAPI.TAmazonStorageService.GetObjectMetadata

From RAD Studio API Documentation
Jump to: navigation, search

Delphi 

function GetObjectMetadata(const BucketName, ObjectName: string; OptionalParams: TAmazonGetObjectOptionals;  ResponseInfo: TCloudResponseInfo = nil; BucketRegion: TAmazonRegion = amzrNotSpecified): TStrings; overload;
function GetObjectMetadata(const BucketName, ObjectName: string;  ResponseInfo: TCloudResponseInfo = nil; BucketRegion: TAmazonRegion = amzrNotSpecified): TStrings; overload;

C++ 

System::Classes::TStrings* __fastcall GetObjectMetadata(const System::UnicodeString BucketName, const System::UnicodeString ObjectName, const TAmazonGetObjectOptionals &OptionalParams, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), TAmazonRegion BucketRegion = (TAmazonRegion)(0x0))/* overload */;
System::Classes::TStrings* __fastcall GetObjectMetadata(const System::UnicodeString BucketName, const System::UnicodeString ObjectName, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), TAmazonRegion BucketRegion = (TAmazonRegion)(0x0))/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
 Data.Cloud.AmazonAPI TAmazonStorageService

Description

Returns the metadata for the specified object.

There are two GetObjectMetadata overloaded methods. To control the request, use the first one with the OptionalParams parameter.

GetObjectMetadata returns an empty list if no metadata was included in the object. The Response* fields of the OptionalParams instance are not used in this call.

The method returns the metadata key/value pairs, or nil if the request fails.

The following table shows the significance of the parameters:

Parameter Description

BucketName

The name of the bucket the object is in.

ObjectName

The name of the object to get metadata for.

OptionalParams

The optional parameters or headers to use in the request.

ResponseInfo

The optional class for storing response info into.

See Also

Retrieved from "http://docwiki.embarcadero.com/Libraries/Rio/e/index.php?title=Data.Cloud.AmazonAPI.TAmazonStorageService.GetObjectMetadata&oldid=158162"