Class MongoDbLinkedService
java.lang.Object
com.azure.resourcemanager.datafactory.models.LinkedService
com.azure.resourcemanager.datafactory.models.MongoDbLinkedService
Linked service for MongoDb data source.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server.Get the authenticationType property: The authentication type to be used to connect to the MongoDB database.Get the authSource property: Database to verify the username and password.Get the databaseName property: The name of the MongoDB database that you want to access.Get the enableSsl property: Specifies whether the connections to the server are encrypted using SSL.Get the encryptedCredential property: The encrypted credential used for authentication.password()
Get the password property: Password for authentication.port()
Get the port property: The TCP port number that the MongoDB server uses to listen for client connections.server()
Get the server property: The IP address or server name of the MongoDB server.username()
Get the username property: Username for authentication.void
validate()
Validates the instance.withAllowSelfSignedServerCert
(Object allowSelfSignedServerCert) Set the allowSelfSignedServerCert property: Specifies whether to allow self-signed certificates from the server.withAnnotations
(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.withAuthenticationType
(MongoDbAuthenticationType authenticationType) Set the authenticationType property: The authentication type to be used to connect to the MongoDB database.withAuthSource
(Object authSource) Set the authSource property: Database to verify the username and password.withConnectVia
(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.withDatabaseName
(Object databaseName) Set the databaseName property: The name of the MongoDB database that you want to access.withDescription
(String description) Set the description property: Linked service description.withEnableSsl
(Object enableSsl) Set the enableSsl property: Specifies whether the connections to the server are encrypted using SSL.withEncryptedCredential
(Object encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.withParameters
(Map<String, ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.withPassword
(SecretBase password) Set the password property: Password for authentication.Set the port property: The TCP port number that the MongoDB server uses to listen for client connections.withServer
(Object server) Set the server property: The IP address or server name of the MongoDB server.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
-
Constructor Details
-
MongoDbLinkedService
public MongoDbLinkedService()Creates an instance of MongoDbLinkedService class.
-
-
Method Details
-
withConnectVia
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
Set the description property: Linked service description.- Overrides:
withDescription
in classLinkedService
- Parameters:
description
- the description value to set.- Returns:
- the LinkedService object itself.
-
withParameters
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
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
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
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
Get the authenticationType property: The authentication type to be used to connect to the MongoDB database.- Returns:
- the authenticationType value.
-
withAuthenticationType
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
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
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
Get the username property: Username for authentication. Type: string (or Expression with resultType string).- Returns:
- the username value.
-
withUsername
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
Get the password property: Password for authentication.- Returns:
- the password value.
-
withPassword
Set the password property: Password for authentication.- Parameters:
password
- the password value to set.- Returns:
- the MongoDbLinkedService object itself.
-
authSource
Get the authSource property: Database to verify the username and password. Type: string (or Expression with resultType string).- Returns:
- the authSource value.
-
withAuthSource
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
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
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
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
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
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
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
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
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.
-