CloudTableClient クラス

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

public class CloudTableClient extends ServiceClient

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

クラスは CloudTableClient 、Table サービス エンドポイントのベース URI とストレージ アカウントにアクセスするための資格情報をカプセル化し、テーブルを作成、削除、一覧表示、クエリするためのメソッド、およびテーブル エンティティに対して操作とクエリを実行するメソッドを提供します。 これらのメソッドは、Storage Service REST API 操作を呼び出して要求を行い、返される結果を取得します。

Table Service エンドポイントは、ストレージ アカウントの DNS 名を含む、Table Service リソースのベース URI です。

詳細については、MSDN トピック「 Table Service リソースのアドレス指定」を参照してください。

資格情報には、ストレージ アカウント名とキーの組み合わせ、または共有アクセス署名を指定できます。 詳細については、MSDN トピック「 ストレージ アカウントへのアクセスの認証」を参照してください。

コンストラクターの概要

コンストラクター 説明
CloudTableClient(final StorageUri baseUri, StorageCredentials credentials)

Table サービス エンドポイントとストレージ アカウントの資格情報を使用して、 クラスのインスタンスを初期化します。
CloudTableClient(final URI baseUri, StorageCredentials credentials)

Table service エンドポイントとストレージ アカウントの資格情報を使用して、 クラスのインスタンスを初期化します。

メソッドの概要

修飾子と型 メソッドと説明
final ServiceProperties downloadServiceProperties()

指定されたストレージ サービスの現在 ServiceProperties の を取得します。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。
final ServiceProperties downloadServiceProperties(TableRequestOptions options, OperationContext opContext)

指定されたストレージ サービスの現在 ServiceProperties の を取得します。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。
<T extends TableEntity, R> ResultSegment<?> executeQuerySegmentedImpl(final TableQuery<T> queryToExecute, final EntityResolver<R> resolver, final ResultContinuation continuationToken, TableRequestOptions options, OperationContext opContext)

内部使用のために予約されています。 指定した再試行ポリシーとタイムアウト ポリシーを使用して、セグメント化されたクエリ操作を実行します。
<T extends TableEntity, R> Iterable<?> generateIteratorForQuery(final TableQuery<T> queryRef, final EntityResolver<R> resolver, TableRequestOptions options, OperationContext opContext)

内部使用のために予約されています。 セグメント化されたクエリ操作の反復子を生成します。
TableRequestOptions getDefaultRequestOptions()

TableRequestOptionsこれに関連付けられている要求に使用される を取得します。
ServiceStats getServiceStats()

のサービスに対してクエリを実行します ServiceStats。
ServiceStats getServiceStats(TableRequestOptions options, OperationContext opContext)

特定のストレージ サービスに 対して を照会します ServiceStats。
CloudTable getTableReference(final String tableName)

指定した名前の CloudTable オブジェクトを取得します。
final StorageUri getTransformedEndPoint(final OperationContext opContext)
boolean isUsePathStyleUris()

パス スタイルの URI を使用するかどうかを示します。
Iterable<String> listTables()

ストレージ アカウント内のテーブル名を一覧表示します。

このメソッドは、このインスタンスの Table Service エンドポイントとストレージ アカウントの資格情報を使用して、 クエリ テーブル REST API を呼び出してテーブル名を一覧表示します。
Iterable<String> listTables(final String prefix)

指定したプレフィックスと一致するストレージ アカウント内のテーブル名を一覧表示します。

このメソッドは 、クエリ テーブル REST API を呼び出して、このインスタンスの Table Service エンドポイントとストレージ アカウントの資格情報を使用して、プレフィックスに一致するテーブル名を一覧表示します。
Iterable<String> listTables(final String prefix, final TableRequestOptions options, final OperationContext opContext)

指定した と を使用して、指定したプレフィックスと一致するストレージ アカウント内のテーブル名を一TableRequestOptionsOperationContext覧表示します。

このメソッドは 、クエリ テーブル REST API を呼び出して、このインスタンスの Table Service エンドポイントとストレージ アカウントの資格情報を使用して、プレフィックスに一致するテーブル名を一覧表示します。

操作の TableRequestOptions タイムアウトや再試行ポリシーなどの実行オプションをオーバーライドするには、 を使用します。
ResultSegment<String> listTablesSegmented()

