CloudFileShare クラス
- java.
lang. Object - com.
microsoft. azure. storage. file. CloudFileShare
- com.
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 と資格情報を使用して、 クラスのインスタンスを作成します。 |
メソッドの概要
コンストラクターの詳細
CloudFileShare
public CloudFileShare(final StorageUri storageUri)
指定した URI を使用して、 クラスのインスタンスを作成します。
Parameters:
Throws:
CloudFileShare
public CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)
指定した StorageUri と資格情報を使用して、 クラスのインスタンスを作成します。
Parameters:
Throws:
CloudFileShare
public CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)
指定した名前とクライアントを使用して、 クラスのインスタンスを作成します。
Parameters:
String
共有の名前を表す 。共有の名前付け規則に従う必要があります。 共有名には、パス区切り文字 (/) を含めないようにしてください。 共有名は小文字で、長さは 3 から 63 文字で、先頭は文字または数字である必要があります。 共有名には、文字、数字、ダッシュ (-) 文字のみを含むことができます。
String
該当する場合は、スナップショットバージョンを表す 。
Throws:
CloudFileShare
public CloudFileShare(final URI uri)
指定した URI を使用して、 クラスのインスタンスを作成します。
Parameters:
java.net.URI
共有の絶対 URI を表す オブジェクト。
Throws:
CloudFileShare
public CloudFileShare(final URI uri, final StorageCredentials credentials)
指定した URI と資格情報を使用して、 クラスのインスタンスを作成します。
Parameters:
java.net.URI
共有の絶対 URI を表す オブジェクト。
Throws:
メソッドの詳細
assertNoSnapshot
protected void assertNoSnapshot()
共有がスナップショットではないことをアサートします。
create
public void create()
共有を作成します。
Throws:
create
public void create(FileRequestOptions options, OperationContext opContext)
指定したオプションと操作コンテキストを使用して共有を作成します。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Throws:
createFilePermission
public String createFilePermission(String permission)
ファイルのアクセス許可を作成します。
Parameters:
String
作成するファイルアクセス許可を表す オブジェクト。
Returns:
String
作成されたファイルアクセス許可に関連付けられているファイルアクセス許可キーを表す 。Throws:
createFilePermission
public String createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)
ファイルのアクセス許可を作成します。
Parameters:
String
作成するファイルアクセス許可を表す オブジェクト。
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Returns:
String
作成されたファイルアクセス許可に関連付けられているファイルアクセス許可キーを表す 。Throws:
createIfNotExists
public boolean createIfNotExists()
共有が存在しない場合は作成します。
Returns:
共有がまだ存在せず作成された場合は true
、それ以外の場合は false
です。
Throws:
createIfNotExists
public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、共有が存在しない場合は作成します。
Parameters:
null
指定すると、関連付けられているサービス クライアント (CloudFileClient) からの既定の要求オプションが使用されます。
Returns:
共有がまだ存在せず作成された場合は true
、それ以外の場合は false
です。
Throws:
createSnapshot
public final CloudFileShare createSnapshot()
共有のスナップショットを作成します。
Returns:
CloudFileShare
共有のスナップショットを表す オブジェクト。Throws:
createSnapshot
public final CloudFileShare createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、ファイル共有のスナップショットを作成します。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Returns:
CloudFileShare
ファイル共有のスナップショットを表す オブジェクト。Throws:
createSnapshot
public final CloudFileShare createSnapshot(final HashMap
指定した要求オプションと操作コンテキストを使用して、ファイル共有のスナップショットを作成します。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Returns:
CloudFileShare
ファイル共有のスナップショットを表す オブジェクト。Throws:
delete
public void delete()
共有を削除します。
Throws:
delete
public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して共有を削除します。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Throws:
delete
public void delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
指定したスナップショットと要求オプション、および操作コンテキストを使用して共有を削除します。
スナップショットを含む共有は、スナップショットも削除されない限り削除できません。 共有にスナップショットがある場合は、 パラメーターの 値を INCLUDE_SNAPSHOTS 使用して、ベース共有を削除するときにスナップショットを含めます。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Throws:
deleteIfExists
public boolean deleteIfExists()
共有が存在する場合は削除します。
Returns:
true
共有が存在し、削除された場合。それ以外の場合は false
。
Throws:
deleteIfExists
public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して共有が存在する場合は削除します。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Returns:
true
共有が存在し、削除された場合。それ以外の場合は false
。
Throws:
deleteIfExists
public boolean deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
指定したスナップショットと要求オプション、および操作コンテキストを使用して、共有が存在する場合は削除します。
スナップショットを含む共有は、スナップショットも削除されない限り削除できません。 共有にスナップショットがある場合は、 パラメーターの 値を INCLUDE_SNAPSHOTS 使用して、ベース共有を削除するときにスナップショットを含めます。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Returns:
true
共有が存在し、削除された場合。それ以外の場合は false
。
Throws:
downloadAttributes
public void downloadAttributes()
メタデータとプロパティで構成される共有の属性をダウンロードします。
Throws:
downloadAttributes
public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、メタデータとプロパティで構成される共有の属性をダウンロードします。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Throws:
downloadPermissions
public FileSharePermissions downloadPermissions()
共有のアクセス許可設定をダウンロードします。
Returns:
Throws:
downloadPermissions
public FileSharePermissions downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、共有のアクセス許可設定をダウンロードします。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
exists
public boolean exists()
共有が存在するかどうかを示す値を返します。
Returns:
true
共有が存在する場合は 。それ以外の場合 false
は 。
Throws:
exists
public boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、共有が存在するかどうかを示す値を返します。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Returns:
true
共有が存在する場合は 。それ以外の場合 false
は 。
Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)
共有の共有アクセス署名を返します。 先頭の "?"は含まれていないことに注意してください。
Parameters:
String
共有レベルのアクセス ポリシーを表す 。
Returns:
String
共有の共有アクセス署名を表す 。Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
共有の共有アクセス署名を返します。 先頭の "?"は含まれていないことに注意してください。
Parameters:
String
共有レベルのアクセス ポリシーを表す 。
Returns:
String
共有の共有アクセス署名を表す 。Throws:
getFilePermission
public String getFilePermission(String filePermissionKey)
ファイルのアクセス許可キーに関連付けられているファイルのアクセス許可を取得します。
Parameters:
String
アクセス許可キーを表す オブジェクト。
Returns:
String
ファイルのアクセス許可キーに関連付けられているファイルのアクセス許可を表す 。Throws:
getFilePermission
public String getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)
ファイルのアクセス許可キーに関連付けられているファイルのアクセス許可を取得します。
Parameters:
String
アクセス許可キーを表す オブジェクト。
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Returns:
String
ファイルのアクセス許可キーに関連付けられているファイルのアクセス許可を表す 。Throws:
getMetadata
public HashMap
共有のメタデータを返します。 この値は、 の呼び出しによって共有のメタデータで初期化され、 の downloadAttributes()呼び出 uploadMetadata()しで共有に設定されます。
Returns:
java.util.HashMap
共有のメタデータを表す オブジェクト。getName
public String getName()
共有の名前を返します。
Returns:
String
共有の名前を表す 。getProperties
public FileShareProperties getProperties()
共有のプロパティを返します。
Returns:
getQualifiedUri
public final URI getQualifiedUri()
この共有のスナップショットまたは共有アクセス署名の修飾 URI を返します。
Returns:
java.net.URI
スナップショットまたは共有アクセス署名を表す オブジェクト。Throws:
getRootDirectoryReference
public CloudFileDirectory getRootDirectoryReference()
この共有内のルート ファイル ディレクトリを CloudFileDirectory 表す オブジェクトへの参照を返します。
Returns:
Throws:
getServiceClient
public CloudFileClient getServiceClient()
この共有に関連付けられているファイル サービス クライアントを返します。
Returns:
getSnapshot
public final String getSnapshot()
この共有の snapshotID を返します。
Returns:
getStats
public ShareStats getStats()
この共有の のサービスに対してクエリを実行 ShareStatsします。
Returns:
Throws:
getStats
public ShareStats getStats(FileRequestOptions options, OperationContext opContext)
この共有の のサービスに対してクエリを実行 ShareStatsします。
Parameters:
null
指定すると、関連付けられているサービス クライアント (CloudFileClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
getStorageUri
public StorageUri getStorageUri()
すべての場所の URI の一覧を返します。
Returns:
getUri
public URI getUri()
この共有の URI を返します。
Returns:
isSnapshot
public final boolean isSnapshot()
この共有がスナップショットかどうかを示します。
Returns:
true
共有がスナップショットの場合は 。それ以外の場合false
は 。
setMetadata
public void setMetadata(final HashMap
呼び出しで共有に設定する名前と値のペアのメタデータ コレクションを uploadMetadata() 設定します。 このコレクションは、既存の共有メタデータを上書きします。 これが空のコレクションに設定されている場合、共有メタデータは呼び出しで uploadMetadata() クリアされます。
Parameters:
java.util.HashMap
共有に割り当てられているメタデータを表す オブジェクト。
setProperties
public void setProperties(final FileShareProperties properties)
共有のプロパティを設定します。
Parameters:
uploadMetadata
public void uploadMetadata()
共有のメタデータをアップロードします。
Throws:
uploadMetadata
public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、共有のメタデータをアップロードします。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Throws:
uploadPermissions
public void uploadPermissions(final FileSharePermissions permissions)
共有のアクセス許可をアップロードします。
Parameters:
Throws:
uploadPermissions
public void uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、共有のアクセス許可をアップロードします。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Throws:
uploadProperties
public final void uploadProperties()
ストレージ サービスで共有のプロパティを更新します。
を使用して downloadAttributes() 、Microsoft Azure ストレージ サービスから共有のプロパティとメタデータの最新の値を取得します。
Throws:
uploadProperties
public final void uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
要求オプションと操作コンテキストを使用して、共有のプロパティを更新します。
を使用して downloadAttributes() 、Microsoft Azure ストレージ サービスから共有のプロパティとメタデータの最新の値を取得します。
Parameters:
null
指定すると、関連付けられているサービス クライアント ( CloudFileClient) からの既定の要求オプションが使用されます。
Throws:
適用対象
Azure SDK for Java