CloudBlobClient クラス

パッケージ:

com.microsoft.azure.storage.blob

• java.lang.Object
• • ServiceClient
  • • com.microsoft.azure.storage.blob.CloudBlobClient

public class CloudBlobClient extends ServiceClient

Microsoft Azure Blob サービスにアクセスするためのクライアントを提供します。

このクラスは、BLOB サービスへのアクセスポイントを提供します。 サービス クライアントは BLOB サービスのベース URI をカプセル化します。 また、認証済みアクセスに使用される場合、ストレージ アカウントにアクセスするための資格情報もカプセル化します。

コンストラクターの概要

コンストラクター	説明
CloudBlobClient(final StorageUri baseUri)	指定した BLOB サービス エンドポイントと匿名資格情報を使用して、 クラスのインスタンスを作成します。
CloudBlobClient(final StorageUri storageUri, StorageCredentials credentials)	指定した BLOB サービス エンドポイントとアカウント資格情報を使用して、 クラスのインスタンスを作成します。
CloudBlobClient(final URI baseUri)	指定した BLOB サービス エンドポイントと匿名資格情報を使用して、 クラスのインスタンスを作成します。
CloudBlobClient(final URI baseUri, StorageCredentials credentials)	指定した BLOB サービス エンドポイントとアカウント資格情報を使用して、 クラスのインスタンスを作成します。

メソッドの概要

修飾子と型	メソッドと説明
AccountInformation	downloadAccountInfo() ストレージ アカウントに関連する情報を取得します。
AccountInformation	downloadAccountInfo(BlobRequestOptions options, OperationContext opContext) ストレージ アカウントに関連する情報を取得します。
StorageRequest<ServiceClient, Void, AccountInformation>	downloadAccountInformationImpl(final RequestOptions options)
final ServiceProperties	downloadServiceProperties() 指定されたストレージ サービスの現在 ServiceProperties の を取得します。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。
final ServiceProperties	downloadServiceProperties(BlobRequestOptions options, OperationContext opContext) 指定されたストレージ サービスの現在 ServiceProperties の を取得します。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。
<P, T> Map<P, T>	executeBatch(BlobBatchOperation<P, T> batch) BLOB サービスに対して事前構築されたバッチ操作を実行します。 BLOB バッチ要求の構築の詳細については、「」を参照してください BlobBatchOperation<P,R>。
<P, T> Map<P, T>	executeBatch(BlobBatchOperation<P, T> batch, BlobRequestOptions requestOptions, OperationContext operationContext) BLOB サービスに対して事前構築されたバッチ操作を実行します。 BLOB バッチ要求の構築の詳細については、「」を参照してください BlobBatchOperation<P,R>。
CloudBlobContainer	getContainerReference(final String containerName) 指定した名前の CloudBlobContainer オブジェクトを取得します。
BlobRequestOptions	getDefaultRequestOptions() BlobRequestOptionsこれに関連付けられている要求に使用される を取得します。
String	getDirectoryDelimiter() クラウド BLOB ディレクトリに使用される既定の区切り記号の値を返します。 既定値は '/' です。
ServiceStats	getServiceStats() のサービスに対してクエリを実行します ServiceStats。
ServiceStats	getServiceStats(BlobRequestOptions options, OperationContext opContext) 特定のストレージ サービスに 対して を照会します ServiceStats。
UserDelegationKey	getUserDelegationKey(Date keyStart, Date keyEnd) このクライアントの oauth 資格情報に基づいて、新しいユーザー委任キーを要求します。
UserDelegationKey	getUserDelegationKey(Date keyStart, Date keyEnd, BlobRequestOptions options, OperationContext opContext) このクライアントの oauth 資格情報に基づいて、新しいユーザー委任キーを要求します。
boolean	isUsePathStyleUris() パス スタイル URI が使用されているかどうかを示します。
Iterable<CloudBlobContainer>	listContainers() この BLOB サービス クライアントの BLOB コンテナーの列挙可能なコレクションを返します。
Iterable<CloudBlobContainer>	listContainers(final String prefix) この BLOB サービス クライアントの指定したプレフィックスで始まる名前を持つ BLOB コンテナーの列挙可能なコレクションを返します。
Iterable<CloudBlobContainer>	listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext) 指定した詳細設定、要求オプション、操作コンテキストを使用して、この BLOB サービス クライアントの指定したプレフィックスで始まる名前を持つ BLOB コンテナーの列挙可能なコレクションを返します。
ResultSegment<CloudBlobContainer>	listContainersSegmented() この BLOB サービス クライアントの BLOB コンテナーの列挙可能なコレクションの結果セグメントを返します。
ResultSegment<CloudBlobContainer>	listContainersSegmented(final String prefix) この BLOB サービス クライアントの指定したプレフィックスで始まる名前を持つ BLOB コンテナーの列挙可能なコレクションの結果セグメントを返します。
ResultSegment<CloudBlobContainer>	listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext) 指定したリストの詳細オプション、要求オプション、操作コンテキストを使用して、この BLOB サービス クライアントの指定したプレフィックスで始まる名前を持つ BLOB コンテナーの列挙可能なコレクションの結果セグメントを返します。
void	setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions) このオブジェクトに BlobRequestOptions 関連付けられている要求に使用される を設定します。
void	setDirectoryDelimiter(final String directoryDelimiter) クラウド BLOB ディレクトリに使用される既定の区切り記号の値を設定します。
void	uploadServiceProperties(final ServiceProperties properties) 指定されたストレージ サービスに新しい ServiceProperties 構成をアップロードします。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。
void	uploadServiceProperties(final ServiceProperties properties, BlobRequestOptions options, OperationContext opContext) 指定されたストレージ サービスに新しい ServiceProperties 構成をアップロードします。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。

