Google Cloud Storage Transfer V1 Client - Class GcsData (1.0.6)

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

In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's updated property of Cloud Storage objects, which changes when the content or the metadata of the object is updated.

Generated from protobuf message google.storagetransfer.v1.GcsData

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ bucket_name string

Required. Cloud Storage bucket name. Must meet Bucket Name Requirements.

↳ path string

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 '/'. The root path value must meet Object Name Requirements.

getBucketName

Required. Cloud Storage bucket name. Must meet Bucket Name Requirements.

Returns
TypeDescription
string

setBucketName

Required. Cloud Storage bucket name. Must meet Bucket Name Requirements.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPath

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 '/'. The root path value must meet Object Name Requirements.

Returns
TypeDescription
string

setPath

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 '/'. The root path value must meet Object Name Requirements.

Parameter
NameDescription
var string
Returns
TypeDescription
$this