CloudFileShare クラス

  • リファレンス
パッケージ:
com.microsoft.azure.storage.file
  • java.lang.Object
    • com.microsoft.azure.storage.file.CloudFileShare

public class CloudFileShare

Microsoft Azure File サービス内の共有を表します。

共有は、オブジェクトとして CloudFileDirectory カプセル化されたディレクトリを保持し、ディレクトリはファイルを保持します。 ディレクトリはサブディレクトリも保持できます。

コンストラクターの概要

コンストラクター 説明
CloudFileShare(final StorageUri storageUri)

指定した URI を使用して、 クラスのインスタンスを作成します。
CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)

指定した StorageUri と資格情報を使用して、 クラスのインスタンスを作成します。
CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)

指定した名前とクライアントを使用して、 クラスのインスタンスを作成します。
CloudFileShare(final URI uri)

指定した URI を使用して、 クラスのインスタンスを作成します。
CloudFileShare(final URI uri, final StorageCredentials credentials)

指定した URI と資格情報を使用して、 クラスのインスタンスを作成します。

メソッドの概要

修飾子と型 メソッドと説明
void assertNoSnapshot()

共有がスナップショットではないことをアサートします。

void create()

共有を作成します。
void create(FileRequestOptions options, OperationContext opContext)

指定したオプションと操作コンテキストを使用して共有を作成します。
String createFilePermission(String permission)

ファイルのアクセス許可を作成します。
String createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)

ファイルのアクセス許可を作成します。
boolean createIfNotExists()

共有が存在しない場合は作成します。
boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、共有が存在しない場合は作成します。
final CloudFileShare createSnapshot()

共有のスナップショットを作成します。
final CloudFileShare createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、ファイル共有のスナップショットを作成します。
final CloudFileShare createSnapshot(final HashMap<String, String> metadata, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、ファイル共有のスナップショットを作成します。
void delete()

共有を削除します。
void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して共有を削除します。
void delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したスナップショットと要求オプション、および操作コンテキストを使用して共有を削除します。

スナップショットを含む共有は、スナップショットも削除されない限り削除できません。 共有にスナップショットがある場合は、 パラメーターの 値を INCLUDE_SNAPSHOTS 使用して、ベース共有を削除するときにスナップショットを含めます。
boolean deleteIfExists()

共有が存在する場合は削除します。
boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して共有が存在する場合は削除します。
boolean deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したスナップショットと要求オプション、および操作コンテキストを使用して、共有が存在する場合は削除します。

スナップショットを含む共有は、スナップショットも削除されない限り削除できません。 共有にスナップショットがある場合は、 パラメーターの 値を INCLUDE_SNAPSHOTS 使用して、ベース共有を削除するときにスナップショットを含めます。
void downloadAttributes()

メタデータとプロパティで構成される共有の属性をダウンロードします。
void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、メタデータとプロパティで構成される共有の属性をダウンロードします。
FileSharePermissions downloadPermissions()

共有のアクセス許可設定をダウンロードします。
FileSharePermissions downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、共有のアクセス許可設定をダウンロードします。
boolean exists()

共有が存在するかどうかを示す値を返します。
boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、共有が存在するかどうかを示す値を返します。
String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)

共有の共有アクセス署名を返します。 先頭の "?"は含まれていないことに注意してください。
String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

共有の共有アクセス署名を返します。 先頭の "?"は含まれていないことに注意してください。
String getFilePermission(String filePermissionKey)

ファイルのアクセス許可キーに関連付けられているファイルのアクセス許可を取得します。
String getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)

ファイルのアクセス許可キーに関連付けられているファイルのアクセス許可を取得します。
HashMap<String, String> getMetadata()

共有のメタデータを返します。 この値は、 の呼び出しによって共有のメタデータで初期化され、 の downloadAttributes()呼び出 uploadMetadata()しで共有に設定されます。
String getName()

共有の名前を返します。
FileShareProperties getProperties()

共有のプロパティを返します。
final URI getQualifiedUri()

この共有のスナップショットまたは共有アクセス署名の修飾 URI を返します。
CloudFileDirectory getRootDirectoryReference()

この共有内のルート ファイル ディレクトリを CloudFileDirectory 表す オブジェクトへの参照を返します。
CloudFileClient getServiceClient()

この共有に関連付けられているファイル サービス クライアントを返します。
final String getSnapshot()

この共有の snapshotID を返します。
ShareStats getStats()

この共有の のサービスに対してクエリを実行 ShareStatsします。
ShareStats getStats(FileRequestOptions options, OperationContext opContext)

この共有の のサービスに対してクエリを実行 ShareStatsします。
StorageUri getStorageUri()

すべての場所の URI の一覧を返します。
URI getUri()