セグメント化モードのストレージ アカウントのテーブル名を一覧表示します。 このメソッドを使用すると、 オブジェクト内のサーバーから返された情報を使用して、結果の一部を返した後にテーブルの一覧を ResultSegment<T> 再開できます。

このメソッドは、このインスタンスの Table Service エンドポイントとストレージ アカウントの資格情報を使用して、 クエリ テーブル REST API を呼び出してテーブル名を一覧表示します。
ResultSegment<String> listTablesSegmented(final String prefix)

セグメント化モードで指定されたプレフィックスと一致するストレージ アカウント内のテーブル名を一覧表示します。 このメソッドを使用すると、 オブジェクト内のサーバーから返された情報を使用して、結果の一部を返した後にテーブルの一覧を ResultSegment<T> 再開できます。

このメソッドは 、クエリ テーブル REST API を呼び出して、このインスタンスの Table Service エンドポイントとストレージ アカウントの資格情報を使用して、プレフィックスに一致するテーブル名を一覧表示します。
ResultSegment<String> listTablesSegmented(final String prefix, final Integer maxResults, final ResultContinuation continuationToken, final TableRequestOptions options, final OperationContext opContext)

指定した と を使用して、再開可能モードで指定されたプレフィックスと指定した継続トークンと一致する、ストレージ アカウント内の指定された ResultContinuationTableRequestOptionsOperationContext最大テーブル名を一覧表示します。 このメソッドを使用すると、 オブジェクト内のサーバーから返された情報を使用して、結果のページを返した後にテーブルの一覧を ResultSegment<T> 再開できます。

このメソッドは 、クエリ テーブル REST API を呼び出し、このインスタンスの Table サービス エンドポイントとストレージ アカウントの資格情報を使用して、プレフィックスに一致するテーブル名を一覧表示します。

を TableRequestOptions 使用して、操作のタイムアウトや再試行ポリシーなどの実行オプションをオーバーライドします。
void setDefaultRequestOptions(TableRequestOptions defaultRequestOptions)

このオブジェクトで TableRequestOptions アクセスされるすべてのテーブルに使用される を設定します。
void uploadServiceProperties(final ServiceProperties properties)

指定されたストレージ サービスに新しい ServiceProperties 構成をアップロードします。 これには、ログ記録、HourMetrics、MinuteMetrics、CORS 構成が含まれます。
void uploadServiceProperties(final ServiceProperties properties, TableRequestOptions options, OperationContext opContext)

指定されたストレージ サービスに新しい ServiceProperties 構成をアップロードします。 これには、ログ記録、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)

コンストラクターの詳細

CloudTableClient

public CloudTableClient(final StorageUri baseUri, StorageCredentials credentials)

Table サービス エンドポイントとストレージ アカウントの資格情報を使用して、 クラスのインスタンスを初期化します。

Parameters:

baseUri - クライアントの StorageUri 初期化に使用される Table サービス エンドポイントを表す オブジェクト。
credentials - StorageCredentialsアクセス用のストレージ アカウントの資格情報を表す オブジェクト。

CloudTableClient

public CloudTableClient(final URI baseUri, StorageCredentials credentials)

Table service エンドポイントとストレージ アカウントの資格情報を使用して、 クラスのインスタンスを初期化します。

Parameters:

baseUri - クライアントの java.net.URI 初期化に使用される Table サービス エンドポイントを表す オブジェクト。
credentials - StorageCredentialsアクセス用のストレージ アカウントの資格情報を表す オブジェクト。

メソッドの詳細

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

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

Returns:

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

Throws:

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

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(TableRequestOptions options, OperationContext opContext)

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

Parameters:

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

Returns:

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

Throws:

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

executeQuerySegmentedImpl

protected ResultSegment executeQuerySegmentedImpl(final TableQuery queryToExecute, final EntityResolver resolver, final ResultContinuation continuationToken, TableRequestOptions options, OperationContext opContext)

内部使用のために予約されています。 指定した再試行ポリシーとタイムアウト ポリシーを使用して、セグメント化されたクエリ操作を実行します。

Parameters:

queryToExecute - TableQuery<T>実行する 。
resolver - 指定された型 R に対してテーブルのクエリ結果エンティティを射影する EntityResolver<T> インスタンスです。 を渡 null して、結果をテーブル エンティティ型として返します。
continuationToken - ResultContinuationクエリを再開する操作で渡す 。 最初のクエリに渡 null します。
options - TableRequestOptions操作の再試行ポリシーやタイムアウト設定などの実行オプションを指定する オブジェクト。 で指定 null された要求オプションを使用するように を指定します CloudTableClient。
opContext - 現在の操作を追跡するための OperationContext オブジェクトです。 操作コンテキストを安全に無視するように を指定 null します。