継承メンバー

ServiceClient.credentials ServiceClient.downloadServicePropertiesImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getCredentials() ServiceClient.getEndpoint() ServiceClient.getServiceStatsImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getStorageUri() ServiceClient.ServiceClient(final StorageUri storageUri, final StorageCredentials credentials) ServiceClient.setCredentials(final StorageCredentials credentials) ServiceClient.setStorageUri(final StorageUri storageUri) ServiceClient.uploadServicePropertiesImpl(final ServiceProperties properties, final RequestOptions options, final OperationContext opContext, final boolean signAsTable)

コンストラクターの詳細

CloudBlobClient

public CloudBlobClient(final StorageUri baseUri)

指定した BLOB サービス エンドポイントと匿名資格情報を使用して、 クラスのインスタンスを作成します。

Parameters:

baseUri - クライアントの StorageUri 作成に使用される BLOB サービス エンドポイントを表す オブジェクト。

CloudBlobClient

public CloudBlobClient(final StorageUri storageUri, StorageCredentials credentials)

指定した BLOB サービス エンドポイントとアカウント資格情報を使用して、 クラスのインスタンスを作成します。

Parameters:

storageUri - クライアントの StorageUri 作成に使用される BLOB サービス エンドポイントを表す オブジェクト。

credentials - StorageCredentialsアカウントの資格情報を表す オブジェクト。

CloudBlobClient

public CloudBlobClient(final URI baseUri)

指定した BLOB サービス エンドポイントと匿名資格情報を使用して、 クラスのインスタンスを作成します。

Parameters:

baseUri - クライアントの java.net.URI 作成に使用される BLOB サービス エンドポイントを表す オブジェクト。

CloudBlobClient

public CloudBlobClient(final URI baseUri, StorageCredentials credentials)

指定した BLOB サービス エンドポイントとアカウント資格情報を使用して、 クラスのインスタンスを作成します。

Parameters:

baseUri - クライアントの java.net.URI 作成に使用される BLOB サービス エンドポイントを表す オブジェクト。

credentials - StorageCredentialsアカウントの資格情報を表す オブジェクト。

メソッドの詳細

downloadAccountInfo

public AccountInformation downloadAccountInfo()

ストレージ アカウントに関連する情報を取得します。

Returns:

AccountInformation指定されたストレージ アカウントの オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

downloadAccountInfo

public AccountInformation downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)

ストレージ アカウントに関連する情報を取得します。

Parameters:

options - BlobRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

AccountInformation指定されたストレージ アカウントの オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

downloadAccountInformationImpl

protected StorageRequest downloadAccountInformationImpl(final RequestOptions options)

Parameters:

options

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

指定されたストレージ サービスの現在 ServiceProperties の を取得します。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。

