CosmosDBTrigger インターフェイス

パッケージ:

com.microsoft.azure.functions.annotation

public interface CosmosDBTrigger

CosmosDBTrigger(name = "database", databaseName = "ToDoList", collectionName = "Items", leaseCollectionName = "leases", createLeaseCollectionIfNotExists = true, connectionStringSetting = "AzureCosmosDBConnection") List<Map<String, String>> items, final ExecutionContext context ) { context.getLogger().info(items.size() + " item(s) is/are inserted."); if (!items.isEmpty()) { context.getLogger().info("The ID of the first item is: " + items.get(0).get("id")); } }

メソッドの概要

修飾子と型	メソッドと説明
int	checkpointDocumentCount() リース チェックポイント間のドキュメントの量をカスタマイズします。 既定値は、常に関数呼び出しの後です。
int	checkpointInterval() リース チェックポイント間のミリ秒単位をカスタマイズします。 既定値は、常に関数呼び出しの後です。
String	collectionName() バインドする CosmosDB のコレクション名を定義します。
String	connectionStringSetting() CosmosDB 接続文字列を含むアプリ設定名を定義します。
boolean	createLeaseCollectionIfNotExists() 存在しない場合に新しいリース コレクションを作成するかどうかを定義します。
String	databaseName() バインドする CosmosDB のデータベース名を定義します。
String	dataType() Functions ランタイムがパラメーター値をどのように扱うかを定義します。 次のいずれかの値になります。 <li> <p>"": get the value as a string, and try to deserialize to actual parameter type like POJO </p> </li> <li> <p>string: always get the value as a string </p> </li> <li> <p>binary: get the value as a binary data, and try to deserialize to actual parameter type byte[] </p> </li>
int	feedPollDelay() 現在のすべての変更がドレインされた後、フィードの新しい変更についてパーティションをポーリングするまでの遅延をミリ秒単位でカスタマイズします。 既定値は 5,000 (5 秒) です。
int	leaseAcquireInterval() 既知のホスト インスタンス間でパーティションが均等に分散されている場合に計算するタスクを開始する間隔をミリ秒単位でカスタマイズします。 既定値は 13,000 (13 秒) です。
String	leaseCollectionName() バインド先の CosmosDB のリース コレクション名を定義します。
String	leaseCollectionPrefix() このトリガーの Leases コレクション内で使用するプレフィックスを定義します。 複数のトリガー間で同じリース コレクションを共有する場合に便利です。
String	leaseConnectionStringSetting() リース コレクションを含むサービスの接続文字列を定義します。
String	leaseDatabaseName() リース コレクションを含むデータベースの名前を定義します。
int	leaseExpirationInterval() パーティションを表すリースでリースを取得する間隔をミリ秒単位でカスタマイズします。 この期間内にリースが更新されない場合、リースは期限切れになり、パーティションの所有権は別のトリガー インスタンスに移動します。 既定値は 60,000 (60 秒) です。
int	leaseRenewInterval() トリガーによって現在保持されているパーティションのすべてのリースの更新間隔をミリ秒単位でカスタマイズします。 既定値は 17,000 (17 秒) です。
int	leasesCollectionThroughput() は、作成されたコレクションのスループットを定義します。
int	maxItemsPerInvocation() 呼び出しで受信したアイテムの最大量をカスタマイズします
String	name() function.json で使用される変数名。
String	preferredLocations() Azure Cosmos DB サービス内の geo レプリケートされたデータベース アカウントの優先する場所 (リージョン) を定義します。 複数の値はコンマで区切る必要があります。 例: PreferredLocations = "米国東部、米国中南部、北ヨーロッパ"
boolean	startFromBeginning() Azure Cosmos DB サービスの変更フィードを開始 (true) から開始するか、現在の (false) から開始するかを取得または設定します。 既定では、現在の (false) から開始されます。

メソッドの詳細

checkpointDocumentCount

public int checkpointDocumentCount() default -1

リース チェックポイント間のドキュメントの量をカスタマイズします。 既定値は、常に関数呼び出しの後です。

Returns:

CheckpointDocumentCount

checkpointInterval

public int checkpointInterval() default -1

リース チェックポイント間のミリ秒単位をカスタマイズします。 既定値は、常に関数呼び出しの後です。

Returns:

checkpointInterval

collectionName

public String collectionName()

