ServiceBusQueueOutputDataSource Class

public final class ServiceBusQueueOutputDataSource
extends OutputDataSource

Describes a Service Bus Queue output data source.

Constructor Summary

Constructor Description
ServiceBusQueueOutputDataSource()

Creates an instance of ServiceBusQueueOutputDataSource class.

Method Summary

Modifier and Type Method and Description
AuthenticationMode authenticationMode()

Get the authenticationMode property: Authentication Mode.

static ServiceBusQueueOutputDataSource fromJson(JsonReader jsonReader)

Reads an instance of ServiceBusQueueOutputDataSource from the JsonReader.

List<String> propertyColumns()

Get the propertyColumns property: A string array of the names of output columns to be attached to Service Bus messages as custom properties.

String queueName()

Get the queueName property: The name of the Service Bus Queue.

String serviceBusNamespace()

Get the serviceBusNamespace property: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.

String sharedAccessPolicyKey()

Get the sharedAccessPolicyKey property: The shared access policy key for the specified shared access policy.

String sharedAccessPolicyName()

Get the sharedAccessPolicyName property: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.

Object systemPropertyColumns()

Get the systemPropertyColumns property: The system properties associated with the Service Bus Queue.

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.

ServiceBusQueueOutputDataSource withAuthenticationMode(AuthenticationMode authenticationMode)

Set the authenticationMode property: Authentication Mode.

ServiceBusQueueOutputDataSource withPropertyColumns(List<String> propertyColumns)

Set the propertyColumns property: A string array of the names of output columns to be attached to Service Bus messages as custom properties.

ServiceBusQueueOutputDataSource withQueueName(String queueName)

Set the queueName property: The name of the Service Bus Queue.

ServiceBusQueueOutputDataSource withServiceBusNamespace(String serviceBusNamespace)

Set the serviceBusNamespace property: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.

ServiceBusQueueOutputDataSource withSharedAccessPolicyKey(String sharedAccessPolicyKey)

Set the sharedAccessPolicyKey property: The shared access policy key for the specified shared access policy.

ServiceBusQueueOutputDataSource withSharedAccessPolicyName(String sharedAccessPolicyName)

Set the sharedAccessPolicyName property: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.

ServiceBusQueueOutputDataSource withSystemPropertyColumns(Object systemPropertyColumns)

Set the systemPropertyColumns property: The system properties associated with the Service Bus Queue.

Methods inherited from OutputDataSource

Methods inherited from java.lang.Object

Constructor Details

ServiceBusQueueOutputDataSource

public ServiceBusQueueOutputDataSource()

Creates an instance of ServiceBusQueueOutputDataSource class.

Method Details

authenticationMode

public AuthenticationMode authenticationMode()

Get the authenticationMode property: Authentication Mode.

Returns:

the authenticationMode value.

fromJson

public static ServiceBusQueueOutputDataSource fromJson(JsonReader jsonReader)

Reads an instance of ServiceBusQueueOutputDataSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ServiceBusQueueOutputDataSource 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 ServiceBusQueueOutputDataSource.

propertyColumns

public List<String> propertyColumns()

Get the propertyColumns property: A string array of the names of output columns to be attached to Service Bus messages as custom properties.

Returns:

the propertyColumns value.

queueName

public String queueName()

Get the queueName property: The name of the Service Bus Queue. Required on PUT (CreateOrReplace) requests.

Returns:

the queueName value.

serviceBusNamespace

public String serviceBusNamespace()

Get the serviceBusNamespace property: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

Returns:

the serviceBusNamespace value.

sharedAccessPolicyKey

public String sharedAccessPolicyKey()

Get the sharedAccessPolicyKey property: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.

Returns:

the sharedAccessPolicyKey value.

sharedAccessPolicyName

public String sharedAccessPolicyName()

Get the sharedAccessPolicyName property: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

Returns:

the sharedAccessPolicyName value.

systemPropertyColumns

public Object systemPropertyColumns()

Get the systemPropertyColumns property: The system properties associated with the Service Bus Queue. The following system properties are supported: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.

Returns:

the systemPropertyColumns value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ServiceBusQueueOutputDataSource.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:

ServiceBusQueueOutputDataSource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

ServiceBusQueueOutputDataSource.validate()

withAuthenticationMode

public ServiceBusQueueOutputDataSource withAuthenticationMode(AuthenticationMode authenticationMode)

Set the authenticationMode property: Authentication Mode.

Parameters:

authenticationMode - the authenticationMode value to set.

Returns:

the ServiceBusQueueOutputDataSource object itself.

withPropertyColumns

public ServiceBusQueueOutputDataSource withPropertyColumns(List<String> propertyColumns)

Set the propertyColumns property: A string array of the names of output columns to be attached to Service Bus messages as custom properties.

Parameters:

propertyColumns - the propertyColumns value to set.

Returns:

the ServiceBusQueueOutputDataSource object itself.

withQueueName

public ServiceBusQueueOutputDataSource withQueueName(String queueName)

Set the queueName property: The name of the Service Bus Queue. Required on PUT (CreateOrReplace) requests.

Parameters:

queueName - the queueName value to set.

Returns:

the ServiceBusQueueOutputDataSource object itself.

withServiceBusNamespace

public ServiceBusQueueOutputDataSource withServiceBusNamespace(String serviceBusNamespace)

Set the serviceBusNamespace property: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

Parameters:

serviceBusNamespace - the serviceBusNamespace value to set.

Returns:

the ServiceBusQueueOutputDataSource object itself.

withSharedAccessPolicyKey

public ServiceBusQueueOutputDataSource withSharedAccessPolicyKey(String sharedAccessPolicyKey)

Set the sharedAccessPolicyKey property: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.

Parameters:

sharedAccessPolicyKey - the sharedAccessPolicyKey value to set.

Returns:

the ServiceBusQueueOutputDataSource object itself.

withSharedAccessPolicyName

public ServiceBusQueueOutputDataSource withSharedAccessPolicyName(String sharedAccessPolicyName)

Set the sharedAccessPolicyName property: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

Parameters:

sharedAccessPolicyName - the sharedAccessPolicyName value to set.

Returns:

the ServiceBusQueueOutputDataSource object itself.

withSystemPropertyColumns

public ServiceBusQueueOutputDataSource withSystemPropertyColumns(Object systemPropertyColumns)

Set the systemPropertyColumns property: The system properties associated with the Service Bus Queue. The following system properties are supported: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.

Parameters:

systemPropertyColumns - the systemPropertyColumns value to set.

Returns:

the ServiceBusQueueOutputDataSource object itself.

Applies to