CommonDataServiceForAppsSink Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.models.CopySink
  • • com.azure.analytics.synapse.artifacts.models.CommonDataServiceForAppsSink

public final class CommonDataServiceForAppsSink
extends CopySink

A copy activity Common Data Service for Apps sink.

Constructor Summary

Constructor	Description
CommonDataServiceForAppsSink()	Creates an instance of CommonDataServiceForAppsSink class.

Method Summary

Modifier and Type	Method and Description
Object	getAlternateKeyName() Get the alternateKeyName property: The logical name of the alternate key which will be used when upserting records.
Object	getIgnoreNullValues() Get the ignoreNullValues property: The flag indicating whether to ignore null values from input dataset (except key fields) during write operation.
DynamicsSinkWriteBehavior	getWriteBehavior() Get the writeBehavior property: The write behavior for the operation.
CommonDataServiceForAppsSink	setAlternateKeyName(Object alternateKeyName) Set the alternateKeyName property: The logical name of the alternate key which will be used when upserting records.
CommonDataServiceForAppsSink	setIgnoreNullValues(Object ignoreNullValues) Set the ignoreNullValues property: The flag indicating whether to ignore null values from input dataset (except key fields) during write operation.
CommonDataServiceForAppsSink	setMaxConcurrentConnections(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.
CommonDataServiceForAppsSink	setSinkRetryCount(Object sinkRetryCount) Set the sinkRetryCount property: Sink retry count.
CommonDataServiceForAppsSink	setSinkRetryWait(Object sinkRetryWait) Set the sinkRetryWait property: Sink retry wait.
CommonDataServiceForAppsSink	setWriteBatchSize(Object writeBatchSize) Set the writeBatchSize property: Write batch size.
CommonDataServiceForAppsSink	setWriteBatchTimeout(Object writeBatchTimeout) Set the writeBatchTimeout property: Write batch timeout.
CommonDataServiceForAppsSink	setWriteBehavior(DynamicsSinkWriteBehavior writeBehavior) Set the writeBehavior property: The write behavior for the operation.

Methods inherited from CopySink

getAdditionalProperties getMaxConcurrentConnections getSinkRetryCount getSinkRetryWait getWriteBatchSize getWriteBatchTimeout setAdditionalProperties setMaxConcurrentConnections setSinkRetryCount setSinkRetryWait setWriteBatchSize setWriteBatchTimeout

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CommonDataServiceForAppsSink

public CommonDataServiceForAppsSink()

Creates an instance of CommonDataServiceForAppsSink class.

Method Details

getAlternateKeyName

public Object getAlternateKeyName()

Get the alternateKeyName property: The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).

Returns:

the alternateKeyName value.

getIgnoreNullValues

public Object getIgnoreNullValues()

Get the ignoreNullValues property: The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).

Returns:

the ignoreNullValues value.

getWriteBehavior

public DynamicsSinkWriteBehavior getWriteBehavior()

Get the writeBehavior property: The write behavior for the operation.

Returns:

the writeBehavior value.

setAlternateKeyName

public CommonDataServiceForAppsSink setAlternateKeyName(Object alternateKeyName)

Set the alternateKeyName property: The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).

Parameters:

alternateKeyName - the alternateKeyName value to set.

Returns:

the CommonDataServiceForAppsSink object itself.

setIgnoreNullValues

public CommonDataServiceForAppsSink setIgnoreNullValues(Object ignoreNullValues)

Set the ignoreNullValues property: The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).

Parameters:

ignoreNullValues - the ignoreNullValues value to set.

Returns:

the CommonDataServiceForAppsSink object itself.

setMaxConcurrentConnections

public CommonDataServiceForAppsSink setMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

Overrides:

CommonDataServiceForAppsSink.setMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

setSinkRetryCount

public CommonDataServiceForAppsSink setSinkRetryCount(Object sinkRetryCount)

Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).

Overrides:

CommonDataServiceForAppsSink.setSinkRetryCount(Object sinkRetryCount)

Parameters:

sinkRetryCount

setSinkRetryWait

public CommonDataServiceForAppsSink setSinkRetryWait(Object sinkRetryWait)

Set the sinkRetryWait property: Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Overrides:

CommonDataServiceForAppsSink.setSinkRetryWait(Object sinkRetryWait)

Parameters:

sinkRetryWait

setWriteBatchSize

public CommonDataServiceForAppsSink setWriteBatchSize(Object writeBatchSize)

Set the writeBatchSize property: Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Overrides:

CommonDataServiceForAppsSink.setWriteBatchSize(Object writeBatchSize)

Parameters:

writeBatchSize

setWriteBatchTimeout

public CommonDataServiceForAppsSink setWriteBatchTimeout(Object writeBatchTimeout)

Set the writeBatchTimeout property: Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Overrides:

CommonDataServiceForAppsSink.setWriteBatchTimeout(Object writeBatchTimeout)

Parameters:

writeBatchTimeout

setWriteBehavior

public CommonDataServiceForAppsSink setWriteBehavior(DynamicsSinkWriteBehavior writeBehavior)

Set the writeBehavior property: The write behavior for the operation.

Parameters:

writeBehavior - the writeBehavior value to set.

Returns:

the CommonDataServiceForAppsSink object itself.