Package com.azure.ai.agents.persistent.models

Class AzureFunctionDefinition

java.lang.Object

com.azure.ai.agents.persistent.models.AzureFunctionDefinition

All Implemented Interfaces:

com.azure.json.JsonSerializable<AzureFunctionDefinition>

public final class AzureFunctionDefinition
extends Object
implements com.azure.json.JsonSerializable<AzureFunctionDefinition>

The definition of Azure function.

Constructor Summary

Constructors

Constructor	Description
AzureFunctionDefinition(FunctionDefinition function, AzureFunctionBinding inputBinding, AzureFunctionBinding outputBinding)	Creates an instance of AzureFunctionDefinition class.

Method Summary

Modifier and Type	Method	Description
static AzureFunctionDefinition	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of AzureFunctionDefinition from the JsonReader.
FunctionDefinition	getFunction()	Get the function property: The definition of azure function and its parameters.
AzureFunctionBinding	getInputBinding()	Get the inputBinding property: Input storage queue.
AzureFunctionBinding	getOutputBinding()	Get the outputBinding property: Output storage queue.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

AzureFunctionDefinition

public AzureFunctionDefinition(FunctionDefinition function,
 AzureFunctionBinding inputBinding,
 AzureFunctionBinding outputBinding)

Creates an instance of AzureFunctionDefinition class.

Parameters:

function - the function value to set.

inputBinding - the inputBinding value to set.

outputBinding - the outputBinding value to set.

Method Details

getFunction

public FunctionDefinition getFunction()

Get the function property: The definition of azure function and its parameters.

Returns:

the function value.

getInputBinding

public AzureFunctionBinding getInputBinding()

Get the inputBinding property: Input storage queue. The queue storage trigger runs a function as messages are added to it.

Returns:

the inputBinding value.

getOutputBinding

public AzureFunctionBinding getOutputBinding()

Get the outputBinding property: Output storage queue. The function writes output to this queue when the input items are processed.

Returns:

the outputBinding value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<AzureFunctionDefinition>

Throws:

IOException

fromJson

public static AzureFunctionDefinition fromJson(com.azure.json.JsonReader jsonReader)
                                        throws IOException

Reads an instance of AzureFunctionDefinition from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureFunctionDefinition if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the AzureFunctionDefinition.