Class TransferTypes.AzureBlobStorageData.Builder (1.85.0) 

public static final class TransferTypes.AzureBlobStorageData.Builder extends GeneratedMessage.Builder<TransferTypes.AzureBlobStorageData.Builder> implements TransferTypes.AzureBlobStorageDataOrBuilder

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.

Protobuf type google.storagetransfer.v1.AzureBlobStorageData

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > TransferTypes.AzureBlobStorageData.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public TransferTypes.AzureBlobStorageData build()
Returns
Type Description
TransferTypes.AzureBlobStorageData

buildPartial()

public TransferTypes.AzureBlobStorageData buildPartial()
Returns
Type Description
TransferTypes.AzureBlobStorageData

clear()

public TransferTypes.AzureBlobStorageData.Builder clear()
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder
Overrides

clearAzureCredentials()

public TransferTypes.AzureBlobStorageData.Builder clearAzureCredentials()

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

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

.google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

clearContainer()

public TransferTypes.AzureBlobStorageData.Builder clearContainer()

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

string container = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.

clearCredentialsSecret()

public TransferTypes.AzureBlobStorageData.Builder clearCredentialsSecret()

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.

Format: projects/{project_number}/secrets/{secret_name}

string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.

clearFederatedIdentityConfig()

public TransferTypes.AzureBlobStorageData.Builder clearFederatedIdentityConfig()

Optional. Federated identity config of a user registered Azure application.

If federated_identity_config is specified, do not specify azure_credentials or credentials_secret.

.google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

clearPath()

public TransferTypes.AzureBlobStorageData.Builder clearPath()

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
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.

clearStorageAccount()

public TransferTypes.AzureBlobStorageData.Builder clearStorageAccount()

Required. The name of the Azure Storage account.

string storage_account = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.

getAzureCredentials()

public 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.

.google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
TransferTypes.AzureCredentials

The azureCredentials.

getAzureCredentialsBuilder()

public TransferTypes.AzureCredentials.Builder getAzureCredentialsBuilder()

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

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

.google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
TransferTypes.AzureCredentials.Builder

getAzureCredentialsOrBuilder()

public 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.

.google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
TransferTypes.AzureCredentialsOrBuilder

getContainer()

public String getContainer()

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

string container = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The container.

getContainerBytes()

public ByteString getContainerBytes()

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

string container = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for container.

getCredentialsSecret()

public 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 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.

Format: projects/{project_number}/secrets/{secret_name}

string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The credentialsSecret.

getCredentialsSecretBytes()

public 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 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.

Format: projects/{project_number}/secrets/{secret_name}

string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for credentialsSecret.

getDefaultInstanceForType()

public TransferTypes.AzureBlobStorageData getDefaultInstanceForType()
Returns
Type Description
TransferTypes.AzureBlobStorageData

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFederatedIdentityConfig()

public 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 or credentials_secret.

.google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransferTypes.AzureBlobStorageData.FederatedIdentityConfig

The federatedIdentityConfig.

getFederatedIdentityConfigBuilder()

public TransferTypes.AzureBlobStorageData.FederatedIdentityConfig.Builder getFederatedIdentityConfigBuilder()

Optional. Federated identity config of a user registered Azure application.

If federated_identity_config is specified, do not specify azure_credentials or credentials_secret.

.google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransferTypes.AzureBlobStorageData.FederatedIdentityConfig.Builder

getFederatedIdentityConfigOrBuilder()

public 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 or credentials_secret.

.google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransferTypes.AzureBlobStorageData.FederatedIdentityConfigOrBuilder

getPath()

public 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
Type Description
String

The path.

getPathBytes()

public 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
Type Description
ByteString

The bytes for path.

getStorageAccount()

public String getStorageAccount()

Required. The name of the Azure Storage account.

string storage_account = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The storageAccount.

getStorageAccountBytes()

public ByteString getStorageAccountBytes()

Required. The name of the Azure Storage account.

string storage_account = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for storageAccount.

hasAzureCredentials()

public 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.

.google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the azureCredentials field is set.

hasFederatedIdentityConfig()

public boolean hasFederatedIdentityConfig()

Optional. Federated identity config of a user registered Azure application.

If federated_identity_config is specified, do not specify azure_credentials or credentials_secret.

.google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the federatedIdentityConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAzureCredentials(TransferTypes.AzureCredentials value)

