Google Cloud Storage Transfer V1 Client - Class AwsS3CompatibleData (1.4.0)

Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class AwsS3CompatibleData.

An AwsS3CompatibleData resource.

Generated from protobuf message google.storagetransfer.v1.AwsS3CompatibleData

Namespace

Google \ Cloud \ StorageTransfer \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

↳ s3_metadata Google\Cloud\StorageTransfer\V1\S3CompatibleMetadata

A S3 compatible metadata.

getBucketName

Required. Specifies the name of the bucket.

Returns
TypeDescription
string

setBucketName

Required. Specifies the name of the bucket.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPath

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 '/'.

Returns
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getEndpoint

Required. Specifies the endpoint of the storage service.

Returns
TypeDescription
string

setEndpoint

Required. Specifies the endpoint of the storage service.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRegion

Specifies the region to sign requests with. This can be left blank if requests should be signed with an empty region.

Returns
TypeDescription
string

setRegion

Specifies the region to sign requests with. This can be left blank if requests should be signed with an empty region.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getS3Metadata

A S3 compatible metadata.

Returns
TypeDescription
Google\Cloud\StorageTransfer\V1\S3CompatibleMetadata|null

hasS3Metadata

setS3Metadata

A S3 compatible metadata.

Parameter
NameDescription
var Google\Cloud\StorageTransfer\V1\S3CompatibleMetadata
Returns
TypeDescription
$this

getDataProvider

Returns
TypeDescription
string