Returns:

サービスの ServiceProperties 現在の構成を表す オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(BlobRequestOptions options, OperationContext opContext)

指定されたストレージ サービスの現在 ServiceProperties の を取得します。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。

Parameters:

options - BlobRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

サービスの ServiceProperties 現在の構成を表す オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

executeBatch

public Map executeBatch(BlobBatchOperation batch)

BLOB サービスに対して事前構築されたバッチ操作を実行します。 BLOB バッチ要求の構築の詳細については、「」を参照してください BlobBatchOperation<P,R>。

Parameters:

batch - 実行する操作のバッチ。

Returns:

バッチ内の親オブジェクトからその親の応答へのマッピング。

Throws:

BatchException - バッチに対する 1 つ以上の個別の要求が失敗した場合に、ストレージ例外のこのサブセットをスローします。

StorageException - サービスでエラーが発生した場合に をスローします。

executeBatch

public Map executeBatch(BlobBatchOperation batch, BlobRequestOptions requestOptions, OperationContext operationContext)

BLOB サービスに対して事前構築されたバッチ操作を実行します。 BLOB バッチ要求の構築の詳細については、「」を参照してください BlobBatchOperation<P,R>。

Parameters:

batch - 実行する操作のバッチ。

requestOptions - BlobRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。

operationContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

バッチ内の親オブジェクトからその親の応答へのマッピング。

Throws:

BatchException - バッチに対する 1 つ以上の個別の要求が失敗した場合に、ストレージ例外のこのサブセットをスローします。

StorageException - サービスでエラーが発生した場合に をスローします。

getContainerReference

public CloudBlobContainer getContainerReference(final String containerName)

指定した名前の CloudBlobContainer オブジェクトを取得します。

Parameters:

containerName - コンテナーの名前。コンテナーの名前付け規則に従う必要があります。 コンテナー名には、パス区切り文字 (/) を含めないようにしてください。 コンテナー名は、3 ~ 63 文字の小文字で、文字または数字で始まる必要があります。 コンテナー名には、文字、数字、ダッシュ (-) 文字のみを含むことができます。

Returns:

CloudBlobContainer オブジェクトへの参照です。

Throws:

URISyntaxException - containerName に基づいて構築されたリソース URI が無効な場合。

StorageException - ストレージ サービス エラーが発生した場合。

getDefaultRequestOptions

public BlobRequestOptions getDefaultRequestOptions()

BlobRequestOptionsこれに関連付けられている要求に使用される を取得します。

Returns:

この BlobRequestOptions で使用される値を含む オブジェクト CloudBlobClient

getDirectoryDelimiter

public String getDirectoryDelimiter()

クラウド BLOB ディレクトリに使用される既定の区切り記号の値を返します。 既定値は '/' です。

Returns:

既定の String 区切り記号の値を表す 。

getServiceStats

public ServiceStats getServiceStats()

のサービスに対してクエリを実行します ServiceStats。

Returns:

ServiceStats指定されたストレージ サービスの オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

getServiceStats

public ServiceStats getServiceStats(BlobRequestOptions options, OperationContext opContext)

特定のストレージ サービスに 対して を照会します ServiceStats。

Parameters:

options - BlobRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

ServiceStats指定されたストレージ サービスの オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

getUserDelegationKey

public UserDelegationKey getUserDelegationKey(Date keyStart, Date keyEnd)

このクライアントの oauth 資格情報に基づいて、新しいユーザー委任キーを要求します。

Parameters:

keyStart - 要求されたキーの有効期間の開始時刻。

keyEnd - 要求されたキーの有効性の終了時刻。

Returns:

要求されたキー。

Throws:

StorageException

getUserDelegationKey

public UserDelegationKey getUserDelegationKey(Date keyStart, Date keyEnd, BlobRequestOptions options, OperationContext opContext)

このクライアントの oauth 資格情報に基づいて、新しいユーザー委任キーを要求します。

Parameters:

keyStart - 要求されたキーの有効期間の開始時刻。

keyEnd - 要求されたキーの有効性の終了時刻。

options - BlobRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

要求されたキー。

Throws:

StorageException

isUsePathStyleUris

protected boolean isUsePathStyleUris()

