Package com.azure.resourcemanager.datafactory.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

      • query

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

      • withQuery

        public CosmosDbSqlApiSource withQuery​(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.

      • pageSize

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

      • withPageSize

        public CosmosDbSqlApiSource withPageSize​(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.

      • preferredRegions

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

      • withPreferredRegions

        public CosmosDbSqlApiSource withPreferredRegions​(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.

      • detectDatetime

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

      • withDetectDatetime

        public CosmosDbSqlApiSource withDetectDatetime​(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.

      • additionalColumns

        public Object additionalColumns()
        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.

      • withAdditionalColumns

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

      • withSourceRetryCount

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

      • withSourceRetryWait

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

      • withMaxConcurrentConnections

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

      • withDisableMetricsCollection

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