public TransferTypes.AzureBlobStorageData.Builder mergeAzureCredentials(TransferTypes.AzureCredentials value)

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

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

.google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value TransferTypes.AzureCredentials
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

mergeFederatedIdentityConfig(TransferTypes.AzureBlobStorageData.FederatedIdentityConfig value)

public TransferTypes.AzureBlobStorageData.Builder mergeFederatedIdentityConfig(TransferTypes.AzureBlobStorageData.FederatedIdentityConfig value)

Optional. Federated identity config of a user registered Azure application.

If federated_identity_config is specified, do not specify azure_credentials or credentials_secret.

.google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value TransferTypes.AzureBlobStorageData.FederatedIdentityConfig
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransferTypes.AzureBlobStorageData.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TransferTypes.AzureBlobStorageData.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder
Overrides

mergeFrom(TransferTypes.AzureBlobStorageData other)

public TransferTypes.AzureBlobStorageData.Builder mergeFrom(TransferTypes.AzureBlobStorageData other)
Parameter
Name Description
other TransferTypes.AzureBlobStorageData
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

setAzureCredentials(TransferTypes.AzureCredentials value)

public TransferTypes.AzureBlobStorageData.Builder setAzureCredentials(TransferTypes.AzureCredentials value)

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

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

.google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value TransferTypes.AzureCredentials
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

setAzureCredentials(TransferTypes.AzureCredentials.Builder builderForValue)

public TransferTypes.AzureBlobStorageData.Builder setAzureCredentials(TransferTypes.AzureCredentials.Builder builderForValue)

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

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

.google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
builderForValue TransferTypes.AzureCredentials.Builder
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

setContainer(String value)

public TransferTypes.AzureBlobStorageData.Builder setContainer(String value)

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

string container = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The container to set.
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.

setContainerBytes(ByteString value)

public TransferTypes.AzureBlobStorageData.Builder setContainerBytes(ByteString value)

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

string container = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for container to set.
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.

setCredentialsSecret(String value)

public TransferTypes.AzureBlobStorageData.Builder setCredentialsSecret(String value)

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.

Format: projects/{project_number}/secrets/{secret_name}

string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The credentialsSecret to set.
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.

setCredentialsSecretBytes(ByteString value)

public TransferTypes.AzureBlobStorageData.Builder setCredentialsSecretBytes(ByteString value)

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.

Format: projects/{project_number}/secrets/{secret_name}

string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for credentialsSecret to set.
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.

setFederatedIdentityConfig(TransferTypes.AzureBlobStorageData.FederatedIdentityConfig value)

public TransferTypes.AzureBlobStorageData.Builder setFederatedIdentityConfig(TransferTypes.AzureBlobStorageData.FederatedIdentityConfig value)

Optional. Federated identity config of a user registered Azure application.

If federated_identity_config is specified, do not specify azure_credentials or credentials_secret.

.google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value TransferTypes.AzureBlobStorageData.FederatedIdentityConfig
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

setFederatedIdentityConfig(TransferTypes.AzureBlobStorageData.FederatedIdentityConfig.Builder builderForValue)

public TransferTypes.AzureBlobStorageData.Builder setFederatedIdentityConfig(TransferTypes.AzureBlobStorageData.FederatedIdentityConfig.Builder builderForValue)

Optional. Federated identity config of a user registered Azure application.

If federated_identity_config is specified, do not specify azure_credentials or credentials_secret.

.google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue TransferTypes.AzureBlobStorageData.FederatedIdentityConfig.Builder
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

setPath(String value)

public TransferTypes.AzureBlobStorageData.Builder setPath(String value)

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;

Parameter
Name Description
value String

The path to set.
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.

setPathBytes(ByteString value)

public TransferTypes.AzureBlobStorageData.Builder setPathBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for path to set.
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.

setStorageAccount(String value)

public TransferTypes.AzureBlobStorageData.Builder setStorageAccount(String value)

Required. The name of the Azure Storage account.

string storage_account = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The storageAccount to set.
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.

setStorageAccountBytes(ByteString value)

public TransferTypes.AzureBlobStorageData.Builder setStorageAccountBytes(ByteString value)

Required. The name of the Azure Storage account.

string storage_account = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for storageAccount to set.
Returns
Type Description
TransferTypes.AzureBlobStorageData.Builder

This builder for chaining.