この共有の URI を返します。
final boolean isSnapshot()

この共有がスナップショットかどうかを示します。
void setMetadata(final HashMap<String, String> metadata)

呼び出しで共有に設定する名前と値のペアのメタデータ コレクションを uploadMetadata() 設定します。 このコレクションは、既存の共有メタデータを上書きします。 これが空のコレクションに設定されている場合、共有メタデータは呼び出しで uploadMetadata() クリアされます。
void setProperties(final FileShareProperties properties)

共有のプロパティを設定します。
void uploadMetadata()

共有のメタデータをアップロードします。
void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、共有のメタデータをアップロードします。
void uploadPermissions(final FileSharePermissions permissions)

共有のアクセス許可をアップロードします。
void uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、共有のアクセス許可をアップロードします。
final void uploadProperties()

ストレージ サービスで共有のプロパティを更新します。

を使用して downloadAttributes() 、Microsoft Azure ストレージ サービスから共有のプロパティとメタデータの最新の値を取得します。
final void uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

要求オプションと操作コンテキストを使用して、共有のプロパティを更新します。

を使用して downloadAttributes() 、Microsoft Azure ストレージ サービスから共有のプロパティとメタデータの最新の値を取得します。

コンストラクターの詳細

CloudFileShare

public CloudFileShare(final StorageUri storageUri)

指定した URI を使用して、 クラスのインスタンスを作成します。

Parameters:

storageUri - 共有の StorageUri 絶対 URI を表す オブジェクト。

Throws:

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

CloudFileShare

public CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)

指定した StorageUri と資格情報を使用して、 クラスのインスタンスを作成します。

Parameters:

storageUri - 共有の StorageUri 絶対 StorageUri を表す オブジェクト。
credentials - StorageCredentialsアクセスを認証するために使用される オブジェクト。

Throws:

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

CloudFileShare

public CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)

指定した名前とクライアントを使用して、 クラスのインスタンスを作成します。

Parameters:

shareName - String共有の名前を表す 。共有の名前付け規則に従う必要があります。 共有名には、パス区切り文字 (/) を含めないようにしてください。 共有名は小文字で、長さは 3 から 63 文字で、先頭は文字または数字である必要があります。 共有名には、文字、数字、ダッシュ (-) 文字のみを含むことができます。
snapshotID - String該当する場合は、スナップショットバージョンを表す 。
client - CloudFileClient関連付けられたサービス クライアントを表し、File サービスのエンドポイントを指定する オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。
URISyntaxException - shareName に基づいて構築されたリソース URI が無効な場合。

CloudFileShare

public CloudFileShare(final URI uri)

指定した URI を使用して、 クラスのインスタンスを作成します。

Parameters:

uri - java.net.URI共有の絶対 URI を表す オブジェクト。

Throws:

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

CloudFileShare

public CloudFileShare(final URI uri, final StorageCredentials credentials)

指定した URI と資格情報を使用して、 クラスのインスタンスを作成します。

Parameters:

uri - java.net.URI共有の絶対 URI を表す オブジェクト。
credentials - StorageCredentialsアクセスを認証するために使用される オブジェクト。

Throws:

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

メソッドの詳細

assertNoSnapshot

protected void assertNoSnapshot()

共有がスナップショットではないことをアサートします。

create

public void create()

共有を作成します。

Throws:

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

create

public void create(FileRequestOptions options, OperationContext opContext)

指定したオプションと操作コンテキストを使用して共有を作成します。

Parameters:

options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

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

createFilePermission

public String createFilePermission(String permission)

ファイルのアクセス許可を作成します。

Parameters:

permission - String作成するファイルアクセス許可を表す オブジェクト。

Returns:

String作成されたファイルアクセス許可に関連付けられているファイルアクセス許可キーを表す 。

Throws:

StorageException
IOException

createFilePermission

public String createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)

ファイルのアクセス許可を作成します。

Parameters:

permission - String作成するファイルアクセス許可を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

String作成されたファイルアクセス許可に関連付けられているファイルアクセス許可キーを表す 。

Throws:

StorageException
IOException

createIfNotExists

public boolean createIfNotExists()

共有が存在しない場合は作成します。

Returns:

共有がまだ存在せず作成された場合は true、それ以外の場合は false です。

Throws:

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

createIfNotExists

public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、共有が存在しない場合は作成します。

Parameters:

