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

Class GoogleAdWordsLinkedService

  • public class GoogleAdWordsLinkedService
extends LinkedService
    Google AdWords service linked service.

    • Constructor Detail

      • GoogleAdWordsLinkedService

        public GoogleAdWordsLinkedService()

    • Method Detail

      • getConnectionProperties

        public Object getConnectionProperties()
        Get the connectionProperties property: Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object.
        Returns:
        the connectionProperties value.

      • setConnectionProperties

        public GoogleAdWordsLinkedService setConnectionProperties​(Object connectionProperties)
        Set the connectionProperties property: Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object.
        Parameters:
        connectionProperties - the connectionProperties value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.

      • getClientCustomerID

        public Object getClientCustomerID()
        Get the clientCustomerID property: The Client customer ID of the AdWords account that you want to fetch report data for.
        Returns:
        the clientCustomerID value.

      • setClientCustomerID

        public GoogleAdWordsLinkedService setClientCustomerID​(Object clientCustomerID)
        Set the clientCustomerID property: The Client customer ID of the AdWords account that you want to fetch report data for.
        Parameters:
        clientCustomerID - the clientCustomerID value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.

      • getDeveloperToken

        public SecretBase getDeveloperToken()
        Get the developerToken property: The developer token associated with the manager account that you use to grant access to the AdWords API.
        Returns:
        the developerToken value.

      • setDeveloperToken

        public GoogleAdWordsLinkedService setDeveloperToken​(SecretBase developerToken)
        Set the developerToken property: The developer token associated with the manager account that you use to grant access to the AdWords API.
        Parameters:
        developerToken - the developerToken value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.

      • getAuthenticationType

        public GoogleAdWordsAuthenticationType getAuthenticationType()
        Get the authenticationType property: The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.
        Returns:
        the authenticationType value.

      • setAuthenticationType

        public GoogleAdWordsLinkedService setAuthenticationType​(GoogleAdWordsAuthenticationType authenticationType)
        Set the authenticationType property: The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.
        Parameters:
        authenticationType - the authenticationType value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.

      • getRefreshToken

        public SecretBase getRefreshToken()
        Get the refreshToken property: The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.
        Returns:
        the refreshToken value.

      • setRefreshToken

        public GoogleAdWordsLinkedService setRefreshToken​(SecretBase refreshToken)
        Set the refreshToken property: The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.
        Parameters:
        refreshToken - the refreshToken value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.

      • getClientId

        public Object getClientId()
        Get the clientId property: The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
        Returns:
        the clientId value.

      • setClientId

        public GoogleAdWordsLinkedService setClientId​(Object clientId)
        Set the clientId property: The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
        Parameters:
        clientId - the clientId value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.

      • getClientSecret

        public SecretBase getClientSecret()
        Get the clientSecret property: The client secret of the google application used to acquire the refresh token.
        Returns:
        the clientSecret value.

      • setClientSecret

        public GoogleAdWordsLinkedService setClientSecret​(SecretBase clientSecret)
        Set the clientSecret property: The client secret of the google application used to acquire the refresh token.
        Parameters:
        clientSecret - the clientSecret value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.

      • getEmail

        public Object getEmail()
        Get the email property: The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.
        Returns:
        the email value.

      • setEmail

        public GoogleAdWordsLinkedService setEmail​(Object email)
        Set the email property: The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.
        Parameters:
        email - the email value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.

      • getKeyFilePath

        public Object getKeyFilePath()
        Get the keyFilePath property: The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.
        Returns:
        the keyFilePath value.

      • setKeyFilePath

        public GoogleAdWordsLinkedService setKeyFilePath​(Object keyFilePath)
        Set the keyFilePath property: The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.
        Parameters:
        keyFilePath - the keyFilePath value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.

      • getTrustedCertPath

        public Object getTrustedCertPath()
        Get the trustedCertPath property: The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
        Returns:
        the trustedCertPath value.

      • setTrustedCertPath

        public GoogleAdWordsLinkedService setTrustedCertPath​(Object trustedCertPath)
        Set the trustedCertPath property: The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.
        Parameters:
        trustedCertPath - the trustedCertPath value to set.
        Returns:
        the GoogleAdWordsLinkedService object itself.

      • getUseSystemTrustStore

        public Object getUseSystemTrustStore()
        Get the useSystemTrustStore property: Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
        Returns:
        the useSystemTrustStore value.

      • setUseSystemTrustStore

        public GoogleAdWordsLinkedService setUseSystemTrustStore​(Object useSystemTrustStore)
        Set the useSystemTrustStore property: Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.
        Parameters:
        useSystemTrustStore - the useSystemTrustStore value to set.
        Returns:
        the GoogleAdWordsLinkedService 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 GoogleAdWordsLinkedService 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 GoogleAdWordsLinkedService object itself.

      • setDescription

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