Returns:

ResultSegment<T>クエリによって返される または EntityResolver<T> 型に特化TableEntityしたクエリ結果のコレクションを格納している 。

Throws:

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

generateIteratorForQuery

protected Iterable generateIteratorForQuery(final TableQuery queryRef, final EntityResolver resolver, TableRequestOptions options, OperationContext opContext)

内部使用のために予約されています。 セグメント化されたクエリ操作の反復子を生成します。

Parameters:

queryRef - TableQuery<T>実行する 。
resolver - 指定された型 R に対してテーブルのクエリ結果エンティティを射影する EntityResolver<T> インスタンスです。 を渡 null して、結果をテーブル エンティティ型として返します。
options - TableRequestOptions操作の再試行ポリシーやタイムアウト設定などの実行オプションを指定する オブジェクト。 で指定 null された要求オプションを使用するように を指定します CloudTableClient。
opContext - 現在の操作を追跡するための OperationContext オブジェクトです。 操作コンテキストを安全に無視するように を指定 null します。

Returns:

クエリによって返される または EntityResolver<T> 型に特化TableEntityした のインスタンスIterable。

getDefaultRequestOptions

public TableRequestOptions getDefaultRequestOptions()

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

Returns:

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

getServiceStats

public ServiceStats getServiceStats()

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

Returns:

ServiceStats 特定のストレージ サービスの

Throws:

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

getServiceStats

public ServiceStats getServiceStats(TableRequestOptions options, OperationContext opContext)

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

Parameters:

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

Returns:

ServiceStats 特定のストレージ サービスの

Throws:

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

getTableReference

public CloudTable getTableReference(final String tableName)

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

Parameters:

tableName - Stringテーブルの名前を表す 。テーブルの名前付け規則に従う必要があります。 テーブル名には、パス区切り文字 (/) を含めないようにしてください。 テーブル名では大文字と小文字が区別されず、アカウント内で一意である必要があり、3 から 63 文字の長さにする必要があります。 テーブル名は、 で始まる必要があります。数字で始めることはできません。英数字のみを含めることができます。 "table" など、一部のテーブル名は予約されています。

Returns:

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

Throws:

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

getTransformedEndPoint

protected final StorageUri getTransformedEndPoint(final OperationContext opContext)

Parameters:

opContext

isUsePathStyleUris

protected boolean isUsePathStyleUris()

パス スタイルの URI を使用するかどうかを示します。

Returns:

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

listTables

public Iterable listTables()

ストレージ アカウント内のテーブル名を一覧表示します。

このメソッドは、このインスタンスの Table Service エンドポイントとストレージ アカウントの資格情報を使用して、 クエリ テーブル REST API を呼び出してテーブル名を一覧表示します。

Returns:

Iterable遅延で取得されたストレージ アカウント内のテーブル名のコレクション。

listTables

public Iterable listTables(final String prefix)

指定したプレフィックスと一致するストレージ アカウント内のテーブル名を一覧表示します。

このメソッドは 、クエリ テーブル REST API を呼び出して、このインスタンスの Table Service エンドポイントとストレージ アカウントの資格情報を使用して、プレフィックスに一致するテーブル名を一覧表示します。

Parameters:

prefix - String返されるテーブル名で一致するプレフィックスを含む 。

Returns:

Iterable指定したプレフィックスと一致する遅延で取得されたストレージ アカウント内のテーブル名のコレクション。

listTables

public Iterable listTables(final String prefix, final TableRequestOptions options, final OperationContext opContext)

指定した と を使用して、指定したプレフィックスと一致するストレージ アカウント内のテーブル名を一TableRequestOptionsOperationContext覧表示します。

このメソッドは 、クエリ テーブル REST API を呼び出して、このインスタンスの Table Service エンドポイントとストレージ アカウントの資格情報を使用して、プレフィックスに一致するテーブル名を一覧表示します。

操作の TableRequestOptions タイムアウトや再試行ポリシーなどの実行オプションをオーバーライドするには、 を使用します。

Parameters:

