PhoenixSource Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

public final class PhoenixSource
extends TabularSource

A copy activity Phoenix server source.

Constructor Summary

Constructor Description
PhoenixSource()

Creates an instance of PhoenixSource class.

Method Summary

Modifier and Type Method and Description
static PhoenixSource fromJson(JsonReader jsonReader)

Reads an instance of PhoenixSource from the JsonReader.
Object getQuery()

Get the query property: A query to retrieve data from source.
String getType()

Get the type property: Copy source type.
PhoenixSource setAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data.
PhoenixSource setMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.
PhoenixSource setQuery(Object query)

Set the query property: A query to retrieve data from source.
PhoenixSource setQueryTimeout(Object queryTimeout)

Set the queryTimeout property: Query timeout.
PhoenixSource setSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count.
PhoenixSource setSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from CopySource

getAdditionalProperties getMaxConcurrentConnections getSourceRetryCount getSourceRetryWait setAdditionalProperties

Methods inherited from TabularSource

fromJson getAdditionalColumns getQueryTimeout getType setAdditionalColumns setMaxConcurrentConnections setQueryTimeout setSourceRetryCount setSourceRetryWait toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PhoenixSource

public PhoenixSource()

Creates an instance of PhoenixSource class.

Method Details

fromJson

public static PhoenixSource fromJson(JsonReader jsonReader)

Reads an instance of PhoenixSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getQuery

public Object getQuery()

Get the query property: A query to retrieve data from source. Type: string (or Expression with resultType string).

Returns:

the query value.

getType

public String getType()

Get the type property: Copy source type.

Overrides:

PhoenixSource.getType()

Returns:

the type value.

setAdditionalColumns

public PhoenixSource setAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Overrides:

PhoenixSource.setAdditionalColumns(Object additionalColumns)

Parameters:

additionalColumns

setMaxConcurrentConnections

public PhoenixSource setMaxConcurrentConnections(Object maxConcurrentConnections)

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

Overrides:

PhoenixSource.setMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

setQuery

public PhoenixSource setQuery(Object query)

Set the query property: A query to retrieve data from source. Type: string (or Expression with resultType string).

Parameters:

query - the query value to set.

Returns:

the PhoenixSource object itself.

setQueryTimeout

public PhoenixSource setQueryTimeout(Object queryTimeout)

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

Overrides:

PhoenixSource.setQueryTimeout(Object queryTimeout)

Parameters:

queryTimeout

setSourceRetryCount

public PhoenixSource setSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).

Overrides:

PhoenixSource.setSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

setSourceRetryWait

public PhoenixSource setSourceRetryWait(Object sourceRetryWait)

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

Overrides:

PhoenixSource.setSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

PhoenixSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to