Class GoogleBigQueryLinkedService


  • public final class GoogleBigQueryLinkedService
    extends LinkedService
    Google BigQuery service linked service.
    • Constructor Detail

      • GoogleBigQueryLinkedService

        public GoogleBigQueryLinkedService()
    • Method Detail

      • withAnnotations

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

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

        public GoogleBigQueryLinkedService withProject​(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.
      • additionalProjects

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

        public GoogleBigQueryLinkedService withAdditionalProjects​(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.
      • requestGoogleDriveScope

        public Object requestGoogleDriveScope()
        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.
      • withRequestGoogleDriveScope

        public GoogleBigQueryLinkedService withRequestGoogleDriveScope​(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.
      • authenticationType

        public GoogleBigQueryAuthenticationType authenticationType()
        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.
      • withAuthenticationType

        public GoogleBigQueryLinkedService withAuthenticationType​(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.
      • refreshToken

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

        public GoogleBigQueryLinkedService withRefreshToken​(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.
      • clientId

        public Object clientId()
        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.
      • withClientId

        public GoogleBigQueryLinkedService withClientId​(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.
      • clientSecret

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

        public GoogleBigQueryLinkedService withClientSecret​(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.
      • email

        public Object email()
        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.
      • withEmail

        public GoogleBigQueryLinkedService withEmail​(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.
      • keyFilePath

        public Object keyFilePath()
        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.
      • withKeyFilePath

        public GoogleBigQueryLinkedService withKeyFilePath​(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.
      • trustedCertPath

        public Object trustedCertPath()
        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.
      • withTrustedCertPath

        public GoogleBigQueryLinkedService withTrustedCertPath​(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.
      • useSystemTrustStore

        public Object useSystemTrustStore()
        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.
      • withUseSystemTrustStore

        public GoogleBigQueryLinkedService withUseSystemTrustStore​(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.
      • 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 GoogleBigQueryLinkedService 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 GoogleBigQueryLinkedService object itself.