Package com.google.storagetransfer.v1.proto

Interface TransferTypes.AzureBlobStorageDataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TransferTypes.AzureBlobStorageData, TransferTypes.AzureBlobStorageData.Builder
Enclosing class:
TransferTypes
public static interface TransferTypes.AzureBlobStorageDataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getStorageAccount

      String getStorageAccount()
       Required. The name of the Azure Storage account.
      string storage_account = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The storageAccount.

    • getStorageAccountBytes

      com.google.protobuf.ByteString getStorageAccountBytes()
       Required. The name of the Azure Storage account.
      string storage_account = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for storageAccount.

    • hasAzureCredentials

      boolean hasAzureCredentials()
       Required. Input only. Credentials used to authenticate API requests to
 Azure.

 For information on our data retention policy for user credentials, see
 [User credentials](/storage-transfer/docs/data-retention#user-credentials).
      .google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
      Returns:
      Whether the azureCredentials field is set.

    • getAzureCredentials

      TransferTypes.AzureCredentials 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](/storage-transfer/docs/data-retention#user-credentials).
      .google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
      Returns:
      The azureCredentials.

    • getAzureCredentialsOrBuilder

      TransferTypes.AzureCredentialsOrBuilder getAzureCredentialsOrBuilder()
       Required. Input only. Credentials used to authenticate API requests to
 Azure.

 For information on our data retention policy for user credentials, see
 [User credentials](/storage-transfer/docs/data-retention#user-credentials).
      .google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

    • getContainer

      String getContainer()
       Required. The container to transfer from the Azure Storage account.
      string container = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The container.

    • getContainerBytes

      com.google.protobuf.ByteString getContainerBytes()
       Required. The container to transfer from the Azure Storage account.
      string container = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for container.

    • getPath

      String 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 '/'.
      string path = 5;
      Returns:
      The path.

    • getPathBytes

      com.google.protobuf.ByteString getPathBytes()
       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 '/'.
      string path = 5;
      Returns:
      The bytes for path.

    • getCredentialsSecret

      String 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][google.storagetransfer.v1.GoogleServiceAccount] must
 be granted `roles/secretmanager.secretAccessor` for the resource.

 See [Configure access to a source: Microsoft Azure Blob Storage]
 (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager)
 for more information.

 If `credentials_secret` is specified, do not specify
 [azure_credentials][google.storagetransfer.v1.AzureBlobStorageData.azure_credentials].

 Format: `projects/{project_number}/secrets/{secret_name}`
      string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The credentialsSecret.

    • getCredentialsSecretBytes

      com.google.protobuf.ByteString getCredentialsSecretBytes()
       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][google.storagetransfer.v1.GoogleServiceAccount] must
 be granted `roles/secretmanager.secretAccessor` for the resource.

 See [Configure access to a source: Microsoft Azure Blob Storage]
 (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager)
 for more information.

 If `credentials_secret` is specified, do not specify
 [azure_credentials][google.storagetransfer.v1.AzureBlobStorageData.azure_credentials].

 Format: `projects/{project_number}/secrets/{secret_name}`
      string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for credentialsSecret.

    • hasFederatedIdentityConfig

      boolean hasFederatedIdentityConfig()
       Optional. Federated identity config of a user registered Azure application.

 If `federated_identity_config` is specified, do not specify
 [azure_credentials][google.storagetransfer.v1.AzureBlobStorageData.azure_credentials]
 or
 [credentials_secret][google.storagetransfer.v1.AzureBlobStorageData.credentials_secret].
      .google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the federatedIdentityConfig field is set.

    • getFederatedIdentityConfig

      TransferTypes.AzureBlobStorageData.FederatedIdentityConfig getFederatedIdentityConfig()
       Optional. Federated identity config of a user registered Azure application.

 If `federated_identity_config` is specified, do not specify
 [azure_credentials][google.storagetransfer.v1.AzureBlobStorageData.azure_credentials]
 or
 [credentials_secret][google.storagetransfer.v1.AzureBlobStorageData.credentials_secret].
      .google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The federatedIdentityConfig.

    • getFederatedIdentityConfigOrBuilder

      TransferTypes.AzureBlobStorageData.FederatedIdentityConfigOrBuilder getFederatedIdentityConfigOrBuilder()
       Optional. Federated identity config of a user registered Azure application.

 If `federated_identity_config` is specified, do not specify
 [azure_credentials][google.storagetransfer.v1.AzureBlobStorageData.azure_credentials]
 or
 [credentials_secret][google.storagetransfer.v1.AzureBlobStorageData.credentials_secret].
      .google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];