Package com.azure.resourcemanager.datafactory.models

Class CosmosDbMongoDbApiLinkedService

java.lang.Object

com.azure.resourcemanager.datafactory.models.LinkedService

com.azure.resourcemanager.datafactory.models.CosmosDbMongoDbApiLinkedService

public final 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	connectionString()	Get the connectionString property: The CosmosDB (MongoDB API) connection string.
Object	database()	Get the database property: The name of the CosmosDB (MongoDB API) database that you want to access.
Object	isServerVersionAbove32()	Get the isServerVersionAbove32 property: Whether the CosmosDB (MongoDB API) server version is higher than 3.2.
void	validate()	Validates the instance.
CosmosDbMongoDbApiLinkedService	withAnnotations(List<Object> annotations)	Set the annotations property: List of tags that can be used for describing the linked service.
CosmosDbMongoDbApiLinkedService	withConnectionString(Object connectionString)	Set the connectionString property: The CosmosDB (MongoDB API) connection string.
CosmosDbMongoDbApiLinkedService	withConnectVia(IntegrationRuntimeReference connectVia)	Set the connectVia property: The integration runtime reference.
CosmosDbMongoDbApiLinkedService	withDatabase(Object database)	Set the database property: The name of the CosmosDB (MongoDB API) database that you want to access.
CosmosDbMongoDbApiLinkedService	withDescription(String description)	Set the description property: Linked service description.
CosmosDbMongoDbApiLinkedService	withIsServerVersionAbove32(Object isServerVersionAbove32)	Set the isServerVersionAbove32 property: Whether the CosmosDB (MongoDB API) server version is higher than 3.2.
CosmosDbMongoDbApiLinkedService	withParameters(Map<String,ParameterSpecification> parameters)	Set the parameters property: Parameters for linked service.

Methods inherited from class com.azure.resourcemanager.datafactory.models.LinkedService

additionalProperties, annotations, connectVia, description, parameters, withAdditionalProperties

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

withConnectVia

public CosmosDbMongoDbApiLinkedService withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

withConnectVia in class LinkedService

Parameters:

connectVia - the connectVia value to set.

Returns:

the LinkedService object itself.

withDescription

public CosmosDbMongoDbApiLinkedService withDescription(String description)

Set the description property: Linked service description.

Overrides:

withDescription in class LinkedService

Parameters:

description - the description value to set.

Returns:

the LinkedService object itself.

withParameters

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

Set the parameters property: Parameters for linked service.

Overrides:

withParameters in class LinkedService

Parameters:

parameters - the parameters value to set.

Returns:

the LinkedService object itself.

withAnnotations

public CosmosDbMongoDbApiLinkedService withAnnotations(List<Object> annotations)

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

Overrides:

withAnnotations in class LinkedService

Parameters:

annotations - the annotations value to set.

Returns:

the LinkedService object itself.

isServerVersionAbove32

public Object isServerVersionAbove32()

Get the isServerVersionAbove32 property: Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean).

Returns:

the isServerVersionAbove32 value.

withIsServerVersionAbove32

public CosmosDbMongoDbApiLinkedService withIsServerVersionAbove32(Object isServerVersionAbove32)

Set the isServerVersionAbove32 property: Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean).

Parameters:

isServerVersionAbove32 - the isServerVersionAbove32 value to set.

Returns:

the CosmosDbMongoDbApiLinkedService object itself.

connectionString

public Object connectionString()

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

Returns:

the connectionString value.

withConnectionString

public CosmosDbMongoDbApiLinkedService withConnectionString(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.

database

public Object database()

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.

withDatabase

public CosmosDbMongoDbApiLinkedService withDatabase(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.

validate

public void validate()

Validates the instance.

Overrides:

validate in class LinkedService

Throws:

IllegalArgumentException - thrown if the instance is not valid.