Google Cloud Storage Transfer V1 Client - Class AzureBlobStorageData (2.0.0-RC1)

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
Name	Description
`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 '/'.
`↳ credentials_secret`	`string` Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "`SAS_TOKEN`" } GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See Configure access to a source: Microsoft Azure Blob Storage for more information. If `credentials_secret` is specified, do not specify azure_credentials. This feature is in preview. Format: `projects/{project_number}/secrets/{secret_name}`

getStorageAccount

Required. The name of the Azure Storage account.

Returns
Type	Description
`string`

setStorageAccount

Required. The name of the Azure Storage account.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`Google\Cloud\StorageTransfer\V1\AzureCredentials`

Returns
Type	Description
`$this`

getContainer

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

Returns
Type	Description
`string`

setContainer

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCredentialsSecret

Optional. The Resource name of a secret in Secret Manager.

The Azure SAS token must be stored in Secret Manager in JSON format:

{
 "sas_token" : "SAS_TOKEN"
}

GoogleServiceAccount must be granted roles/secretmanager.secretAccessor for the resource. See Configure access to a source: Microsoft Azure Blob Storage for more information. If credentials_secret is specified, do not specify azure_credentials. This feature is in preview. Format: projects/{project_number}/secrets/{secret_name}

Returns
Type	Description
`string`

setCredentialsSecret

Optional. The Resource name of a secret in Secret Manager.

The Azure SAS token must be stored in Secret Manager in JSON format:

{
 "sas_token" : "SAS_TOKEN"
}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`