prefix - String返されるテーブル名で一致するプレフィックスを含む 。
options - TableRequestOptions操作の再試行ポリシーやタイムアウト設定などの実行オプションを指定する オブジェクト。 で指定 null された要求オプションを使用するように を指定します CloudTableClient。
opContext - 現在の操作を追跡するための OperationContext オブジェクトです。 操作コンテキストを安全に無視するように を指定 null します。

Returns:

Iterable指定したプレフィックスと一致する遅延で取得されたストレージ アカウント内のテーブル名のコレクション。

listTablesSegmented

public ResultSegment listTablesSegmented()

セグメント化モードのストレージ アカウントのテーブル名を一覧表示します。 このメソッドを使用すると、 オブジェクト内のサーバーから返された情報を使用して、結果の一部を返した後にテーブルの一覧を ResultSegment<T> 再開できます。

このメソッドは、このインスタンスの Table Service エンドポイントとストレージ アカウントの資格情報を使用して、 クエリ テーブル REST API を呼び出してテーブル名を一覧表示します。

Returns:

ResultSegment<T>ストレージ アカウント内のStringテーブル名を含む オブジェクトの 。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合は 。

listTablesSegmented

public ResultSegment listTablesSegmented(final String prefix)

セグメント化モードで指定されたプレフィックスと一致するストレージ アカウント内のテーブル名を一覧表示します。 このメソッドを使用すると、 オブジェクト内のサーバーから返された情報を使用して、結果の一部を返した後にテーブルの一覧を ResultSegment<T> 再開できます。

このメソッドは 、クエリ テーブル REST API を呼び出して、このインスタンスの Table Service エンドポイントとストレージ アカウントの資格情報を使用して、プレフィックスに一致するテーブル名を一覧表示します。

Parameters:

prefix - String返されるテーブル名で一致するプレフィックスを含む 。

Returns:

ResultSegment<T>ストレージ アカウントのStringプレフィックスと一致するテーブル名を含む オブジェクトの 。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合は 。

listTablesSegmented

public ResultSegment listTablesSegmented(final String prefix, final Integer maxResults, final ResultContinuation continuationToken, final TableRequestOptions options, final OperationContext opContext)

指定した と を使用して、再開可能モードで指定されたプレフィックスと指定した継続トークンと一致する、ストレージ アカウント内の指定された ResultContinuationTableRequestOptionsOperationContext最大テーブル名を一覧表示します。 このメソッドを使用すると、 オブジェクト内のサーバーから返された情報を使用して、結果のページを返した後にテーブルの一覧を ResultSegment<T> 再開できます。

このメソッドは 、クエリ テーブル REST API を呼び出し、このインスタンスの Table サービス エンドポイントとストレージ アカウントの資格情報を使用して、プレフィックスに一致するテーブル名を一覧表示します。

を TableRequestOptions 使用して、操作のタイムアウトや再試行ポリシーなどの実行オプションをオーバーライドします。

Parameters:

prefix - String返されるテーブル名で一致するプレフィックスを含む 。
maxResults - で ResultSegment<T>返されるテーブル名の最大数。 このパラメーターが null の場合、クエリには最大 1,000 件の結果が一覧表示されます。
continuationToken - 操作の結果が部分的に返されたときにサーバーからの継続トークンを表す ResultContinuation オブジェクトです。 最初の呼び出しで を指定 null します。 クエリを getContinuationToken() 再開する次の呼び出しで使用するオブジェクトを取得 ResultContinuation するには、結果に対して メソッドを呼び出します。
options - TableRequestOptions操作の再試行ポリシーやタイムアウト設定などの実行オプションを指定する オブジェクト。 で指定 null された要求オプションを使用するように を指定します CloudTableClient。
opContext - 現在の操作を追跡するための OperationContext オブジェクトです。 操作コンテキストを安全に無視するように を指定 null します。

Returns:

ResultSegment<T>ストレージ アカウント内のStringテーブル名を含む オブジェクトの 。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合は 。

setDefaultRequestOptions

public void setDefaultRequestOptions(TableRequestOptions defaultRequestOptions)

このオブジェクトで TableRequestOptions アクセスされるすべてのテーブルに使用される を設定します。

Parameters:

defaultRequestOptions - 使用する TableRequestOptions。

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

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

Parameters:

properties - ServicePropertiesアップロードする 。

Throws:

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

uploadServiceProperties

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

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

Parameters:

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

Throws:

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

適用対象