Class MongoDbLinkedService
- java.lang.Object
-
- com.azure.resourcemanager.datafactory.models.LinkedService
-
- com.azure.resourcemanager.datafactory.models.MongoDbLinkedService
-
public final class MongoDbLinkedService extends LinkedService
Linked service for MongoDb data source.
-
-
Constructor Summary
Constructors Constructor Description MongoDbLinkedService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
allowSelfSignedServerCert()
Get the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server.MongoDbAuthenticationType
authenticationType()
Get the authenticationType property: The authentication type to be used to connect to the MongoDB database.Object
authSource()
Get the authSource property: Database to verify the username and password.Object
databaseName()
Get the databaseName property: The name of the MongoDB database that you want to access.Object
enableSsl()
Get the enableSsl property: Specifies whether the connections to the server are encrypted using SSL.Object
encryptedCredential()
Get the encryptedCredential property: The encrypted credential used for authentication.SecretBase
password()
Get the password property: Password for authentication.Object
port()
Get the port property: The TCP port number that the MongoDB server uses to listen for client connections.Object
server()
Get the server property: The IP address or server name of the MongoDB server.Object
username()
Get the username property: Username for authentication.void
validate()
Validates the instance.MongoDbLinkedService
withAllowSelfSignedServerCert(Object allowSelfSignedServerCert)
Set the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server.MongoDbLinkedService
withAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the linked service.MongoDbLinkedService
withAuthenticationType(MongoDbAuthenticationType authenticationType)
Set the authenticationType property: The authentication type to be used to connect to the MongoDB database.MongoDbLinkedService
withAuthSource(Object authSource)
Set the authSource property: Database to verify the username and password.MongoDbLinkedService
withConnectVia(IntegrationRuntimeReference connectVia)
Set the connectVia property: The integration runtime reference.MongoDbLinkedService
withDatabaseName(Object databaseName)
Set the databaseName property: The name of the MongoDB database that you want to access.MongoDbLinkedService
withDescription(String description)
Set the description property: Linked service description.MongoDbLinkedService
withEnableSsl(Object enableSsl)
Set the enableSsl property: Specifies whether the connections to the server are encrypted using SSL.MongoDbLinkedService
withEncryptedCredential(Object encryptedCredential)
Set the encryptedCredential property: The encrypted credential used for authentication.MongoDbLinkedService
withParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for linked service.MongoDbLinkedService
withPassword(SecretBase password)
Set the password property: Password for authentication.MongoDbLinkedService
withPort(Object port)
Set the port property: The TCP port number that the MongoDB server uses to listen for client connections.MongoDbLinkedService
withServer(Object server)
Set the server property: The IP address or server name of the MongoDB server.MongoDbLinkedService
withUsername(Object username)
Set the username property: Username for authentication.-
Methods inherited from class com.azure.resourcemanager.datafactory.models.LinkedService
additionalProperties, annotations, connectVia, description, parameters, withAdditionalProperties
-
-
-
-
Method Detail
-
withConnectVia
public MongoDbLinkedService withConnectVia(IntegrationRuntimeReference connectVia)
Set the connectVia property: The integration runtime reference.- Overrides:
withConnectVia
in classLinkedService
- Parameters:
connectVia
- the connectVia value to set.- Returns:
- the LinkedService object itself.
-
withDescription
public MongoDbLinkedService withDescription(String description)
Set the description property: Linked service description.- Overrides:
withDescription
in classLinkedService
- Parameters:
description
- the description value to set.- Returns:
- the LinkedService object itself.
-
withParameters
public MongoDbLinkedService withParameters(Map<String,ParameterSpecification> parameters)
Set the parameters property: Parameters for linked service.- Overrides:
withParameters
in classLinkedService
- Parameters:
parameters
- the parameters value to set.- Returns:
- the LinkedService object itself.
-
withAnnotations
public MongoDbLinkedService withAnnotations(List<Object> annotations)
Set the annotations property: List of tags that can be used for describing the linked service.- Overrides:
withAnnotations
in classLinkedService
- Parameters:
annotations
- the annotations value to set.- Returns:
- the LinkedService object itself.
-
server
public Object server()
Get the server property: The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).- Returns:
- the server value.
-
withServer
public MongoDbLinkedService withServer(Object server)
Set the server property: The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).- Parameters:
server
- the server value to set.- Returns:
- the MongoDbLinkedService object itself.
-
authenticationType
public MongoDbAuthenticationType authenticationType()
Get the authenticationType property: The authentication type to be used to connect to the MongoDB database.- Returns:
- the authenticationType value.
-
withAuthenticationType
public MongoDbLinkedService withAuthenticationType(MongoDbAuthenticationType authenticationType)
Set the authenticationType property: The authentication type to be used to connect to the MongoDB database.- Parameters:
authenticationType
- the authenticationType value to set.- Returns:
- the MongoDbLinkedService object itself.
-
databaseName
public Object databaseName()
Get the databaseName property: The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).- Returns:
- the databaseName value.
-
withDatabaseName
public MongoDbLinkedService withDatabaseName(Object databaseName)
Set the databaseName property: The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).- Parameters:
databaseName
- the databaseName value to set.- Returns:
- the MongoDbLinkedService object itself.
-
username
public Object username()
Get the username property: Username for authentication. Type: string (or Expression with resultType string).- Returns:
- the username value.
-
withUsername
public MongoDbLinkedService withUsername(Object username)
Set the username property: Username for authentication. Type: string (or Expression with resultType string).- Parameters:
username
- the username value to set.- Returns:
- the MongoDbLinkedService object itself.
-
password
public SecretBase password()
Get the password property: Password for authentication.- Returns:
- the password value.
-
withPassword
public MongoDbLinkedService withPassword(SecretBase password)
Set the password property: Password for authentication.- Parameters:
password
- the password value to set.- Returns:
- the MongoDbLinkedService object itself.
-
authSource
public Object authSource()
Get the authSource property: Database to verify the username and password. Type: string (or Expression with resultType string).- Returns:
- the authSource value.
-
withAuthSource
public MongoDbLinkedService withAuthSource(Object authSource)
Set the authSource property: Database to verify the username and password. Type: string (or Expression with resultType string).- Parameters:
authSource
- the authSource value to set.- Returns:
- the MongoDbLinkedService object itself.
-
port
public Object port()
Get the port property: The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.- Returns:
- the port value.
-
withPort
public MongoDbLinkedService withPort(Object port)
Set the port property: The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.- Parameters:
port
- the port value to set.- Returns:
- the MongoDbLinkedService object itself.
-
enableSsl
public Object enableSsl()
Get the enableSsl property: Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).- Returns:
- the enableSsl value.
-
withEnableSsl
public MongoDbLinkedService withEnableSsl(Object enableSsl)
Set the enableSsl property: Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).- Parameters:
enableSsl
- the enableSsl value to set.- Returns:
- the MongoDbLinkedService object itself.
-
allowSelfSignedServerCert
public Object allowSelfSignedServerCert()
Get the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean).- Returns:
- the allowSelfSignedServerCert value.
-
withAllowSelfSignedServerCert
public MongoDbLinkedService withAllowSelfSignedServerCert(Object allowSelfSignedServerCert)
Set the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean).- Parameters:
allowSelfSignedServerCert
- the allowSelfSignedServerCert value to set.- Returns:
- the MongoDbLinkedService object itself.
-
encryptedCredential
public Object encryptedCredential()
Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).- Returns:
- the encryptedCredential value.
-
withEncryptedCredential
public MongoDbLinkedService withEncryptedCredential(Object encryptedCredential)
Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).- Parameters:
encryptedCredential
- the encryptedCredential value to set.- Returns:
- the MongoDbLinkedService object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classLinkedService
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-