パス スタイル URI が使用されているかどうかを示します。

Returns:

true パス スタイルの URI を使用する場合は 。それ以外の場合は false。

listContainers

public Iterable listContainers()

この BLOB サービス クライアントの BLOB コンテナーの列挙可能なコレクションを返します。

Returns:

このクライアントの CloudBlobContainer コンテナーを表す遅延で取得されたオブジェクトの列挙可能なコレクション。

listContainers

public Iterable listContainers(final String prefix)

この BLOB サービス クライアントの指定したプレフィックスで始まる名前を持つ BLOB コンテナーの列挙可能なコレクションを返します。

Parameters:

prefix - Stringコンテナー名プレフィックスを表す 。

Returns:

指定したプレフィックスで始まる名前を持つこのクライアントの CloudBlobContainer コンテナーを表す、遅延取得されたオブジェクトの列挙可能なコレクション。

listContainers

public Iterable listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext)

指定した詳細設定、要求オプション、操作コンテキストを使用して、この BLOB サービス クライアントの指定したプレフィックスで始まる名前を持つ BLOB コンテナーの列挙可能なコレクションを返します。

Parameters:

prefix - Stringコンテナー名プレフィックスを表す 。

detailsIncluded - ContainerListingDetailsコンテナー メタデータが返されるかどうかを示す 値。

options - BlobRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

このクライアントの CloudBlobContainer コンテナーを表す遅延で取得されたオブジェクトの列挙可能なコレクション。

listContainersSegmented

public ResultSegment listContainersSegmented()

この BLOB サービス クライアントの BLOB コンテナーの列挙可能なコレクションの結果セグメントを返します。

Returns:

ResultSegment<T>このクライアントのコンテナーを表すオブジェクトの列挙可能なコレクションのCloudBlobContainerセグメントを含む オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

listContainersSegmented

public ResultSegment listContainersSegmented(final String prefix)

この BLOB サービス クライアントの指定したプレフィックスで始まる名前を持つ BLOB コンテナーの列挙可能なコレクションの結果セグメントを返します。

Parameters:

prefix - Stringコンテナー名のプレフィックスを表す 。

Returns:

ResultSegment<T>名前が指定したプレフィックスで始まるコンテナーを表すオブジェクトの列挙可能なコレクションのCloudBlobContainerセグメントを含む オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

listContainersSegmented

public ResultSegment listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext)

指定したリストの詳細オプション、要求オプション、操作コンテキストを使用して、この BLOB サービス クライアントの指定したプレフィックスで始まる名前を持つ BLOB コンテナーの列挙可能なコレクションの結果セグメントを返します。

Parameters:

prefix - Stringコンテナー名のプレフィックスを表す 。

detailsIncluded - ContainerListingDetailsコンテナー メタデータが返されるかどうかを示す 値。

maxResults - 取得する結果の最大数。 5000 を超える場合 null 、サーバーは最大 5,000 個の項目を返します。 1 以上を指定してください。

continuationToken - 前の ResultContinuation 一覧表示操作によって返された継続トークンを表す オブジェクト。

options - BlobRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント (CloudBlobClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

ResultSegment<T>この BLOB サービス クライアントのコンテナーを表すオブジェクトの列挙可能なコレクションのCloudBlobContainerセグメントを含む オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

setDefaultRequestOptions

public void setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions)

このオブジェクトに BlobRequestOptions 関連付けられている要求に使用される を設定します。

Parameters:

defaultRequestOptions - BlobRequestOptions使用するオプションを指定する オブジェクト。

setDirectoryDelimiter

public void setDirectoryDelimiter(final String directoryDelimiter)

クラウド BLOB ディレクトリに使用される既定の区切り記号の値を設定します。

Parameters:

directoryDelimiter - String既定のディレクトリ区切り記号の値を指定する 。

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

指定されたストレージ サービスに新しい ServiceProperties 構成をアップロードします。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。

Parameters:

properties - ServicePropertiesアップロードするサービス プロパティを指定する オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties, BlobRequestOptions options, OperationContext opContext)

指定されたストレージ サービスに新しい ServiceProperties 構成をアップロードします。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。

Parameters:

properties - ServicePropertiesアップロードするサービス プロパティを指定する オブジェクト。

options - BlobRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。