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

Class GoogleBigQueryLinkedService

  • public class GoogleBigQueryLinkedService
extends LinkedService
    Google BigQuery service linked service.

    • Constructor Detail

      • GoogleBigQueryLinkedService

        public GoogleBigQueryLinkedService()

    • Method Detail

      • getProject

        public Object getProject()
        Get the project property: The default BigQuery project to query against.
        Returns:
        the project value.

      • setProject

        public GoogleBigQueryLinkedService setProject​(Object project)
        Set the project property: The default BigQuery project to query against.
        Parameters:
        project - the project value to set.
        Returns:
        the GoogleBigQueryLinkedService object itself.

      • getAdditionalProjects

        public Object getAdditionalProjects()
        Get the additionalProjects property: A comma-separated list of public BigQuery projects to access.
        Returns:
        the additionalProjects value.

      • setAdditionalProjects

        public GoogleBigQueryLinkedService setAdditionalProjects​(Object additionalProjects)
        Set the additionalProjects property: A comma-separated list of public BigQuery projects to access.
        Parameters:
        additionalProjects - the additionalProjects value to set.
        Returns:
        the GoogleBigQueryLinkedService object itself.

      • getRequestGoogleDriveScope

        public Object getRequestGoogleDriveScope()
        Get the requestGoogleDriveScope property: Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.
        Returns:
        the requestGoogleDriveScope value.

      • setRequestGoogleDriveScope

        public GoogleBigQueryLinkedService setRequestGoogleDriveScope​(Object requestGoogleDriveScope)
        Set the requestGoogleDriveScope property: Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.
        Parameters:
        requestGoogleDriveScope - the requestGoogleDriveScope value to set.
        Returns:
        the GoogleBigQueryLinkedService object itself.

      • getAuthenticationType

        public GoogleBigQueryAuthenticationType 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 GoogleBigQueryLinkedService setAuthenticationType​(GoogleBigQueryAuthenticationType 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 GoogleBigQueryLinkedService object itself.

      • getRefreshToken

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

      • setRefreshToken

        public GoogleBigQueryLinkedService setRefreshToken​(SecretBase refreshToken)
        Set the refreshToken property: The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.
        Parameters:
        refreshToken - the refreshToken value to set.
        Returns:
        the GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService object itself.

      • setAnnotations

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