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

Class CosmosDbMongoDbApiLinkedService

java.lang.Object

com.azure.analytics.synapse.artifacts.models.LinkedService

com.azure.analytics.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService

public class CosmosDbMongoDbApiLinkedService
extends LinkedService

Linked service for CosmosDB (MongoDB API) data source.

Constructor Summary

Constructors

Constructor	Description
CosmosDbMongoDbApiLinkedService()

Method Summary

Modifier and Type	Method	Description
Object	getConnectionString()	Get the connectionString property: The CosmosDB (MongoDB API) connection string.
Object	getDatabase()	Get the database property: The name of the CosmosDB (MongoDB API) database that you want to access.
CosmosDbMongoDbApiLinkedService	setAnnotations(List<Object> annotations)	Set the annotations property: List of tags that can be used for describing the linked service.
CosmosDbMongoDbApiLinkedService	setConnectionString(Object connectionString)	Set the connectionString property: The CosmosDB (MongoDB API) connection string.
CosmosDbMongoDbApiLinkedService	setConnectVia(IntegrationRuntimeReference connectVia)	Set the connectVia property: The integration runtime reference.
CosmosDbMongoDbApiLinkedService	setDatabase(Object database)	Set the database property: The name of the CosmosDB (MongoDB API) database that you want to access.
CosmosDbMongoDbApiLinkedService	setDescription(String description)	Set the description property: Linked service description.
CosmosDbMongoDbApiLinkedService	setParameters(Map<String,ParameterSpecification> parameters)	Set the parameters property: Parameters for linked service.

Methods inherited from class com.azure.analytics.synapse.artifacts.models.LinkedService

getAdditionalProperties, getAnnotations, getConnectVia, getDescription, getParameters, setAdditionalProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CosmosDbMongoDbApiLinkedService

public CosmosDbMongoDbApiLinkedService()

Method Detail

getConnectionString

public Object getConnectionString()

Get the connectionString property: The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

Returns:

the connectionString value.

setConnectionString

public CosmosDbMongoDbApiLinkedService setConnectionString(Object connectionString)

Set the connectionString property: The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

Parameters:

connectionString - the connectionString value to set.

Returns:

the CosmosDbMongoDbApiLinkedService object itself.

getDatabase

public Object getDatabase()

Get the database property: The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).

Returns:

the database value.

setDatabase

public CosmosDbMongoDbApiLinkedService setDatabase(Object database)

Set the database property: The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).

Parameters:

database - the database value to set.

Returns:

the CosmosDbMongoDbApiLinkedService object itself.

setConnectVia

public CosmosDbMongoDbApiLinkedService setConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

setConnectVia in class LinkedService

Parameters:

connectVia - the connectVia value to set.

Returns:

the LinkedService object itself.

setDescription

public CosmosDbMongoDbApiLinkedService setDescription(String description)

Set the description property: Linked service description.

Overrides:

setDescription in class LinkedService

Parameters:

description - the description value to set.

Returns:

the LinkedService object itself.

setParameters

public CosmosDbMongoDbApiLinkedService setParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for linked service.

Overrides:

setParameters in class LinkedService

Parameters:

parameters - the parameters value to set.

Returns:

the LinkedService object itself.

setAnnotations

public CosmosDbMongoDbApiLinkedService setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the linked service.

Overrides:

setAnnotations in class LinkedService

Parameters:

annotations - the annotations value to set.

Returns:

the LinkedService object itself.