Package com.azure.analytics.synapse.artifacts.models

Class CosmosDbSqlApiSource

  • public final class CosmosDbSqlApiSource
extends CopySource
    A copy activity Azure CosmosDB (SQL API) Collection source.

    • Constructor Detail

      • CosmosDbSqlApiSource

        public CosmosDbSqlApiSource()

    • Method Detail

      • getQuery

        public Object getQuery()
        Get the query property: SQL API query. Type: string (or Expression with resultType string).
        Returns:
        the query value.

      • setQuery

        public CosmosDbSqlApiSource setQuery​(Object query)
        Set the query property: SQL API query. Type: string (or Expression with resultType string).
        Parameters:
        query - the query value to set.
        Returns:
        the CosmosDbSqlApiSource object itself.

      • getPageSize

        public Object getPageSize()
        Get the pageSize property: Page size of the result. Type: integer (or Expression with resultType integer).
        Returns:
        the pageSize value.

      • setPageSize

        public CosmosDbSqlApiSource setPageSize​(Object pageSize)
        Set the pageSize property: Page size of the result. Type: integer (or Expression with resultType integer).
        Parameters:
        pageSize - the pageSize value to set.
        Returns:
        the CosmosDbSqlApiSource object itself.

      • getPreferredRegions

        public Object getPreferredRegions()
        Get the preferredRegions property: Preferred regions. Type: array of strings (or Expression with resultType array of strings).
        Returns:
        the preferredRegions value.

      • setPreferredRegions

        public CosmosDbSqlApiSource setPreferredRegions​(Object preferredRegions)
        Set the preferredRegions property: Preferred regions. Type: array of strings (or Expression with resultType array of strings).
        Parameters:
        preferredRegions - the preferredRegions value to set.
        Returns:
        the CosmosDbSqlApiSource object itself.

      • getDetectDatetime

        public Object getDetectDatetime()
        Get the detectDatetime property: Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).
        Returns:
        the detectDatetime value.

      • setDetectDatetime

        public CosmosDbSqlApiSource setDetectDatetime​(Object detectDatetime)
        Set the detectDatetime property: Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).
        Parameters:
        detectDatetime - the detectDatetime value to set.
        Returns:
        the CosmosDbSqlApiSource object itself.

      • getAdditionalColumns

        public Object getAdditionalColumns()
        Get 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).
        Returns:
        the additionalColumns value.

      • setAdditionalColumns

        public CosmosDbSqlApiSource 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).
        Parameters:
        additionalColumns - the additionalColumns value to set.
        Returns:
        the CosmosDbSqlApiSource object itself.

      • setSourceRetryCount

        public CosmosDbSqlApiSource setSourceRetryCount​(Object sourceRetryCount)
        Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).
        Overrides:
        setSourceRetryCount in class CopySource
        Parameters:
        sourceRetryCount - the sourceRetryCount value to set.
        Returns:
        the CopySource object itself.

      • setSourceRetryWait

        public CosmosDbSqlApiSource 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:
        setSourceRetryWait in class CopySource
        Parameters:
        sourceRetryWait - the sourceRetryWait value to set.
        Returns:
        the CopySource object itself.

      • setMaxConcurrentConnections

        public CosmosDbSqlApiSource 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:
        setMaxConcurrentConnections in class CopySource
        Parameters:
        maxConcurrentConnections - the maxConcurrentConnections value to set.
        Returns:
        the CopySource object itself.