options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント (CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

共有がまだ存在せず作成された場合は true、それ以外の場合は false です。

Throws:

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

createSnapshot

public final CloudFileShare createSnapshot()

共有のスナップショットを作成します。

Returns:

CloudFileShare共有のスナップショットを表す オブジェクト。

Throws:

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

createSnapshot

public final CloudFileShare createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、ファイル共有のスナップショットを作成します。

Parameters:

accessCondition - AccessCondition共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

CloudFileShareファイル共有のスナップショットを表す オブジェクト。

Throws:

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

createSnapshot

public final CloudFileShare createSnapshot(final HashMap metadata, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、ファイル共有のスナップショットを作成します。

Parameters:

metadata - スナップショットのメタデータを定義する名前と値のペアのコレクション(null)。
accessCondition - AccessConditionファイル共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

CloudFileShareファイル共有のスナップショットを表す オブジェクト。

Throws:

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

delete

public void delete()

共有を削除します。

Throws:

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

delete

public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して共有を削除します。

Parameters:

accessCondition - AccessCondition共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

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

delete

public void delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したスナップショットと要求オプション、および操作コンテキストを使用して共有を削除します。

スナップショットを含む共有は、スナップショットも削除されない限り削除できません。 共有にスナップショットがある場合は、 パラメーターの 値を INCLUDE_SNAPSHOTS 使用して、ベース共有を削除するときにスナップショットを含めます。

Parameters:

deleteSnapshotsOption - DeleteShareSnapshotsOptionスナップショットのみを削除するか、共有とそのスナップショットを削除するかを示す オブジェクト。
accessCondition - AccessCondition共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

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

deleteIfExists

public boolean deleteIfExists()

共有が存在する場合は削除します。

Returns:

true 共有が存在し、削除された場合。それ以外の場合は false。

Throws:

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

deleteIfExists

public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して共有が存在する場合は削除します。

Parameters:

accessCondition - AccessCondition共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

true 共有が存在し、削除された場合。それ以外の場合は false。

Throws:

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

deleteIfExists

public boolean deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したスナップショットと要求オプション、および操作コンテキストを使用して、共有が存在する場合は削除します。

スナップショットを含む共有は、スナップショットも削除されない限り削除できません。 共有にスナップショットがある場合は、 パラメーターの 値を INCLUDE_SNAPSHOTS 使用して、ベース共有を削除するときにスナップショットを含めます。

Parameters:

deleteSnapshotsOption - DeleteShareSnapshotsOptionスナップショットのみを削除するか、共有とそのスナップショットを削除するかを示す オブジェクト。
accessCondition - AccessCondition共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

true 共有が存在し、削除された場合。それ以外の場合は false。

Throws:

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

downloadAttributes

public void downloadAttributes()

メタデータとプロパティで構成される共有の属性をダウンロードします。

Throws:

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

downloadAttributes

public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、メタデータとプロパティで構成される共有の属性をダウンロードします。

Parameters:

accessCondition - AccessCondition共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

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

downloadPermissions

public FileSharePermissions downloadPermissions()

共有のアクセス許可設定をダウンロードします。

Returns:

FileSharePermissions共有のアクセス許可を表す オブジェクト。

Throws:

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

downloadPermissions

public FileSharePermissions downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、共有のアクセス許可設定をダウンロードします。

Parameters:

accessCondition - AccessCondition共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

FileSharePermissions共有のアクセス許可を表す オブジェクト。

Throws:

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

exists

public boolean exists()

共有が存在するかどうかを示す値を返します。

Returns:

true 共有が存在する場合は 。それ以外の場合 falseは 。

Throws:

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

exists

public boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、共有が存在するかどうかを示す値を返します。

Parameters:

accessCondition - AccessCondition共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

true 共有が存在する場合は 。それ以外の場合 falseは 。

Throws:

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

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)

共有の共有アクセス署名を返します。 先頭の "?"は含まれていないことに注意してください。

Parameters:

policy - SharedAccessFilePolicy共有アクセス署名のアクセス ポリシーを表す オブジェクト。
groupPolicyIdentifier - String共有レベルのアクセス ポリシーを表す 。

Returns:

String共有の共有アクセス署名を表す 。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。
InvalidKeyException - キーが無効な場合。

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

共有の共有アクセス署名を返します。 先頭の "?"は含まれていないことに注意してください。

Parameters:

policy - SharedAccessFilePolicy共有アクセス署名のアクセス ポリシーを表す オブジェクト。
groupPolicyIdentifier - String共有レベルのアクセス ポリシーを表す 。
ipRange - IPRange許可される IP アドレスの範囲を含む オブジェクト。
protocols - SharedAccessProtocols許可されているインターネット プロトコルを表す 。

Returns:

String共有の共有アクセス署名を表す 。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。
InvalidKeyException - キーが無効な場合。

getFilePermission

public String getFilePermission(String filePermissionKey)

ファイルのアクセス許可キーに関連付けられているファイルのアクセス許可を取得します。

Parameters:

filePermissionKey - ファイルの String アクセス許可キーを表す オブジェクト。

Returns:

Stringファイルのアクセス許可キーに関連付けられているファイルのアクセス許可を表す 。

Throws:

StorageException

getFilePermission

public String getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)

