Google Cloud Storage Transfer V1 Client - Class AzureBlobStorageData (1.1.1)

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

An AzureBlobStorageData resource can be a data source, but not a data sink.

An AzureBlobStorageData resource represents one Azure container. The storage account determines the Azure endpoint. In an AzureBlobStorageData resource, a blobs's name is the Azure Blob Storage blob's key name.

Generated from protobuf message google.storagetransfer.v1.AzureBlobStorageData

Namespace

Google \ Cloud \ StorageTransfer \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ storage_account string

Required. The name of the Azure Storage account.

↳ azure_credentials Google\Cloud\StorageTransfer\V1\AzureCredentials

Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see User credentials.

↳ container string

Required. The container to transfer from the Azure Storage account.

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

getStorageAccount

Required. The name of the Azure Storage account.

Returns
TypeDescription
string

setStorageAccount

Required. The name of the Azure Storage account.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAzureCredentials

Required. Input only. Credentials used to authenticate API requests to Azure.

For information on our data retention policy for user credentials, see User credentials.

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

hasAzureCredentials

clearAzureCredentials

setAzureCredentials

Required. Input only. Credentials used to authenticate API requests to Azure.

For information on our data retention policy for user credentials, see User credentials.

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

getContainer

Required. The container to transfer from the Azure Storage account.

Returns
TypeDescription
string

setContainer

Required. The container to transfer from the Azure Storage account.

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this