バインドする CosmosDB のコレクション名を定義します。

Returns:

コレクション名の文字列。

connectionStringSetting

public String connectionStringSetting()

CosmosDB 接続文字列を含むアプリ設定名を定義します。

Returns:

接続文字列のアプリ設定名。

createLeaseCollectionIfNotExists

public boolean createLeaseCollectionIfNotExists() default false

存在しない場合に新しいリース コレクションを作成するかどうかを定義します。

Returns:

新しいリース コレクションが存在しない場合は作成するかどうかを構成します。

databaseName

public String databaseName()

バインドする CosmosDB のデータベース名を定義します。

Returns:

データベース名の文字列。

dataType

public String dataType() default ""

Functions ランタイムがパラメーター値をどのように扱うかを定義します。 次のいずれかの値になります。

<li>

  <p>"": get the value as a string, and try to deserialize to actual parameter type like POJO </p>

</li>

<li>

  <p>string: always get the value as a string </p>

</li>

<li>

  <p>binary: get the value as a binary data, and try to deserialize to actual parameter type byte[] </p>

</li>

Returns:

Functions ランタイムによって使用される dataType。

feedPollDelay

public int feedPollDelay() default 5000

現在のすべての変更がドレインされた後、フィードの新しい変更についてパーティションをポーリングするまでの遅延をミリ秒単位でカスタマイズします。 既定値は 5,000 (5 秒) です。

Returns:

feedPollDelay

leaseAcquireInterval

public int leaseAcquireInterval() default 13000

既知のホスト インスタンス間でパーティションが均等に分散されている場合に計算するタスクを開始する間隔をミリ秒単位でカスタマイズします。 既定値は 13,000 (13 秒) です。

Returns:

間隔 (ミリ秒単位)

leaseCollectionName

public String leaseCollectionName() default ""

バインド先の CosmosDB のリース コレクション名を定義します。

Returns:

リース コレクション名の文字列。

leaseCollectionPrefix

public String leaseCollectionPrefix() default ""

このトリガーの Leases コレクション内で使用するプレフィックスを定義します。 複数のトリガー間で同じリース コレクションを共有する場合に便利です。

Returns:

LeaseCollectionPrefix

leaseConnectionStringSetting

public String leaseConnectionStringSetting() default ""

リース コレクションを含むサービスの接続文字列を定義します。

Returns:

リース コレクションの接続文字列。

leaseDatabaseName

public String leaseDatabaseName() default ""

リース コレクションを含むデータベースの名前を定義します。

Returns:

リース コレクションのデータベースの名前。

leaseExpirationInterval

public int leaseExpirationInterval() default 60000

パーティションを表すリースでリースを取得する間隔をミリ秒単位でカスタマイズします。 この期間内にリースが更新されない場合、リースは期限切れになり、パーティションの所有権は別のトリガー インスタンスに移動します。 既定値は 60,000 (60 秒) です。

Returns:

リースが取得される間隔 (ミリ秒単位)

leaseRenewInterval

public int leaseRenewInterval() default 17000

トリガーによって現在保持されているパーティションのすべてのリースの更新間隔をミリ秒単位でカスタマイズします。 既定値は 17,000 (17 秒) です。

Returns:

すべてのリースの更新間隔 (ミリ秒単位)

leasesCollectionThroughput

public int leasesCollectionThroughput() default -1

は、作成されたコレクションのスループットを定義します。

Returns:

throughput

maxItemsPerInvocation

public int maxItemsPerInvocation() default -1

呼び出しで受信したアイテムの最大量をカスタマイズします

Returns:

受信したアイテムの最大数

name

public String name()

function.json で使用される変数名。

Returns:

function.json で使用される変数名。

preferredLocations

public String preferredLocations() default ""

Azure Cosmos DB サービス内の geo レプリケートされたデータベース アカウントの優先する場所 (リージョン) を定義します。 複数の値はコンマで区切る必要があります。 例: PreferredLocations = "米国東部、米国中南部、北ヨーロッパ"

Returns:

geo レプリケートされたデータベース アカウントの優先する場所 (リージョン)

startFromBeginning

public boolean startFromBeginning() default false

Azure Cosmos DB サービスの変更フィードを開始 (true) から開始するか、現在の (false) から開始するかを取得または設定します。 既定では、現在の (false) から開始されます。

Returns:

変更フィードを最初から開始するかどうかを構成する