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

Class HttpLinkedService

  • public class HttpLinkedService
extends LinkedService
    Linked service for an HTTP source.

    • Constructor Detail

      • HttpLinkedService

        public HttpLinkedService()

    • Method Detail

      • getUrl

        public Object getUrl()
        Get the url property: The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression with resultType string).
        Returns:
        the url value.

      • setUrl

        public HttpLinkedService setUrl​(Object url)
        Set the url property: The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression with resultType string).
        Parameters:
        url - the url value to set.
        Returns:
        the HttpLinkedService object itself.

      • getAuthenticationType

        public HttpAuthenticationType getAuthenticationType()
        Get the authenticationType property: The authentication type to be used to connect to the HTTP server.
        Returns:
        the authenticationType value.

      • setAuthenticationType

        public HttpLinkedService setAuthenticationType​(HttpAuthenticationType authenticationType)
        Set the authenticationType property: The authentication type to be used to connect to the HTTP server.
        Parameters:
        authenticationType - the authenticationType value to set.
        Returns:
        the HttpLinkedService object itself.

      • getUserName

        public Object getUserName()
        Get the userName property: User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).
        Returns:
        the userName value.

      • setUserName

        public HttpLinkedService setUserName​(Object userName)
        Set the userName property: User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).
        Parameters:
        userName - the userName value to set.
        Returns:
        the HttpLinkedService object itself.

      • getPassword

        public SecretBase getPassword()
        Get the password property: Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.
        Returns:
        the password value.

      • setPassword

        public HttpLinkedService setPassword​(SecretBase password)
        Set the password property: Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.
        Parameters:
        password - the password value to set.
        Returns:
        the HttpLinkedService object itself.

      • getEmbeddedCertData

        public Object getEmbeddedCertData()
        Get the embeddedCertData property: Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).
        Returns:
        the embeddedCertData value.

      • setEmbeddedCertData

        public HttpLinkedService setEmbeddedCertData​(Object embeddedCertData)
        Set the embeddedCertData property: Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).
        Parameters:
        embeddedCertData - the embeddedCertData value to set.
        Returns:
        the HttpLinkedService object itself.

      • getCertThumbprint

        public Object getCertThumbprint()
        Get the certThumbprint property: Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).
        Returns:
        the certThumbprint value.

      • setCertThumbprint

        public HttpLinkedService setCertThumbprint​(Object certThumbprint)
        Set the certThumbprint property: Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).
        Parameters:
        certThumbprint - the certThumbprint value to set.
        Returns:
        the HttpLinkedService object itself.

      • getEncryptedCredential

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

      • setEncryptedCredential

        public HttpLinkedService setEncryptedCredential​(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 HttpLinkedService object itself.

      • getEnableServerCertificateValidation

        public Object getEnableServerCertificateValidation()
        Get the enableServerCertificateValidation property: If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).
        Returns:
        the enableServerCertificateValidation value.

      • setEnableServerCertificateValidation

        public HttpLinkedService setEnableServerCertificateValidation​(Object enableServerCertificateValidation)
        Set the enableServerCertificateValidation property: If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).
        Parameters:
        enableServerCertificateValidation - the enableServerCertificateValidation value to set.
        Returns:
        the HttpLinkedService object itself.

      • setDescription

        public HttpLinkedService 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.

      • setAnnotations

        public HttpLinkedService 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.