SquareSource Class

public final class SquareSource
extends TabularSource

A copy activity Square Service source.

Constructor Summary

Constructor Description
SquareSource()

Creates an instance of SquareSource class.

Method Summary

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

Reads an instance of SquareSource from the JsonReader.

Object query()

Get the query property: A query to retrieve data from source.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Copy source type.

void validate()

Validates the instance.

SquareSource withAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data.

SquareSource withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection.

SquareSource withMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.

SquareSource withQuery(Object query)

Set the query property: A query to retrieve data from source.

SquareSource withQueryTimeout(Object queryTimeout)

Set the queryTimeout property: Query timeout.

SquareSource withSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count.

SquareSource withSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait.

Methods inherited from CopySource

Methods inherited from TabularSource

Methods inherited from java.lang.Object

Constructor Details

SquareSource

public SquareSource()

Creates an instance of SquareSource class.

Method Details

fromJson

public static SquareSource fromJson(JsonReader jsonReader)

Reads an instance of SquareSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

query

public Object query()

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

Returns:

the query value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SquareSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Copy source type.

Overrides:

SquareSource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

SquareSource.validate()

withAdditionalColumns

public SquareSource withAdditionalColumns(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:

SquareSource.withAdditionalColumns(Object additionalColumns)

Parameters:

additionalColumns

withDisableMetricsCollection

public SquareSource withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

Overrides:

SquareSource.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withMaxConcurrentConnections

public SquareSource withMaxConcurrentConnections(Object maxConcurrentConnections)

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

Overrides:

SquareSource.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withQuery

public SquareSource withQuery(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 SquareSource object itself.

withQueryTimeout

public SquareSource withQueryTimeout(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:

SquareSource.withQueryTimeout(Object queryTimeout)

Parameters:

queryTimeout

withSourceRetryCount

public SquareSource withSourceRetryCount(Object sourceRetryCount)

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

Overrides:

SquareSource.withSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

withSourceRetryWait

public SquareSource withSourceRetryWait(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:

SquareSource.withSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

Applies to