CosmosDBInput インターフェイス

パッケージ:

com.microsoft.azure.functions.annotation

public interface CosmosDBInput

CosmosDBInput(name = "database", databaseName = "ToDoList", collectionName = "Items", id = "{Query.id}", connectionStringSetting = "AzureCosmosDBConnection") Optional<String> item ) { return item.orElse("Not found"); }

メソッドの概要

修飾子と型	メソッドと説明
String	collectionName() バインド先の CosmosDB のコレクション名を定義します。
String	connectionStringSetting() CosmosDB 接続文字列を含むアプリ設定名を定義します。
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>
String	id() バインド先の CosmosDB の ID を定義します。
String	name() function.json で使用される変数名。
String	partitionKey() 参照のパーティション キー値を定義します。 バインディング パラメーターを含めることもできます。
String	sqlQuery() バインド先の SQL クエリ文字列を定義します。

メソッドの詳細

collectionName

public String collectionName()

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

Returns:

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

connectionStringSetting

public String connectionStringSetting()

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

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。

id

public String id() default ""

バインド先の CosmosDB の ID を定義します。

Returns:

ID 文字列。

name

public String name()

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

Returns:

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

partitionKey

public String partitionKey() default ""

参照のパーティション キー値を定義します。 バインディング パラメーターを含めることもできます。

Returns:

パーティション キーの値

sqlQuery

public String sqlQuery() default ""

バインド先の SQL クエリ文字列を定義します。

Returns:

SQL クエリ文字列。