ファイルのアクセス許可キーに関連付けられているファイルのアクセス許可を取得します。

Parameters:

filePermissionKey - ファイルの String アクセス許可キーを表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

Stringファイルのアクセス許可キーに関連付けられているファイルのアクセス許可を表す 。

Throws:

StorageException

getMetadata

public HashMap getMetadata()

共有のメタデータを返します。 この値は、 の呼び出しによって共有のメタデータで初期化され、 の downloadAttributes()呼び出 uploadMetadata()しで共有に設定されます。

Returns:

java.util.HashMap共有のメタデータを表す オブジェクト。

getName

public String getName()

共有の名前を返します。

Returns:

String共有の名前を表す 。

getProperties

public FileShareProperties getProperties()

共有のプロパティを返します。

Returns:

FileShareProperties共有のプロパティを表す オブジェクト。

getQualifiedUri

public final URI getQualifiedUri()

この共有のスナップショットまたは共有アクセス署名の修飾 URI を返します。

Returns:

java.net.URIスナップショットまたは共有アクセス署名を表す オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。
URISyntaxException - リソース URI が無効な場合。

getRootDirectoryReference

public CloudFileDirectory getRootDirectoryReference()

この共有内のルート ファイル ディレクトリを CloudFileDirectory 表す オブジェクトへの参照を返します。

Returns:

CloudFileDirectoryこの共有のルート ディレクトリへの参照。

Throws:

StorageException
URISyntaxException

getServiceClient

public CloudFileClient getServiceClient()

この共有に関連付けられているファイル サービス クライアントを返します。

Returns:

CloudFileClientこの共有に関連付けられているサービス クライアントを表す オブジェクト。

getSnapshot

public final String getSnapshot()

この共有の snapshotID を返します。

Returns:

この共有の文字列としての snapshotID。

getStats

public ShareStats getStats()

この共有の のサービスに対してクエリを実行 ShareStatsします。

Returns:

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

Throws:

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

getStats

public ShareStats getStats(FileRequestOptions options, OperationContext opContext)

この共有の のサービスに対してクエリを実行 ShareStatsします。

Parameters:

options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント (CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

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

Throws:

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

getStorageUri

public StorageUri getStorageUri()

すべての場所の URI の一覧を返します。

Returns:

StorageUriすべての場所の URI の一覧を表す オブジェクト。

getUri

public URI getUri()

この共有の URI を返します。

Returns:

共有の絶対 URI です。

isSnapshot

public final boolean isSnapshot()

この共有がスナップショットかどうかを示します。

Returns:

true共有がスナップショットの場合は 。それ以外の場合falseは 。

setMetadata

public void setMetadata(final HashMap metadata)

呼び出しで共有に設定する名前と値のペアのメタデータ コレクションを uploadMetadata() 設定します。 このコレクションは、既存の共有メタデータを上書きします。 これが空のコレクションに設定されている場合、共有メタデータは呼び出しで uploadMetadata() クリアされます。

Parameters:

metadata - java.util.HashMap共有に割り当てられているメタデータを表す オブジェクト。

setProperties

public void setProperties(final FileShareProperties properties)

共有のプロパティを設定します。

Parameters:

properties - FileShareProperties共有に割り当てられているプロパティを表す オブジェクト。

uploadMetadata

public void uploadMetadata()

共有のメタデータをアップロードします。

Throws:

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

uploadMetadata

public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、共有のメタデータをアップロードします。

Parameters:

accessCondition - AccessCondition共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

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

uploadPermissions

public void uploadPermissions(final FileSharePermissions permissions)

共有のアクセス許可をアップロードします。

Parameters:

permissions - FileSharePermissionsアップロードするアクセス許可を表す オブジェクト。

Throws:

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

uploadPermissions

public void uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、共有のアクセス許可をアップロードします。

Parameters:

permissions - FileSharePermissionsアップロードするアクセス許可を表す オブジェクト。
accessCondition - AccessCondition共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

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

uploadProperties

public final void uploadProperties()

ストレージ サービスで共有のプロパティを更新します。

を使用して downloadAttributes() 、Microsoft Azure ストレージ サービスから共有のプロパティとメタデータの最新の値を取得します。

Throws:

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

uploadProperties

public final void uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

要求オプションと操作コンテキストを使用して、共有のプロパティを更新します。

を使用して downloadAttributes() 、Microsoft Azure ストレージ サービスから共有のプロパティとメタデータの最新の値を取得します。

Parameters:

accessCondition - AccessCondition共有のアクセス条件を表す オブジェクト。
options - FileRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

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

適用対象