- Resource: Connection
- CloudSqlProperties
- DatabaseType
- CloudSqlCredential
- AwsProperties
- AwsAccessRole
- AzureProperties
- CloudSpannerProperties
- CloudResourceProperties
- SparkProperties
- MetastoreServiceConfig
- SparkHistoryServerConfig
- SalesforceDataCloudProperties
- ConnectorConfiguration
- Endpoint
- Authentication
- UsernamePassword
- Secret
- SecretType
- Network
- PrivateServiceConnect
- Asset
- Methods
Resource: Connection
Configuration parameters to establish connection with an external data source, except the credential attributes.
JSON representation |
---|
{ "name": string, "friendlyName": string, "description": string, "configuration": { object ( |
Fields | |
---|---|
name |
Output only. The resource name of the connection in the form of: |
friendly |
User provided display name for the connection. |
description |
User provided description. |
configuration |
Optional. Connector configuration. |
creation |
Output only. The creation timestamp of the connection. |
last |
Output only. The last update timestamp of the connection. |
has |
Output only. True, if credential is configured for this connection. |
kms |
Optional. The Cloud KMS key that is used for credentials encryption. If omitted, internal Google owned encryption keys are used. Example: |
Union field properties . Properties specific to the underlying data source. properties can be only one of the following: |
|
cloud |
Cloud SQL properties. |
aws |
Amazon Web Services (AWS) properties. |
azure |
Azure properties. |
cloud |
Cloud Spanner properties. |
cloud |
Cloud Resource properties. |
spark |
Spark properties. |
salesforce |
Optional. Salesforce DataCloud properties. This field is intended for use only by Salesforce partner projects. This field contains properties for your Salesforce DataCloud connection. |
CloudSqlProperties
Connection properties specific to the Cloud SQL.
JSON representation |
---|
{ "instanceId": string, "database": string, "type": enum ( |
Fields | |
---|---|
instance |
Cloud SQL instance ID in the form |
database |
Database name. |
type |
Type of the Cloud SQL database. |
credential |
Input only. Cloud SQL credential. |
service |
Output only. The account ID of the service used for the purpose of this connection. When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection. |
DatabaseType
Supported Cloud SQL database types.
Enums | |
---|---|
DATABASE_TYPE_UNSPECIFIED |
Unspecified database type. |
POSTGRES |
Cloud SQL for PostgreSQL. |
MYSQL |
Cloud SQL for MySQL. |
CloudSqlCredential
Credential info for the Cloud SQL.
JSON representation |
---|
{ "username": string, "password": string } |
Fields | |
---|---|
username |
The username for the credential. |
password |
The password for the credential. |
AwsProperties
Connection properties specific to Amazon Web Services (AWS).
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field authentication_method . Authentication method chosen at connection creation. authentication_method can be only one of the following: |
|
access |
Authentication using Google owned service account to assume into customer's AWS IAM Role. |
AwsAccessRole
Authentication method for Amazon Web Services (AWS) that uses Google owned Google service account to assume into customer's AWS IAM Role.
JSON representation |
---|
{ "iamRoleId": string, "identity": string } |
Fields | |
---|---|
iam |
The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection. |
identity |
A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role. |
AzureProperties
Container for connection properties specific to Azure.
JSON representation |
---|
{ "application": string, "clientId": string, "objectId": string, "customerTenantId": string, "redirectUri": string, "federatedApplicationClientId": string, "identity": string } |
Fields | |
---|---|
application |
Output only. The name of the Azure Active Directory Application. |
client |
Output only. The client id of the Azure Active Directory Application. |
object |
Output only. The object id of the Azure Active Directory Application. |
customer |
The id of customer's directory that host the data. |
redirect |
The URL user will be redirected to after granting consent during connection setup. |
federated |
The client ID of the user's Azure Active Directory Application used for a federated connection. |
identity |
Output only. A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application. |
CloudSpannerProperties
Connection properties specific to Cloud Spanner.
JSON representation |
---|
{ "database": string, "useParallelism": boolean, "maxParallelism": integer, "useDataBoost": boolean, "databaseRole": string } |
Fields | |
---|---|
database |
Cloud Spanner database in the form `project/instance/database' |
use |
If parallelism should be used when reading from Cloud Spanner |
max |
Allows setting max parallelism per query when executing on Spanner independent compute resources. If unspecified, default values of parallelism are chosen that are dependent on the Cloud Spanner instance configuration. REQUIRES: REQUIRES: |
use |
If set, the request will be executed via Spanner independent compute resources. REQUIRES: |
database |
Optional. Cloud Spanner database role for fine-grained access control. The Cloud Spanner admin should have provisioned the database role with appropriate permissions, such as For more details, see About fine-grained access control. REQUIRES: The database role name must start with a letter, and can only contain letters, numbers, and underscores. |
CloudResourceProperties
Container for connection properties for delegation of access to GCP resources.
JSON representation |
---|
{ "serviceAccountId": string } |
Fields | |
---|---|
service |
Output only. The account ID of the service created for the purpose of this connection. The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of an operation in BigQuery, the service account will be used to connect to the desired resources in GCP. The account ID is in the form of: |
SparkProperties
Container for connection properties to execute stored procedures for Apache Spark.
JSON representation |
---|
{ "serviceAccountId": string, "metastoreServiceConfig": { object ( |
Fields | |
---|---|
service |
Output only. The account ID of the service created for the purpose of this connection. The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of a stored procedure for Apache Spark in BigQuery, the service account is used to connect to the desired resources in Google Cloud. The account ID is in the form of: bqcx- |
metastore |
Optional. Dataproc Metastore Service configuration for the connection. |
spark |
Optional. Spark History Server configuration for the connection. |
MetastoreServiceConfig
Configuration of the Dataproc Metastore Service.
JSON representation |
---|
{ "metastoreService": string } |
Fields | |
---|---|
metastore |
Optional. Resource name of an existing Dataproc Metastore service. Example:
|
SparkHistoryServerConfig
Configuration of the Spark History Server.
JSON representation |
---|
{ "dataprocCluster": string } |
Fields | |
---|---|
dataproc |
Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the connection. Example:
|
SalesforceDataCloudProperties
Connection properties specific to Salesforce DataCloud. This is intended for use only by Salesforce partner projects.
JSON representation |
---|
{ "instanceUri": string, "identity": string, "tenantId": string } |
Fields | |
---|---|
instance |
The URL to the user's Salesforce DataCloud instance. |
identity |
Output only. A unique Google-owned and Google-generated service account identity for the connection. |
tenant |
The ID of the user's Salesforce tenant. |
ConnectorConfiguration
Represents concrete parameter values for Connector Configuration.
JSON representation |
---|
{ "connectorId": string, "endpoint": { object ( |
Fields | |
---|---|
connector |
Required. Immutable. The ID of the Connector these parameters are configured for. |
endpoint |
Specifies how to reach the remote system this connection is pointing to. |
authentication |
Client authentication. |
network |
Networking configuration. |
asset |
Data asset. |
Endpoint
Remote endpoint specification.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
host |
Host and port in a format of |
Authentication
Client authentication.
JSON representation |
---|
{
"usernamePassword": {
object ( |
Fields | |
---|---|
username |
Username/password authentication. |
service |
Output only. Google-managed service account associated with this connection, e.g., |
UsernamePassword
Username and Password authentication.
JSON representation |
---|
{
"username": string,
"password": {
object ( |
Fields | |
---|---|
username |
Required. Username. |
password |
Required. Password. |
Secret
Secret value parameter.
JSON representation |
---|
{ "secretType": enum ( |
Fields | |
---|---|
secret |
Output only. Indicates type of secret. Can be used to check type of stored secret value even if it's |
Union field secret . Required. Secret value. secret can be only one of the following: |
|
plaintext |
Input only. Secret as plaintext. |
SecretType
Indicates type of stored secret.
Enums | |
---|---|
SECRET_TYPE_UNSPECIFIED |
|
PLAINTEXT |
Network
Network related configuration.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
private |
Private Service Connect networking configuration. |
PrivateServiceConnect
Private Service Connect configuration.
JSON representation |
---|
{ "networkAttachment": string } |
Fields | |
---|---|
network |
Required. Network Attachment name in the format of |
Asset
Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB.
JSON representation |
---|
{ "database": string, "googleCloudResource": string } |
Fields | |
---|---|
database |
Name of the database. |
google |
Full Google Cloud resource name - https://cloud.google.com/apis/design/resource_names#full_resource_name. Example: |
Methods |
|
---|---|
|
Creates a new connection. |
|
Deletes connection and associated credential. |
|
Returns specified connection. |
|
Gets the access control policy for a resource. |
|
Returns a list of connections in the given project. |
|
Updates the specified connection. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |