CloudFileClient クラス

パッケージ:

com.microsoft.azure.storage.file

• java.lang.Object
• • ServiceClient
  • • com.microsoft.azure.storage.file.CloudFileClient

public class CloudFileClient extends ServiceClient

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

このクラスは、File サービスへのアクセスポイントを提供します。 サービス クライアントはファイル サービスのベース URI をカプセル化します。 また、ストレージ アカウントにアクセスするための資格情報もカプセル化します。

コンストラクターの概要

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

メソッドの概要

修飾子と型	メソッドと説明
final FileServiceProperties	downloadServiceProperties() 指定されたストレージ サービスの現在 FileServiceProperties の を取得します。 これにより、CORS 構成がカプセル化されます。
final FileServiceProperties	downloadServiceProperties(FileRequestOptions options, OperationContext opContext) 指定されたストレージ サービスの現在 FileServiceProperties の を取得します。 これにより、CORS 構成がカプセル化されます。
FileRequestOptions	getDefaultRequestOptions() これに関連付けられている要求に使用される を取得します。FileRequestOptions
CloudFileShare	getShareReference(final String shareName) 指定した名前の CloudFileShare オブジェクトを取得します。
CloudFileShare	getShareReference(final String shareName, String snapshotID) 指定した名前の CloudFileShare オブジェクトを取得します。
boolean	isUsePathStyleUris() パス スタイルの URI が使用されているかどうかを示します。
Iterable<CloudFileShare>	listShares() このファイル サービス クライアントの共有の列挙可能なコレクションを返します。
Iterable<CloudFileShare>	listShares(final String prefix) このファイル サービス クライアントの指定したプレフィックスで始まる名前を持つ共有の列挙可能なコレクションを返します。
Iterable<CloudFileShare>	listShares(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final FileRequestOptions options, final OperationContext opContext) 指定した詳細設定、要求オプション、および操作コンテキストを使用して、このファイル サービス クライアントの指定したプレフィックスで始まる名前を持つ共有の列挙可能なコレクションを返します。
ResultSegment<CloudFileShare>	listSharesSegmented() このファイル サービス クライアントの共有の列挙可能なコレクションの結果セグメントを返します。
ResultSegment<CloudFileShare>	listSharesSegmented(final String prefix) このファイル サービス クライアントの指定したプレフィックスで始まる名前を持つ共有の列挙可能なコレクションの結果セグメントを返します。
ResultSegment<CloudFileShare>	listSharesSegmented(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final FileRequestOptions options, final OperationContext opContext) 指定したリストの詳細オプション、要求オプション、および操作コンテキストを使用して、指定したプレフィックスで始まる名前を持つ共有の列挙可能なコレクションの結果セグメントを返します。
void	setDefaultRequestOptions(FileRequestOptions defaultRequestOptions) このオブジェクトに FileRequestOptions 関連付けられている要求に使用される を設定します。
void	uploadServiceProperties(final FileServiceProperties properties) 指定されたストレージ サービスに新しい FileServiceProperties 構成をアップロードします。 これにより、CORS 構成がカプセル化されます。
void	uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options, OperationContext opContext) 指定されたストレージ サービスに新しい FileServiceProperties 構成をアップロードします。 これにより、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)

コンストラクターの詳細

CloudFileClient

public CloudFileClient(final URI baseUri, StorageCredentials credentials)

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

Parameters:

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

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

CloudFileClient

public CloudFileClient(StorageUri storageUri, StorageCredentials credentials)

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

Parameters:

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

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

メソッドの詳細

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties()

指定されたストレージ サービスの現在 FileServiceProperties の を取得します。 これにより、CORS 構成がカプセル化されます。

Returns:

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

Throws:

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

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties(FileRequestOptions options, OperationContext opContext)

指定されたストレージ サービスの現在 FileServiceProperties の を取得します。 これにより、CORS 構成がカプセル化されます。

Parameters:

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

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

Returns:

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

Throws:

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

getDefaultRequestOptions

public FileRequestOptions getDefaultRequestOptions()

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

Returns:

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

getShareReference

public CloudFileShare getShareReference(final String shareName)

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

Parameters:

shareName - 共有の名前。共有の名前付け規則に従う必要があります。 共有名には、パス区切り文字 (/) を含めないようにしてください。 共有名は小文字で、3 から 63 文字の長さにし、文字または数字で始まる必要があります。 共有名には、文字、数字、ダッシュ (-) 文字のみを使用できます。

Returns:

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

Throws:

StorageException

URISyntaxException

getShareReference

public CloudFileShare getShareReference(final String shareName, String snapshotID)

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

Parameters:

shareName - 共有の名前。共有の名前付け規則に従う必要があります。 共有名には、パス区切り文字 (/) を含めないようにしてください。 共有名は小文字で、3 から 63 文字の長さにし、文字または数字で始まる必要があります。 共有名には、文字、数字、ダッシュ (-) 文字のみを使用できます。

snapshotID - String共有のスナップショット ID を表す 。

Returns:

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

Throws:

StorageException

URISyntaxException

isUsePathStyleUris

protected boolean isUsePathStyleUris()

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

Returns:

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

listShares

public Iterable listShares()

このファイル サービス クライアントの共有の列挙可能なコレクションを返します。

Returns:

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

listShares

public Iterable listShares(final String prefix)

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

Parameters:

prefix - String共有名プレフィックスを表す 。

Returns:

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

listShares

public Iterable listShares(final String prefix, final EnumSet detailsIncluded, final FileRequestOptions options, final OperationContext opContext)

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

Parameters:

prefix - String共有名プレフィックスを表す 。

detailsIncluded - java.util.EnumSet共有スナップショットまたはメタデータを返すかどうかを示す値を含む ShareListingDetails オブジェクト。

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

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

Returns:

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

listSharesSegmented

public ResultSegment listSharesSegmented()

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

Returns:

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

Throws:

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

listSharesSegmented

public ResultSegment listSharesSegmented(final String prefix)

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

Parameters:

prefix - String共有名のプレフィックスを表す 。

Returns:

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

Throws:

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

listSharesSegmented

public ResultSegment listSharesSegmented(final String prefix, final EnumSet detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final FileRequestOptions options, final OperationContext opContext)

指定したリストの詳細オプション、要求オプション、および操作コンテキストを使用して、指定したプレフィックスで始まる名前を持つ共有の列挙可能なコレクションの結果セグメントを返します。

Parameters:

prefix - String共有名のプレフィックスを表す 。

detailsIncluded - java.util.EnumSet共有スナップショットやメタデータを返すかどうかを示す値を含む ShareListingDetails オブジェクト。

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

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

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

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

Returns:

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

Throws:

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

setDefaultRequestOptions

public void setDefaultRequestOptions(FileRequestOptions defaultRequestOptions)

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

Parameters:

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

uploadServiceProperties

public void uploadServiceProperties(final FileServiceProperties properties)

指定されたストレージ サービスに新しい FileServiceProperties 構成をアップロードします。 これにより、CORS 構成がカプセル化されます。

Parameters:

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

Throws:

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

uploadServiceProperties

public void uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options, OperationContext opContext)

指定されたストレージ サービスに新しい FileServiceProperties 構成をアップロードします。 これにより、CORS 構成がカプセル化されます。

Parameters:

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

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

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

Throws:

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