AzureFunctionOutputDataSource Class

public final class AzureFunctionOutputDataSource
extends OutputDataSource

Defines the metadata of AzureFunctionOutputDataSource.

Constructor Summary

Constructor Description
AzureFunctionOutputDataSource()

Creates an instance of AzureFunctionOutputDataSource class.

Method Summary

Modifier and Type Method and Description
String apiKey()

Get the apiKey property: If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function.

static AzureFunctionOutputDataSource fromJson(JsonReader jsonReader)

Reads an instance of AzureFunctionOutputDataSource from the JsonReader.

String functionAppName()

Get the functionAppName property: The name of your Azure Functions app.

String functionName()

Get the functionName property: The name of the function in your Azure Functions app.

Float maxBatchCount()

Get the maxBatchCount property: A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions.

Float maxBatchSize()

Get the maxBatchSize property: A property that lets you set the maximum size for each output batch that's sent to your Azure function.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Indicates the type of data source output will be written to.

void validate()

Validates the instance.

AzureFunctionOutputDataSource withApiKey(String apiKey)

Set the apiKey property: If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function.

AzureFunctionOutputDataSource withFunctionAppName(String functionAppName)

Set the functionAppName property: The name of your Azure Functions app.

AzureFunctionOutputDataSource withFunctionName(String functionName)

Set the functionName property: The name of the function in your Azure Functions app.

AzureFunctionOutputDataSource withMaxBatchCount(Float maxBatchCount)

Set the maxBatchCount property: A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions.

AzureFunctionOutputDataSource withMaxBatchSize(Float maxBatchSize)

Set the maxBatchSize property: A property that lets you set the maximum size for each output batch that's sent to your Azure function.

Methods inherited from OutputDataSource

Methods inherited from java.lang.Object

Constructor Details

AzureFunctionOutputDataSource

public AzureFunctionOutputDataSource()

Creates an instance of AzureFunctionOutputDataSource class.

Method Details

apiKey

public String apiKey()

Get the apiKey property: If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function.

Returns:

the apiKey value.

fromJson

public static AzureFunctionOutputDataSource fromJson(JsonReader jsonReader)

Reads an instance of AzureFunctionOutputDataSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the AzureFunctionOutputDataSource.

functionAppName

public String functionAppName()

Get the functionAppName property: The name of your Azure Functions app.

Returns:

the functionAppName value.

functionName

public String functionName()

Get the functionName property: The name of the function in your Azure Functions app.

Returns:

the functionName value.

maxBatchCount

public Float maxBatchCount()

Get the maxBatchCount property: A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100.

Returns:

the maxBatchCount value.

maxBatchSize

public Float maxBatchSize()

Get the maxBatchSize property: A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB).

Returns:

the maxBatchSize value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AzureFunctionOutputDataSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

Overrides:

AzureFunctionOutputDataSource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

AzureFunctionOutputDataSource.validate()

withApiKey

public AzureFunctionOutputDataSource withApiKey(String apiKey)

Set the apiKey property: If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function.

Parameters:

apiKey - the apiKey value to set.

Returns:

the AzureFunctionOutputDataSource object itself.

withFunctionAppName

public AzureFunctionOutputDataSource withFunctionAppName(String functionAppName)

Set the functionAppName property: The name of your Azure Functions app.

Parameters:

functionAppName - the functionAppName value to set.

Returns:

the AzureFunctionOutputDataSource object itself.

withFunctionName

public AzureFunctionOutputDataSource withFunctionName(String functionName)

Set the functionName property: The name of the function in your Azure Functions app.

Parameters:

functionName - the functionName value to set.

Returns:

the AzureFunctionOutputDataSource object itself.

withMaxBatchCount

public AzureFunctionOutputDataSource withMaxBatchCount(Float maxBatchCount)

Set the maxBatchCount property: A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100.

Parameters:

maxBatchCount - the maxBatchCount value to set.

Returns:

the AzureFunctionOutputDataSource object itself.

withMaxBatchSize

public AzureFunctionOutputDataSource withMaxBatchSize(Float maxBatchSize)

Set the maxBatchSize property: A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB).

Parameters:

maxBatchSize - the maxBatchSize value to set.

Returns:

the AzureFunctionOutputDataSource object itself.

Applies to