Class HttpLinkedService


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

      • HttpLinkedService

        public HttpLinkedService()
    • Method Detail

      • withDescription

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

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

        public Object url()
        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.
      • withUrl

        public HttpLinkedService withUrl​(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.
      • authenticationType

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

        public HttpLinkedService withAuthenticationType​(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.
      • username

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

        public HttpLinkedService withUsername​(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.
      • password

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

        public HttpLinkedService withPassword​(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.
      • authHeaders

        public Object authHeaders()
        Get the authHeaders property: The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
        Returns:
        the authHeaders value.
      • withAuthHeaders

        public HttpLinkedService withAuthHeaders​(Object authHeaders)
        Set the authHeaders property: The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
        Parameters:
        authHeaders - the authHeaders value to set.
        Returns:
        the HttpLinkedService object itself.
      • embeddedCertData

        public Object embeddedCertData()
        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.
      • withEmbeddedCertData

        public HttpLinkedService withEmbeddedCertData​(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.
      • certThumbprint

        public Object certThumbprint()
        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.
      • withCertThumbprint

        public HttpLinkedService withCertThumbprint​(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.
      • 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 HttpLinkedService 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 HttpLinkedService object itself.
      • enableServerCertificateValidation

        public Object enableServerCertificateValidation()
        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.
      • withEnableServerCertificateValidation

        public HttpLinkedService withEnableServerCertificateValidation​(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.