org.apache.beam.sdk.io.azure.options

Interface BlobstoreOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

public interface BlobstoreOptions
extends PipelineOptions

Options used to configure Microsoft Azure Blob Storage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BlobstoreOptions.AzureUserCredentialsFactory Attempts to load Azure credentials.

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions

PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessKey()
java.lang.String	getAccountName()
java.lang.String	getAzureConnectionString()
com.azure.core.credential.TokenCredential	getAzureCredentialsProvider() The credential instance that should be used to authenticate against Azure services.
@Nullable java.lang.String	getBlobServiceEndpoint() The Azure Blobstore service endpoint used by the Blob service client.
java.lang.Class<? extends BlobstoreClientBuilderFactory>	getBlobstoreClientFactoryClass()
com.azure.storage.blob.models.CustomerProvidedKey	getCustomerProvidedKey()
@Nullable com.azure.core.http.HttpClient	getHttpClient()
@Nullable com.azure.core.http.HttpPipeline	getHttpPipeline()
@Nullable com.azure.core.http.policy.HttpPipelinePolicy	getPipelinePolicy()
java.lang.String	getSasToken()
void	setAccessKey(java.lang.String key)
void	setAccountName(java.lang.String name)
void	setAzureConnectionString(java.lang.String connectionString)
void	setAzureCredentialsProvider(com.azure.core.credential.TokenCredential value)
void	setBlobServiceEndpoint(java.lang.String endpoint)
void	setBlobstoreClientFactoryClass(java.lang.Class<? extends BlobstoreClientBuilderFactory> blobstoreClientFactoryClass)
void	setCustomerProvidedKey(com.azure.storage.blob.models.CustomerProvidedKey customerProvidedKey)
void	setHttpClient(com.azure.core.http.HttpClient httpClient)
void	setHttpPipeline(com.azure.core.http.HttpPipeline httpPipeline)
void	setPipelinePolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
void	setSasToken(java.lang.String sasToken)

Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions

as, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData

populateDisplayData

Method Detail

getBlobstoreClientFactoryClass

@Default.Class(value=DefaultBlobstoreClientBuilderFactory.class)
java.lang.Class<? extends BlobstoreClientBuilderFactory> getBlobstoreClientFactoryClass()

setBlobstoreClientFactoryClass

void setBlobstoreClientFactoryClass(java.lang.Class<? extends BlobstoreClientBuilderFactory> blobstoreClientFactoryClass)

getPipelinePolicy

@Nullable com.azure.core.http.policy.HttpPipelinePolicy getPipelinePolicy()

setPipelinePolicy

void setPipelinePolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)

getAzureConnectionString

java.lang.String getAzureConnectionString()

setAzureConnectionString

void setAzureConnectionString(java.lang.String connectionString)

getSasToken

java.lang.String getSasToken()

setSasToken

void setSasToken(java.lang.String sasToken)

getAccountName

java.lang.String getAccountName()

setAccountName

void setAccountName(java.lang.String name)

getAccessKey

java.lang.String getAccessKey()

setAccessKey

void setAccessKey(java.lang.String key)

getCustomerProvidedKey

com.azure.storage.blob.models.CustomerProvidedKey getCustomerProvidedKey()

setCustomerProvidedKey

void setCustomerProvidedKey(com.azure.storage.blob.models.CustomerProvidedKey customerProvidedKey)

getBlobServiceEndpoint

@Nullable java.lang.String getBlobServiceEndpoint()

The Azure Blobstore service endpoint used by the Blob service client.

setBlobServiceEndpoint

void setBlobServiceEndpoint(java.lang.String endpoint)

getHttpClient

@Nullable com.azure.core.http.HttpClient getHttpClient()

setHttpClient

void setHttpClient(com.azure.core.http.HttpClient httpClient)

getHttpPipeline

@Nullable com.azure.core.http.HttpPipeline getHttpPipeline()

setHttpPipeline

void setHttpPipeline(com.azure.core.http.HttpPipeline httpPipeline)

getAzureCredentialsProvider

@Default.InstanceFactory(value=BlobstoreOptions.AzureUserCredentialsFactory.class)
com.azure.core.credential.TokenCredential getAzureCredentialsProvider()

The credential instance that should be used to authenticate against Azure services. The option value must contain a "@type" field and an Azure credentials provider class as the field value.

For example, to specify the Azure client id, tenant id, and client secret, specify the following: {"@type" : "ClientSecretCredential", "azureClientId": "client_id_value", "azureTenantId": "tenant_id_value", "azureClientSecret": "client_secret_value"}

setAzureCredentialsProvider

void setAzureCredentialsProvider(com.azure.core.credential.TokenCredential value)