CloudBlobContainer クラス
- java.
lang. Object - com.
microsoft. azure. storage. blob. CloudBlobContainer
- com.
public class CloudBlobContainer
Microsoft Azure BLOB サービス内のコンテナーを表します。
コンテナーはディレクトリを保持して、CloudBlobDirectory オブジェクトとしてカプセル化され、ディレクトリは、ブロック BLOB とページ BLOB を保持します。 ディレクトリはサブディレクトリも保持できます。
フィールドの概要
修飾子と型 | フィールドと説明 |
---|---|
HashMap<String, String> |
metadata
コンテナーメタデータを表します。 |
コンストラクターの概要
コンストラクター | 説明 |
---|---|
CloudBlobContainer(final StorageUri storageUri) |
指定した URI を使用して、 クラスのインスタンスを作成します。 匿名アクセスを使用しない限り、BLOB URI には SAS トークンを含める必要があります。 |
CloudBlobContainer(final StorageUri storageUri, final StorageCredentials credentials) |
指定した StorageUri と資格情報を使用して、 クラスのインスタンスを作成します。 |
CloudBlobContainer(final String containerName, final CloudBlobClient client) |
指定した名前とクライアントを使用して、 クラスのインスタンスを作成します。 |
CloudBlobContainer(final URI uri) |
指定した URI を使用して、 クラスのインスタンスを作成します。 匿名アクセスを使用しない限り、BLOB URI には SAS トークンを含める必要があります。 |
CloudBlobContainer(final URI uri, final StorageCredentials credentials) |
指定した URI と資格情報を使用して、 クラスのインスタンスを作成します。 |
メソッドの概要
フィールドの詳細
metadata
protected HashMap
コンテナーメタデータを表します。
コンストラクターの詳細
CloudBlobContainer
public CloudBlobContainer(final StorageUri storageUri)
指定した URI を使用して、 クラスのインスタンスを作成します。 匿名アクセスを使用しない限り、BLOB URI には SAS トークンを含める必要があります。
Parameters:
Throws:
CloudBlobContainer
public CloudBlobContainer(final StorageUri storageUri, final StorageCredentials credentials)
指定した StorageUri と資格情報を使用して、 クラスのインスタンスを作成します。
Parameters:
Throws:
CloudBlobContainer
protected CloudBlobContainer(final String containerName, final CloudBlobClient client)
指定した名前とクライアントを使用して、 クラスのインスタンスを作成します。
Parameters:
String
コンテナーの名前を表す 。コンテナーの名前付け規則に従う必要があります。 コンテナー名には、パス区切り文字 (/) を含めないようにしてください。 コンテナー名は、3 ~ 63 文字の小文字で、文字または数字で始まる必要があります。 コンテナー名には、文字、数字、ダッシュ (-) 文字のみを含むことができます。
Throws:
CloudBlobContainer
public CloudBlobContainer(final URI uri)
指定した URI を使用して、 クラスのインスタンスを作成します。 匿名アクセスを使用しない限り、BLOB URI には SAS トークンを含める必要があります。
Parameters:
java.net.URI
コンテナーの URI を表す オブジェクト。
Throws:
CloudBlobContainer
public CloudBlobContainer(final URI uri, final StorageCredentials credentials)
指定した URI と資格情報を使用して、 クラスのインスタンスを作成します。
Parameters:
java.net.URI
コンテナーの絶対 URI を表す オブジェクト。
Throws:
メソッドの詳細
acquireLease
public final String acquireLease()
コンテナーの新しい無限リースを取得します。
Returns:
String
リース ID を表す 。Throws:
acquireLease
public final String acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId)
指定したリース時間と提案されたリース ID を使用して、コンテナーの新しいリースを取得します。
Parameters:
Integer
リースを取得する期間を秒単位で指定する 。 null の場合、無限リースが取得されます。 null でない場合、値は 0 より大きくする必要があります。
String
新しいリースの提案されたリース ID を表す 。リース ID が提案されていない場合は null。
Returns:
String
リース ID を表す 。Throws:
acquireLease
public final String acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
指定したリース時間、提案されたリース ID、要求オプション、および操作コンテキストを使用して、コンテナーの新しいリースを取得します。
Parameters:
Integer
リースを取得する期間を秒単位で指定する 。 null の場合、無限リースが取得されます。 null でない場合、値は 0 より大きくする必要があります。
String
新しいリースの提案されたリース ID を表す 。リース ID が提案されていない場合は null。
null
指定すると、関連付けられたサービス クライアント (CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
String
リース ID を表す 。Throws:
breakLease
public final long breakLease(final Integer breakPeriodInSeconds)
リースを解除し、現在のリース期間が切れるまで別のクライアントが新しいリースを取得できないようにします。
Parameters:
Integer
現在のリースが切断されるまで待機する時間を秒単位で指定する 。 null の場合、中断期間は、現在のリースの残り時間となります。無限リースの場合は 0 です。
Returns:
Throws:
breakLease
public final long breakLease(final Integer breakPeriodInSeconds, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して既存のリースを解除し、現在のリース期間が切れるまで別のクライアントが新しいリースを取得できないようにします。
Parameters:
Integer
現在のリースが切断されるまで待機する時間を秒単位で指定する 。 null の場合、中断期間は、現在のリースの残り時間となります。無限リースの場合は 0 です。
null
指定すると、関連付けられたサービス クライアント (CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
changeLease
public final String changeLease(final String proposedLeaseId, final AccessCondition accessCondition)
既存のリース ID を提案されたリース ID に変更します。
Parameters:
String
新しいリースの提案されたリース ID を表す 。リース ID が提案されていない場合は null。
Returns:
String
新しいリース ID を表す 。Throws:
changeLease
public final String changeLease(final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
既存のリース ID を、指定されたアクセス条件、要求オプション、および操作コンテキストを使用して、提案されたリース ID に変更します。
Parameters:
String
新しいリースの提案されたリース ID を表す 。 null にすることはできません。
null
指定すると、関連付けられたサービス クライアント (CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
String
新しいリース ID を表す 。Throws:
create
public void create()
コンテナーを作成します。
Throws:
create
public void create(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)
指定したオプションと操作コンテキストを使用してコンテナーを作成します。
Parameters:
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Throws:
create
public void create(BlobRequestOptions options, OperationContext opContext)
指定したオプションと操作コンテキストを使用してコンテナーを作成します。
Parameters:
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Throws:
createIfNotExists
public boolean createIfNotExists()
コンテナーが存在しない場合は作成します。
Returns:
コンテナーがまだ存在せず作成された場合は true
、それ以外の場合は false
です。
Throws:
createIfNotExists
public boolean createIfNotExists(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、コンテナーが存在しない場合は作成します。
Parameters:
null
指定すると、関連付けられたサービス クライアント (CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
コンテナーがまだ存在せず作成された場合は true
、それ以外の場合は false
です。
Throws:
createIfNotExists
public boolean createIfNotExists(BlobRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、コンテナーが存在しない場合は作成します。
Parameters:
null
指定すると、関連付けられたサービス クライアント (CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
コンテナーがまだ存在せず作成された場合は true
、それ以外の場合は false
です。
Throws:
delete
public void delete()
コンテナーを削除します。
Throws:
delete
public void delete(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用してコンテナーを削除します。
Parameters:
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Throws:
deleteIfExists
public boolean deleteIfExists()
コンテナーが存在する場合は削除します。
Returns:
コンテナーがまだ存在せず作成された場合は true
、それ以外の場合は false
です。
Throws:
deleteIfExists
public boolean deleteIfExists(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用してコンテナーが存在する場合は、コンテナーを削除します。
Parameters:
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
true
コンテナーが存在し、削除された場合は 。それ以外の場合は false
。
Throws:
downloadAccountInfo
public AccountInformation downloadAccountInfo()
このコンテナーが存在するストレージ アカウントに関連する情報を取得します。
Returns:
Throws:
downloadAccountInfo
public AccountInformation downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)
このコンテナーが存在するストレージ アカウントに関連する情報を取得します。
Parameters:
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
downloadAccountInformationImpl
protected StorageRequest
Parameters:
downloadAttributes
public void downloadAttributes()
メタデータとプロパティで構成されるコンテナーの属性をダウンロードします。
Throws:
downloadAttributes
public void downloadAttributes(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、メタデータとプロパティで構成されるコンテナーの属性をダウンロードします。
Parameters:
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Throws:
downloadPermissions
public BlobContainerPermissions downloadPermissions()
コンテナーのアクセス許可設定をダウンロードします。
Returns:
Throws:
downloadPermissions
public BlobContainerPermissions downloadPermissions(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、コンテナーのアクセス許可設定をダウンロードします。
Parameters:
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
exists
public boolean exists()
コンテナーが存在するかどうかを示す値を返します。
Returns:
true
コンテナーが存在する場合は 。それ以外の場合 false
は 。
Throws:
exists
public boolean exists(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、コンテナーが存在するかどうかを示す値を返します。
Parameters:
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
true
コンテナーが存在する場合は 。それ以外の場合 false
は 。
Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier)
コンテナーの共有アクセス署名を返します。 これは先頭の "?"" を含まないことに注意してください。
Parameters:
String
コンテナー レベルのアクセス ポリシーを表す 。
Returns:
String
コンテナーの共有アクセス署名を表す 。Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
コンテナーの共有アクセス署名を返します。 これは先頭の "?"" を含まないことに注意してください。
Parameters:
String
コンテナー レベルのアクセス ポリシーを表す 。
Returns:
String
コンテナーの共有アクセス署名を表す 。Throws:
getAppendBlobReference
public CloudAppendBlob getAppendBlobReference(final String blobName)
このコンテナー内の追加 BLOB を表す オブジェクトへの CloudAppendBlob 参照を返します。
Parameters:
String
BLOB の名前を表す 。
Returns:
Throws:
getAppendBlobReference
public CloudAppendBlob getAppendBlobReference(final String blobName, final String snapshotID)
指定したスナップショット ID を使用して、コンテナー内の追加 BLOB を表す オブジェクトへの参照CloudAppendBlobを返します。
Parameters:
String
BLOB の名前を表す 。
String
BLOB のスナップショット ID を表す 。
Returns:
Throws:
getBlobReferenceFromServer
public final CloudBlob getBlobReferenceFromServer(final String blobName)
このコンテナー内の BLOB への参照を取得します。 BLOB は、サービス上に既に存在している必要があります。
他の get*Reference メソッドとは異なり、このメソッドはサービス要求を実行して BLOB のメタデータとプロパティを取得します。 返される BLOB は、CloudBlob として直接使用することも、instanceof または getProperties().getBlobType() を使用してそのサブタイプを特定してキャストすることもできます。
Parameters:
String
BLOB の名前を表す 。
Returns:
Throws:
getBlobReferenceFromServer
public final CloudBlob getBlobReferenceFromServer(final String blobName, final String snapshotID, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
このコンテナー内の BLOB への参照を取得します。 BLOB は、サービス上に既に存在している必要があります。
他の get*Reference メソッドとは異なり、このメソッドはサービス要求を実行して BLOB のメタデータとプロパティを取得します。 返される BLOB は、CloudBlob として直接使用することも、instanceof または getProperties().getBlobType() を使用してそのサブタイプを特定してキャストすることもできます。
Parameters:
String
BLOB の名前を表す 。
String
BLOB のスナップショット ID を表す 。
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
getBlockBlobReference
public CloudBlockBlob getBlockBlobReference(final String blobName)
このコンテナー内のブロック BLOB を表す オブジェクトへの CloudBlockBlob 参照を返します。
Parameters:
String
BLOB の名前を表す 。
Returns:
Throws:
getBlockBlobReference
public CloudBlockBlob getBlockBlobReference(final String blobName, final String snapshotID)
指定したスナップショット ID を使用して、このコンテナー内のブロック BLOB を表す オブジェクトへの参照CloudBlockBlobを返します。
Parameters:
String
BLOB の名前を表す 。
String
BLOB のスナップショット ID を表す 。
Returns:
Throws:
getDirectoryReference
public CloudBlobDirectory getDirectoryReference(String directoryName)
このコンテナー内の CloudBlobDirectory 仮想 BLOB ディレクトリを表す オブジェクトへの参照を返します。
Parameters:
String
仮想 BLOB ディレクトリの名前を表す 。 ルート ディレクトリ (コンテナー自体を表すディレクトリ) が必要な場合は、空の文字列を使用します。
Returns:
Throws:
getMetadata
public HashMap
コンテナーのメタデータを返します。 この値は、 の呼び出しによってキューからのメタデータで初期化され、 を downloadAttributes()呼び出 uploadMetadata()してキューに設定されます。
Returns:
java.util.HashMap
コンテナーのメタデータを表す オブジェクト。getName
public String getName()
コンテナーの名前を返します。
Returns:
String
コンテナーの名前を表す 。getPageBlobReference
public CloudPageBlob getPageBlobReference(final String blobName)
このコンテナー内のページ BLOB を表す オブジェクトへの CloudPageBlob 参照を返します。
Parameters:
String
BLOB の名前を表す 。
Returns:
Throws:
getPageBlobReference
public CloudPageBlob getPageBlobReference(final String blobName, final String snapshotID)
指定したスナップショット ID を使用して、コンテナー内のページ BLOB を表す オブジェクトへの参照CloudPageBlobを返します。
Parameters:
String
BLOB の名前を表す 。
String
BLOB のスナップショット ID を表す 。
Returns:
Throws:
getProperties
public BlobContainerProperties getProperties()
コンテナーのプロパティを返します。
Returns:
getServiceClient
public CloudBlobClient getServiceClient()
このコンテナーに関連付けられている BLOB サービス クライアントを返します。
Returns:
getStorageUri
public StorageUri getStorageUri()
すべての場所の URI の一覧を返します。
Returns:
getUri
public URI getUri()
このコンテナーの URI を返します。
Returns:
listBlobs
public Iterable
コンテナーの BLOB 項目の列挙可能なコレクションを返します。
Returns:
listBlobs
public Iterable
名前が指定したプレフィックスで始まるコンテナーの BLOB 項目の列挙可能なコレクションを返します。
Parameters:
String
BLOB 名プレフィックスを表す 。 この値の前には、コンテナーの名前またはコンテナーへの絶対パスを指定する必要があります。
Returns:
listBlobs
public Iterable
指定したフラットまたは階層オプションを使用して、指定したプレフィックスで名前が始まるコンテナーの BLOB 項目の列挙可能なコレクションを返します。
Parameters:
String
BLOB 名プレフィックスを表す 。 この値の前には、コンテナーの名前またはコンテナーへの絶対パスを指定する必要があります。
true
返されたリストがフラットであることを示す場合は 。 false
は、返されたリストが階層的であることを示します。
Returns:
listBlobs
public Iterable
指定したフラットまたは階層オプション、詳細オプション、要求オプション、および操作コンテキストを一覧表示して、名前が指定したプレフィックスで始まるコンテナーの BLOB 項目の列挙可能なコレクションを返します。
Parameters:
String
BLOB 名プレフィックスを表す 。 この値の前には、コンテナーの名前またはコンテナーへの絶対パスを指定する必要があります。
true
返されたリストがフラットであることを示す場合は 。 false
は、返されたリストが階層的であることを示します。
java.util.EnumSet
スナップショット、論理的に削除された BLOB、メタデータ、および/またはコミットされていないブロックが返されるかどうかを示す値を含む BlobListingDetails オブジェクト。 コミットされたブロックは常に返されます。
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
listBlobsSegmented
public ResultSegment
コンテナー内の BLOB 項目の列挙可能なコレクションの結果セグメントを返します。
Returns:
Throws:
listBlobsSegmented
public ResultSegment
名前が指定したプレフィックスで始まる BLOB アイテムのコレクションを含む結果セグメントを返します。
Parameters:
String
BLOB 名のプレフィックスを表す 。
Returns:
Throws:
listBlobsSegmented
public ResultSegment
指定したフラットまたは階層オプション、詳細オプション、要求オプション、および操作コンテキストを一覧表示して、指定したプレフィックスで始まる名前を持つ BLOB アイテムのコレクションを含む結果セグメントを返します。
Parameters:
String
BLOB 名のプレフィックスを表す 。
true
返されたリストがフラットであることを示す場合は 。 false
は、返されたリストが階層的であることを示します。
java.util.EnumSet
スナップショット、論理的に削除された BLOB、メタデータ、および/またはコミットされていないブロックが返されるかどうかを示す値を含む BlobListingDetails オブジェクト。 コミットされたブロックは常に返されます。
null
、サーバーは最大 5,000 個のアイテムを返します。 1 以上を指定してください。
null
指定すると、関連付けられたサービス クライアント (CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
listContainers
public Iterable
このコンテナーに関連付けられているサービス クライアントのコンテナーの列挙可能なコレクションを返します。
Returns:
listContainers
public Iterable
このコンテナーに関連付けられているサービス クライアントの指定したプレフィックスで始まる名前を持つコンテナーの列挙可能なコレクションを返します。
Parameters:
String
コンテナー名プレフィックスを表す 。
Returns:
listContainers
public Iterable
指定した詳細設定、要求オプション、および操作コンテキストを使用して、このコンテナーに関連付けられているサービス クライアントの指定されたプレフィックスで始まる名前を持つコンテナーの列挙可能なコレクションを返します。
Parameters:
String
コンテナー名プレフィックスを表す 。
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
listContainersSegmented
public ResultSegment
このコンテナーに関連付けられているサービス クライアントのコンテナーの列挙可能なコレクションの結果セグメントを返します。
Returns:
Throws:
listContainersSegmented
public ResultSegment
このコンテナーに関連付けられているサービス クライアントの指定したプレフィックスで始まる名前を持つコンテナーの列挙可能なコレクションの結果セグメントを返します。
Parameters:
String
BLOB 名プレフィックスを表す 。
Returns:
Throws:
listContainersSegmented
public ResultSegment
指定したリストの詳細オプション、要求オプション、および操作コンテキストを使用して、このコンテナーに関連付けられているサービス クライアントの指定されたプレフィックスで始まる名前を持つコンテナーのコレクションを含む結果セグメントを返します。
Parameters:
String
コンテナー名のプレフィックスを表す 。
null
、サーバーは最大 5,000 個のアイテムを返します。 1 以上を指定してください。
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
releaseLease
public final void releaseLease(final AccessCondition accessCondition)
コンテナーのリースを解放します。
Parameters:
Throws:
releaseLease
public final void releaseLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
指定したアクセス条件、要求オプション、および操作コンテキストを使用して、コンテナーのリースを解放します。
Parameters:
null
指定すると、関連付けられたサービス クライアント (CloudBlobClient) からの既定の要求オプションが使用されます。
Throws:
renewLease
public final void renewLease(final AccessCondition accessCondition)
指定したアクセス条件で既存のリースを更新します。
Parameters:
Throws:
renewLease
public final void renewLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
指定したアクセス条件、要求オプション、および操作コンテキストを使用して、既存のリースを更新します。
Parameters:
null
指定すると、関連付けられたサービス クライアント (CloudBlobClient) からの既定の要求オプションが使用されます。
Throws:
setMetadata
public void setMetadata(final HashMap
呼び出しでコンテナーに設定する名前と値のペアのメタデータ コレクションを uploadMetadata() 設定します。 このコレクションは、既存のコンテナー メタデータを上書きします。 これが空のコレクションに設定されている場合、呼び出し時に uploadMetadata() コンテナー メタデータがクリアされます。
Parameters:
java.util.HashMap
コンテナーに割り当てられているメタデータを表す オブジェクト。
setProperties
protected void setProperties(final BlobContainerProperties properties)
コンテナーのプロパティを設定します。
Parameters:
setStorageUri
protected void setStorageUri(final StorageUri storageUri)
すべての場所の URI の一覧を設定します。
Parameters:
uploadMetadata
public void uploadMetadata()
コンテナーのメタデータをアップロードします。
Throws:
uploadMetadata
public void uploadMetadata(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、コンテナーのメタデータをアップロードします。
Parameters:
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Throws:
uploadPermissions
public void uploadPermissions(final BlobContainerPermissions permissions)
コンテナーのアクセス許可をアップロードします。
Parameters:
Throws:
uploadPermissions
public void uploadPermissions(final BlobContainerPermissions permissions, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、コンテナーのアクセス許可をアップロードします。
Parameters:
null
指定すると、関連付けられたサービス クライアント ( CloudBlobClient) からの既定の要求オプションが使用されます。
Throws:
適用対象
Azure SDK for Java