AzureSearchIndexSink 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.AzureSearchIndexSink

public final class AzureSearchIndexSink
extends CopySink

A copy activity Azure Search Index sink.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
AzureSearchIndexWriteBehaviorType	getWriteBehavior() Get the writeBehavior property: Specify the write behavior when upserting documents into Azure Search Index.
AzureSearchIndexSink	setMaxConcurrentConnections(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.
AzureSearchIndexSink	setSinkRetryCount(Object sinkRetryCount) Set the sinkRetryCount property: Sink retry count.
AzureSearchIndexSink	setSinkRetryWait(Object sinkRetryWait) Set the sinkRetryWait property: Sink retry wait.
AzureSearchIndexSink	setWriteBatchSize(Object writeBatchSize) Set the writeBatchSize property: Write batch size.
AzureSearchIndexSink	setWriteBatchTimeout(Object writeBatchTimeout) Set the writeBatchTimeout property: Write batch timeout.
AzureSearchIndexSink	setWriteBehavior(AzureSearchIndexWriteBehaviorType writeBehavior) Set the writeBehavior property: Specify the write behavior when upserting documents into Azure Search Index.

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

AzureSearchIndexSink

public AzureSearchIndexSink()

Creates an instance of AzureSearchIndexSink class.

Method Details

getWriteBehavior

public AzureSearchIndexWriteBehaviorType getWriteBehavior()

Get the writeBehavior property: Specify the write behavior when upserting documents into Azure Search Index.

Returns:

the writeBehavior value.

setMaxConcurrentConnections

public AzureSearchIndexSink 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:

AzureSearchIndexSink.setMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

setSinkRetryCount

public AzureSearchIndexSink setSinkRetryCount(Object sinkRetryCount)

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

Overrides:

AzureSearchIndexSink.setSinkRetryCount(Object sinkRetryCount)

Parameters:

sinkRetryCount

setSinkRetryWait

public AzureSearchIndexSink 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:

AzureSearchIndexSink.setSinkRetryWait(Object sinkRetryWait)

Parameters:

sinkRetryWait

setWriteBatchSize

public AzureSearchIndexSink setWriteBatchSize(Object writeBatchSize)

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

Overrides:

AzureSearchIndexSink.setWriteBatchSize(Object writeBatchSize)

Parameters:

writeBatchSize

setWriteBatchTimeout

public AzureSearchIndexSink 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:

AzureSearchIndexSink.setWriteBatchTimeout(Object writeBatchTimeout)

Parameters:

writeBatchTimeout

setWriteBehavior

public AzureSearchIndexSink setWriteBehavior(AzureSearchIndexWriteBehaviorType writeBehavior)

Set the writeBehavior property: Specify the write behavior when upserting documents into Azure Search Index.

Parameters:

writeBehavior - the writeBehavior value to set.

Returns:

the AzureSearchIndexSink object itself.