Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class AwsS3CompatibleData.
An AwsS3CompatibleData resource.
Generated from protobuf messagegoogle.storagetransfer.v1.AwsS3CompatibleData
Namespace
Google \ Cloud \ StorageTransfer \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ bucket_name
string
Required. Specifies the name of the bucket.
↳ path
string
Specifies the root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.
↳ endpoint
string
Required. Specifies the endpoint of the storage service.
↳ region
string
Specifies the region to sign requests with. This can be left blank if requests should be signed with an empty region.
Must be an empty string or full path name that ends with a '/'. This
field is treated as an object prefix. As such, it should generally not
begin with a '/'.
Returns
Type
Description
string
setPath
Specifies the root path to transfer objects.
Must be an empty string or full path name that ends with a '/'. This
field is treated as an object prefix. As such, it should generally not
begin with a '/'.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEndpoint
Required. Specifies the endpoint of the storage service.
Returns
Type
Description
string
setEndpoint
Required. Specifies the endpoint of the storage service.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRegion
Specifies the region to sign requests with. This can be left blank if
requests should be signed with an empty region.
Returns
Type
Description
string
setRegion
Specifies the region to sign requests with. This can be left blank if
requests should be signed with an empty region.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Storage Transfer V1 Client - Class AwsS3CompatibleData (2.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.1 (latest)](/php/docs/reference/cloud-storage-transfer/latest/V1.AwsS3CompatibleData)\n- [2.2.0](/php/docs/reference/cloud-storage-transfer/2.2.0/V1.AwsS3CompatibleData)\n- [2.1.1](/php/docs/reference/cloud-storage-transfer/2.1.1/V1.AwsS3CompatibleData)\n- [2.0.2](/php/docs/reference/cloud-storage-transfer/2.0.2/V1.AwsS3CompatibleData)\n- [1.5.0](/php/docs/reference/cloud-storage-transfer/1.5.0/V1.AwsS3CompatibleData)\n- [1.4.5](/php/docs/reference/cloud-storage-transfer/1.4.5/V1.AwsS3CompatibleData)\n- [1.3.1](/php/docs/reference/cloud-storage-transfer/1.3.1/V1.AwsS3CompatibleData)\n- [1.2.0](/php/docs/reference/cloud-storage-transfer/1.2.0/V1.AwsS3CompatibleData)\n- [1.1.1](/php/docs/reference/cloud-storage-transfer/1.1.1/V1.AwsS3CompatibleData)\n- [1.0.6](/php/docs/reference/cloud-storage-transfer/1.0.6/V1.AwsS3CompatibleData) \nReference documentation and code samples for the Google Cloud Storage Transfer V1 Client class AwsS3CompatibleData.\n\nAn AwsS3CompatibleData resource.\n\nGenerated from protobuf message `google.storagetransfer.v1.AwsS3CompatibleData`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ StorageTransfer \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBucketName\n\nRequired. Specifies the name of the bucket.\n\n### setBucketName\n\nRequired. Specifies the name of the bucket.\n\n### getPath\n\nSpecifies the root path to transfer objects.\n\nMust be an empty string or full path name that ends with a '/'. This\nfield is treated as an object prefix. As such, it should generally not\nbegin with a '/'.\n\n### setPath\n\nSpecifies the root path to transfer objects.\n\nMust be an empty string or full path name that ends with a '/'. This\nfield is treated as an object prefix. As such, it should generally not\nbegin with a '/'.\n\n### getEndpoint\n\nRequired. Specifies the endpoint of the storage service.\n\n### setEndpoint\n\nRequired. Specifies the endpoint of the storage service.\n\n### getRegion\n\nSpecifies the region to sign requests with. This can be left blank if\nrequests should be signed with an empty region.\n\n### setRegion\n\nSpecifies the region to sign requests with. This can be left blank if\nrequests should be signed with an empty region.\n\n### getS3Metadata\n\nA S3 compatible metadata.\n\n### hasS3Metadata\n\n### setS3Metadata\n\nA S3 compatible metadata.\n\n### getDataProvider"]]
