connectionpb

package
v1.65.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 5, 2024 License: Apache-2.0 Imports: 12 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	CloudSqlProperties_DatabaseType_name = map[int32]string{
		0: "DATABASE_TYPE_UNSPECIFIED",
		1: "POSTGRES",
		2: "MYSQL",
	}
	CloudSqlProperties_DatabaseType_value = map[string]int32{
		"DATABASE_TYPE_UNSPECIFIED": 0,
		"POSTGRES":                  1,
		"MYSQL":                     2,
	}
)

Enum value maps for CloudSqlProperties_DatabaseType.

View Source 
var File_google_cloud_bigquery_connection_v1_connection_proto protoreflect.FileDescriptor

Functions

func RegisterConnectionServiceServer 

func RegisterConnectionServiceServer(s *grpc.Server, srv ConnectionServiceServer)

Types

type AwsAccessRole 

type AwsAccessRole struct {

	// The user’s AWS IAM Role that trusts the Google-owned AWS IAM user
	// Connection.
	IamRoleId string `protobuf:"bytes,1,opt,name=iam_role_id,json=iamRoleId,proto3" json:"iam_role_id,omitempty"`
	// A unique Google-owned and Google-generated identity for the Connection.
	// This identity will be used to access the user's AWS IAM Role.
	Identity string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"`
	// contains filtered or unexported fields
}

Authentication method for Amazon Web Services (AWS) that uses Google owned Google service account to assume into customer's AWS IAM Role.

func (*AwsAccessRole) Descriptor deprecated 

func (*AwsAccessRole) Descriptor() ([]byte, []int)

Deprecated: Use AwsAccessRole.ProtoReflect.Descriptor instead.

func (*AwsAccessRole) GetIamRoleId 

func (x *AwsAccessRole) GetIamRoleId() string

func (*AwsAccessRole) GetIdentity 

func (x *AwsAccessRole) GetIdentity() string

func (*AwsAccessRole) ProtoMessage 

func (*AwsAccessRole) ProtoMessage()

func (*AwsAccessRole) ProtoReflect 

func (x *AwsAccessRole) ProtoReflect() protoreflect.Message

func (*AwsAccessRole) Reset 

func (x *AwsAccessRole) Reset()

func (*AwsAccessRole) String 

func (x *AwsAccessRole) String() string

type AwsCrossAccountRole 

type AwsCrossAccountRole struct {

	// The user’s AWS IAM Role that trusts the Google-owned AWS IAM user
	// Connection.
	IamRoleId string `protobuf:"bytes,1,opt,name=iam_role_id,json=iamRoleId,proto3" json:"iam_role_id,omitempty"`
	// Output only. Google-owned AWS IAM User for a Connection.
	IamUserId string `protobuf:"bytes,2,opt,name=iam_user_id,json=iamUserId,proto3" json:"iam_user_id,omitempty"`
	// Output only. A Google-generated id for representing Connection’s identity
	// in AWS. External Id is also used for preventing the Confused Deputy
	// Problem. See
	// https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html
	ExternalId string `protobuf:"bytes,3,opt,name=external_id,json=externalId,proto3" json:"external_id,omitempty"`
	// contains filtered or unexported fields
}

Authentication method for Amazon Web Services (AWS) that uses Google owned AWS IAM user's access key to assume into customer's AWS IAM Role.

func (*AwsCrossAccountRole) Descriptor deprecated 

func (*AwsCrossAccountRole) Descriptor() ([]byte, []int)

Deprecated: Use AwsCrossAccountRole.ProtoReflect.Descriptor instead.

func (*AwsCrossAccountRole) GetExternalId 

func (x *AwsCrossAccountRole) GetExternalId() string

func (*AwsCrossAccountRole) GetIamRoleId 

func (x *AwsCrossAccountRole) GetIamRoleId() string

func (*AwsCrossAccountRole) GetIamUserId 

func (x *AwsCrossAccountRole) GetIamUserId() string

func (*AwsCrossAccountRole) ProtoMessage 

func (*AwsCrossAccountRole) ProtoMessage()

func (*AwsCrossAccountRole) ProtoReflect 

func (x *AwsCrossAccountRole) ProtoReflect() protoreflect.Message

func (*AwsCrossAccountRole) Reset 

func (x *AwsCrossAccountRole) Reset()

func (*AwsCrossAccountRole) String 

func (x *AwsCrossAccountRole) String() string

type AwsProperties 

type AwsProperties struct {

	// Authentication method chosen at connection creation.
	//
	// Types that are assignable to AuthenticationMethod:
	//
	//	*AwsProperties_CrossAccountRole
	//	*AwsProperties_AccessRole
	AuthenticationMethod isAwsProperties_AuthenticationMethod `protobuf_oneof:"authentication_method"`
	// contains filtered or unexported fields
}

Connection properties specific to Amazon Web Services (AWS).

func (*AwsProperties) Descriptor deprecated 

func (*AwsProperties) Descriptor() ([]byte, []int)

Deprecated: Use AwsProperties.ProtoReflect.Descriptor instead.

func (*AwsProperties) GetAccessRole 

func (x *AwsProperties) GetAccessRole() *AwsAccessRole

func (*AwsProperties) GetAuthenticationMethod 

func (m *AwsProperties) GetAuthenticationMethod() isAwsProperties_AuthenticationMethod

func (*AwsProperties) GetCrossAccountRole deprecated 

func (x *AwsProperties) GetCrossAccountRole() *AwsCrossAccountRole

Deprecated: Marked as deprecated in google/cloud/bigquery/connection/v1/connection.proto.

func (*AwsProperties) ProtoMessage 

func (*AwsProperties) ProtoMessage()

func (*AwsProperties) ProtoReflect 

func (x *AwsProperties) ProtoReflect() protoreflect.Message

func (*AwsProperties) Reset 

func (x *AwsProperties) Reset()

func (*AwsProperties) String 

func (x *AwsProperties) String() string

type AwsProperties_AccessRole 

type AwsProperties_AccessRole struct {
	// Authentication using Google owned service account to assume into
	// customer's AWS IAM Role.
	AccessRole *AwsAccessRole `protobuf:"bytes,3,opt,name=access_role,json=accessRole,proto3,oneof"`
}

type AwsProperties_CrossAccountRole 

type AwsProperties_CrossAccountRole struct {
	// Authentication using Google owned AWS IAM user's access key to assume
	// into customer's AWS IAM Role.
	// Deprecated, do not use.
	//
	// Deprecated: Marked as deprecated in google/cloud/bigquery/connection/v1/connection.proto.
	CrossAccountRole *AwsCrossAccountRole `protobuf:"bytes,2,opt,name=cross_account_role,json=crossAccountRole,proto3,oneof"`
}

type AzureProperties 

type AzureProperties struct {

	// Output only. The name of the Azure Active Directory Application.
	Application string `protobuf:"bytes,1,opt,name=application,proto3" json:"application,omitempty"`
	// Output only. The client id of the Azure Active Directory Application.
	ClientId string `protobuf:"bytes,2,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
	// Output only. The object id of the Azure Active Directory Application.
	ObjectId string `protobuf:"bytes,3,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// The id of customer's directory that host the data.
	CustomerTenantId string `protobuf:"bytes,4,opt,name=customer_tenant_id,json=customerTenantId,proto3" json:"customer_tenant_id,omitempty"`
	// The URL user will be redirected to after granting consent during connection
	// setup.
	RedirectUri string `protobuf:"bytes,5,opt,name=redirect_uri,json=redirectUri,proto3" json:"redirect_uri,omitempty"`
	// The client ID of the user's Azure Active Directory Application used for a
	// federated connection.
	FederatedApplicationClientId string `` /* 149-byte string literal not displayed */
	// 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.
	Identity string `protobuf:"bytes,7,opt,name=identity,proto3" json:"identity,omitempty"`
	// contains filtered or unexported fields
}

Container for connection properties specific to Azure.

func (*AzureProperties) Descriptor deprecated 

func (*AzureProperties) Descriptor() ([]byte, []int)

Deprecated: Use AzureProperties.ProtoReflect.Descriptor instead.

func (*AzureProperties) GetApplication 

func (x *AzureProperties) GetApplication() string

func (*AzureProperties) GetClientId 

func (x *AzureProperties) GetClientId() string

func (*AzureProperties) GetCustomerTenantId 

func (x *AzureProperties) GetCustomerTenantId() string

func (*AzureProperties) GetFederatedApplicationClientId 

func (x *AzureProperties) GetFederatedApplicationClientId() string

func (*AzureProperties) GetIdentity 

func (x *AzureProperties) GetIdentity() string

func (*AzureProperties) GetObjectId 

func (x *AzureProperties) GetObjectId() string

func (*AzureProperties) GetRedirectUri 

func (x *AzureProperties) GetRedirectUri() string

func (*AzureProperties) ProtoMessage 

func (*AzureProperties) ProtoMessage()

func (*AzureProperties) ProtoReflect 

func (x *AzureProperties) ProtoReflect() protoreflect.Message

func (*AzureProperties) Reset 

func (x *AzureProperties) Reset()

func (*AzureProperties) String 

func (x *AzureProperties) String() string

type CloudResourceProperties 

type CloudResourceProperties struct {

	// 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:
	//
	//	<service-1234>@gcp-sa-bigquery-cloudresource.iam.gserviceaccount.com
	ServiceAccountId string `protobuf:"bytes,1,opt,name=service_account_id,json=serviceAccountId,proto3" json:"service_account_id,omitempty"`
	// contains filtered or unexported fields
}

Container for connection properties for delegation of access to GCP resources.

func (*CloudResourceProperties) Descriptor deprecated 

func (*CloudResourceProperties) Descriptor() ([]byte, []int)

Deprecated: Use CloudResourceProperties.ProtoReflect.Descriptor instead.

func (*CloudResourceProperties) GetServiceAccountId 

func (x *CloudResourceProperties) GetServiceAccountId() string

func (*CloudResourceProperties) ProtoMessage 

func (*CloudResourceProperties) ProtoMessage()

func (*CloudResourceProperties) ProtoReflect 

func (x *CloudResourceProperties) ProtoReflect() protoreflect.Message

func (*CloudResourceProperties) Reset 

func (x *CloudResourceProperties) Reset()

func (*CloudResourceProperties) String 

func (x *CloudResourceProperties) String() string

type CloudSpannerProperties 

type CloudSpannerProperties struct {

	// Cloud Spanner database in the form `project/instance/database'
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// If parallelism should be used when reading from Cloud Spanner
	UseParallelism bool `protobuf:"varint,2,opt,name=use_parallelism,json=useParallelism,proto3" json:"use_parallelism,omitempty"`
	// 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: `use_parallelism` must be set.
	// REQUIRES: Either `use_data_boost` or `use_serverless_analytics` must be
	// set.
	MaxParallelism int32 `protobuf:"varint,5,opt,name=max_parallelism,json=maxParallelism,proto3" json:"max_parallelism,omitempty"`
	// If the serverless analytics service should be used to read data from Cloud
	// Spanner.
	// Note: `use_parallelism` must be set when using serverless analytics.
	UseServerlessAnalytics bool `` /* 130-byte string literal not displayed */
	// If set, the request will be executed via Spanner independent compute
	// resources.
	// REQUIRES: `use_parallelism` must be set.
	//
	// NOTE: `use_serverless_analytics` will be deprecated. Prefer
	// `use_data_boost` over `use_serverless_analytics`.
	UseDataBoost bool `protobuf:"varint,6,opt,name=use_data_boost,json=useDataBoost,proto3" json:"use_data_boost,omitempty"`
	// 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 `SELECT` and `INSERT`. Other users should
	// only use roles provided by their Cloud Spanner admins.
	//
	// For more details, see [About fine-grained access control]
	// (https://cloud.google.com/spanner/docs/fgac-about).
	//
	// REQUIRES: The database role name must start with a letter, and can only
	// contain letters, numbers, and underscores.
	DatabaseRole string `protobuf:"bytes,4,opt,name=database_role,json=databaseRole,proto3" json:"database_role,omitempty"`
	// contains filtered or unexported fields
}

Connection properties specific to Cloud Spanner.

func (*CloudSpannerProperties) Descriptor deprecated 

func (*CloudSpannerProperties) Descriptor() ([]byte, []int)

Deprecated: Use CloudSpannerProperties.ProtoReflect.Descriptor instead.

func (*CloudSpannerProperties) GetDatabase 

func (x *CloudSpannerProperties) GetDatabase() string

func (*CloudSpannerProperties) GetDatabaseRole added in v1.48.0 

func (x *CloudSpannerProperties) GetDatabaseRole() string

func (*CloudSpannerProperties) GetMaxParallelism added in v1.53.0 

func (x *CloudSpannerProperties) GetMaxParallelism() int32

func (*CloudSpannerProperties) GetUseDataBoost added in v1.53.0 

func (x *CloudSpannerProperties) GetUseDataBoost() bool

func (*CloudSpannerProperties) GetUseParallelism 

func (x *CloudSpannerProperties) GetUseParallelism() bool

func (*CloudSpannerProperties) GetUseServerlessAnalytics added in v1.48.0 

func (x *CloudSpannerProperties) GetUseServerlessAnalytics() bool

func (*CloudSpannerProperties) ProtoMessage 

func (*CloudSpannerProperties) ProtoMessage()

func (*CloudSpannerProperties) ProtoReflect 

func (x *CloudSpannerProperties) ProtoReflect() protoreflect.Message

func (*CloudSpannerProperties) Reset 

func (x *CloudSpannerProperties) Reset()

func (*CloudSpannerProperties) String 

func (x *CloudSpannerProperties) String() string

type CloudSqlCredential 

type CloudSqlCredential struct {

	// The username for the credential.
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// The password for the credential.
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

Credential info for the Cloud SQL.

func (*CloudSqlCredential) Descriptor deprecated 

func (*CloudSqlCredential) Descriptor() ([]byte, []int)

Deprecated: Use CloudSqlCredential.ProtoReflect.Descriptor instead.

func (*CloudSqlCredential) GetPassword 

func (x *CloudSqlCredential) GetPassword() string

func (*CloudSqlCredential) GetUsername 

func (x *CloudSqlCredential) GetUsername() string

func (*CloudSqlCredential) ProtoMessage 

func (*CloudSqlCredential) ProtoMessage()

func (*CloudSqlCredential) ProtoReflect 

func (x *CloudSqlCredential) ProtoReflect() protoreflect.Message

func (*CloudSqlCredential) Reset 

func (x *CloudSqlCredential) Reset()

func (*CloudSqlCredential) String 

func (x *CloudSqlCredential) String() string

type CloudSqlProperties 

type CloudSqlProperties struct {

	// Cloud SQL instance ID in the form `project:location:instance`.
	InstanceId string `protobuf:"bytes,1,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Database name.
	Database string `protobuf:"bytes,2,opt,name=database,proto3" json:"database,omitempty"`
	// Type of the Cloud SQL database.
	Type CloudSqlProperties_DatabaseType `` /* 135-byte string literal not displayed */
	// Input only. Cloud SQL credential.
	Credential *CloudSqlCredential `protobuf:"bytes,4,opt,name=credential,proto3" json:"credential,omitempty"`
	// 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.
	ServiceAccountId string `protobuf:"bytes,5,opt,name=service_account_id,json=serviceAccountId,proto3" json:"service_account_id,omitempty"`
	// contains filtered or unexported fields
}

Connection properties specific to the Cloud SQL.

func (*CloudSqlProperties) Descriptor deprecated 

func (*CloudSqlProperties) Descriptor() ([]byte, []int)

Deprecated: Use CloudSqlProperties.ProtoReflect.Descriptor instead.

func (*CloudSqlProperties) GetCredential 

func (x *CloudSqlProperties) GetCredential() *CloudSqlCredential

func (*CloudSqlProperties) GetDatabase 

func (x *CloudSqlProperties) GetDatabase() string

func (*CloudSqlProperties) GetInstanceId 

func (x *CloudSqlProperties) GetInstanceId() string

func (*CloudSqlProperties) GetServiceAccountId 

func (x *CloudSqlProperties) GetServiceAccountId() string

func (*CloudSqlProperties) GetType 

func (x *CloudSqlProperties) GetType() CloudSqlProperties_DatabaseType

func (*CloudSqlProperties) ProtoMessage 

func (*CloudSqlProperties) ProtoMessage()

func (*CloudSqlProperties) ProtoReflect 

func (x *CloudSqlProperties) ProtoReflect() protoreflect.Message

func (*CloudSqlProperties) Reset 

func (x *CloudSqlProperties) Reset()

func (*CloudSqlProperties) String 

func (x *CloudSqlProperties) String() string

type CloudSqlProperties_DatabaseType 

type CloudSqlProperties_DatabaseType int32

Supported Cloud SQL database types. 

const (
	// Unspecified database type.
	CloudSqlProperties_DATABASE_TYPE_UNSPECIFIED CloudSqlProperties_DatabaseType = 0
	// Cloud SQL for PostgreSQL.
	CloudSqlProperties_POSTGRES CloudSqlProperties_DatabaseType = 1
	// Cloud SQL for MySQL.
	CloudSqlProperties_MYSQL CloudSqlProperties_DatabaseType = 2
)

func (CloudSqlProperties_DatabaseType) Descriptor 

func (CloudSqlProperties_DatabaseType) Descriptor() protoreflect.EnumDescriptor

func (CloudSqlProperties_DatabaseType) Enum 

func (x CloudSqlProperties_DatabaseType) Enum() *CloudSqlProperties_DatabaseType

func (CloudSqlProperties_DatabaseType) EnumDescriptor deprecated 

func (CloudSqlProperties_DatabaseType) EnumDescriptor() ([]byte, []int)

Deprecated: Use CloudSqlProperties_DatabaseType.Descriptor instead.

func (CloudSqlProperties_DatabaseType) Number 

func (x CloudSqlProperties_DatabaseType) Number() protoreflect.EnumNumber

func (CloudSqlProperties_DatabaseType) String 

func (x CloudSqlProperties_DatabaseType) String() string

func (CloudSqlProperties_DatabaseType) Type 

func (CloudSqlProperties_DatabaseType) Type() protoreflect.EnumType

type Connection 

type Connection struct {

	// The resource name of the connection in the form of:
	// `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// User provided display name for the connection.
	FriendlyName string `protobuf:"bytes,2,opt,name=friendly_name,json=friendlyName,proto3" json:"friendly_name,omitempty"`
	// User provided description.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Properties specific to the underlying data source.
	//
	// Types that are assignable to Properties:
	//
	//	*Connection_CloudSql
	//	*Connection_Aws
	//	*Connection_Azure
	//	*Connection_CloudSpanner
	//	*Connection_CloudResource
	//	*Connection_Spark
	//	*Connection_SalesforceDataCloud
	Properties isConnection_Properties `protobuf_oneof:"properties"`
	// Output only. The creation timestamp of the connection.
	CreationTime int64 `protobuf:"varint,5,opt,name=creation_time,json=creationTime,proto3" json:"creation_time,omitempty"`
	// Output only. The last update timestamp of the connection.
	LastModifiedTime int64 `protobuf:"varint,6,opt,name=last_modified_time,json=lastModifiedTime,proto3" json:"last_modified_time,omitempty"`
	// Output only. True, if credential is configured for this connection.
	HasCredential bool `protobuf:"varint,7,opt,name=has_credential,json=hasCredential,proto3" json:"has_credential,omitempty"`
	// contains filtered or unexported fields
}

Configuration parameters to establish connection with an external data source, except the credential attributes.

func (*Connection) Descriptor deprecated 

func (*Connection) Descriptor() ([]byte, []int)

Deprecated: Use Connection.ProtoReflect.Descriptor instead.

func (*Connection) GetAws 

func (x *Connection) GetAws() *AwsProperties

func (*Connection) GetAzure 

func (x *Connection) GetAzure() *AzureProperties

func (*Connection) GetCloudResource 

func (x *Connection) GetCloudResource() *CloudResourceProperties

func (*Connection) GetCloudSpanner 

func (x *Connection) GetCloudSpanner() *CloudSpannerProperties

func (*Connection) GetCloudSql 

func (x *Connection) GetCloudSql() *CloudSqlProperties

func (*Connection) GetCreationTime 

func (x *Connection) GetCreationTime() int64

func (*Connection) GetDescription 

func (x *Connection) GetDescription() string

func (*Connection) GetFriendlyName 

func (x *Connection) GetFriendlyName() string

func (*Connection) GetHasCredential 

func (x *Connection) GetHasCredential() bool

func (*Connection) GetLastModifiedTime 

func (x *Connection) GetLastModifiedTime() int64

func (*Connection) GetName 

func (x *Connection) GetName() string

func (*Connection) GetProperties 

func (m *Connection) GetProperties() isConnection_Properties

func (*Connection) GetSalesforceDataCloud added in v1.53.0 

func (x *Connection) GetSalesforceDataCloud() *SalesforceDataCloudProperties

func (*Connection) GetSpark added in v1.50.0 

func (x *Connection) GetSpark() *SparkProperties

func (*Connection) ProtoMessage 

func (*Connection) ProtoMessage()

func (*Connection) ProtoReflect 

func (x *Connection) ProtoReflect() protoreflect.Message

func (*Connection) Reset 

func (x *Connection) Reset()

func (*Connection) String 

func (x *Connection) String() string

type ConnectionServiceClient 

type ConnectionServiceClient interface {
	// Creates a new connection.
	CreateConnection(ctx context.Context, in *CreateConnectionRequest, opts ...grpc.CallOption) (*Connection, error)
	// Returns specified connection.
	GetConnection(ctx context.Context, in *GetConnectionRequest, opts ...grpc.CallOption) (*Connection, error)
	// Returns a list of connections in the given project.
	ListConnections(ctx context.Context, in *ListConnectionsRequest, opts ...grpc.CallOption) (*ListConnectionsResponse, error)
	// Updates the specified connection. For security reasons, also resets
	// credential if connection properties are in the update field mask.
	UpdateConnection(ctx context.Context, in *UpdateConnectionRequest, opts ...grpc.CallOption) (*Connection, error)
	// Deletes connection and associated credential.
	DeleteConnection(ctx context.Context, in *DeleteConnectionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Gets the access control policy for a resource.
	// Returns an empty policy if the resource exists and does not have a policy
	// set.
	GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Sets the access control policy on the specified resource. Replaces any
	// existing policy.
	//
	// Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
	SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Returns permissions that a caller has on the specified resource.
	// If the resource does not exist, this will return an empty set of
	// permissions, not a `NOT_FOUND` error.
	//
	// Note: This operation is designed to be used for building permission-aware
	// UIs and command-line tools, not for authorization checking. This operation
	// may "fail open" without warning.
	TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
}

ConnectionServiceClient is the client API for ConnectionService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewConnectionServiceClient 

func NewConnectionServiceClient(cc grpc.ClientConnInterface) ConnectionServiceClient

type ConnectionServiceServer 

type ConnectionServiceServer interface {
	// Creates a new connection.
	CreateConnection(context.Context, *CreateConnectionRequest) (*Connection, error)
	// Returns specified connection.
	GetConnection(context.Context, *GetConnectionRequest) (*Connection, error)
	// Returns a list of connections in the given project.
	ListConnections(context.Context, *ListConnectionsRequest) (*ListConnectionsResponse, error)
	// Updates the specified connection. For security reasons, also resets
	// credential if connection properties are in the update field mask.
	UpdateConnection(context.Context, *UpdateConnectionRequest) (*Connection, error)
	// Deletes connection and associated credential.
	DeleteConnection(context.Context, *DeleteConnectionRequest) (*emptypb.Empty, error)
	// Gets the access control policy for a resource.
	// Returns an empty policy if the resource exists and does not have a policy
	// set.
	GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
	// Sets the access control policy on the specified resource. Replaces any
	// existing policy.
	//
	// Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
	SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
	// Returns permissions that a caller has on the specified resource.
	// If the resource does not exist, this will return an empty set of
	// permissions, not a `NOT_FOUND` error.
	//
	// Note: This operation is designed to be used for building permission-aware
	// UIs and command-line tools, not for authorization checking. This operation
	// may "fail open" without warning.
	TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
}

ConnectionServiceServer is the server API for ConnectionService service.

type Connection_Aws 

type Connection_Aws struct {
	// Amazon Web Services (AWS) properties.
	Aws *AwsProperties `protobuf:"bytes,8,opt,name=aws,proto3,oneof"`
}

type Connection_Azure 

type Connection_Azure struct {
	// Azure properties.
	Azure *AzureProperties `protobuf:"bytes,11,opt,name=azure,proto3,oneof"`
}

type Connection_CloudResource 

type Connection_CloudResource struct {
	// Cloud Resource properties.
	CloudResource *CloudResourceProperties `protobuf:"bytes,22,opt,name=cloud_resource,json=cloudResource,proto3,oneof"`
}

type Connection_CloudSpanner 

type Connection_CloudSpanner struct {
	// Cloud Spanner properties.
	CloudSpanner *CloudSpannerProperties `protobuf:"bytes,21,opt,name=cloud_spanner,json=cloudSpanner,proto3,oneof"`
}

type Connection_CloudSql 

type Connection_CloudSql struct {
	// Cloud SQL properties.
	CloudSql *CloudSqlProperties `protobuf:"bytes,4,opt,name=cloud_sql,json=cloudSql,proto3,oneof"`
}

type Connection_SalesforceDataCloud added in v1.53.0 

type Connection_SalesforceDataCloud struct {
	// Optional. Salesforce DataCloud properties. This field is intended for
	// use only by Salesforce partner projects. This field contains properties
	// for your Salesforce DataCloud connection.
	SalesforceDataCloud *SalesforceDataCloudProperties `protobuf:"bytes,24,opt,name=salesforce_data_cloud,json=salesforceDataCloud,proto3,oneof"`
}

type Connection_Spark added in v1.50.0 

type Connection_Spark struct {
	// Spark properties.
	Spark *SparkProperties `protobuf:"bytes,23,opt,name=spark,proto3,oneof"`
}

type CreateConnectionRequest 

type CreateConnectionRequest struct {

	// Required. Parent resource name.
	// Must be in the format `projects/{project_id}/locations/{location_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Connection id that should be assigned to the created connection.
	ConnectionId string `protobuf:"bytes,2,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"`
	// Required. Connection to create.
	Connection *Connection `protobuf:"bytes,3,opt,name=connection,proto3" json:"connection,omitempty"`
	// contains filtered or unexported fields
}

The request for [ConnectionService.CreateConnection][google.cloud.bigquery.connection.v1.ConnectionService.CreateConnection].

func (*CreateConnectionRequest) Descriptor deprecated 

func (*CreateConnectionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateConnectionRequest.ProtoReflect.Descriptor instead.

func (*CreateConnectionRequest) GetConnection 

func (x *CreateConnectionRequest) GetConnection() *Connection

func (*CreateConnectionRequest) GetConnectionId 

func (x *CreateConnectionRequest) GetConnectionId() string

func (*CreateConnectionRequest) GetParent 

func (x *CreateConnectionRequest) GetParent() string

func (*CreateConnectionRequest) ProtoMessage 

func (*CreateConnectionRequest) ProtoMessage()

func (*CreateConnectionRequest) ProtoReflect 

func (x *CreateConnectionRequest) ProtoReflect() protoreflect.Message

func (*CreateConnectionRequest) Reset 

func (x *CreateConnectionRequest) Reset()

func (*CreateConnectionRequest) String 

func (x *CreateConnectionRequest) String() string

type DeleteConnectionRequest 

type DeleteConnectionRequest struct {

	// Required. Name of the deleted connection, for example:
	// `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [ConnectionService.DeleteConnectionRequest][].

func (*DeleteConnectionRequest) Descriptor deprecated 

func (*DeleteConnectionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteConnectionRequest.ProtoReflect.Descriptor instead.

func (*DeleteConnectionRequest) GetName 

func (x *DeleteConnectionRequest) GetName() string

func (*DeleteConnectionRequest) ProtoMessage 

func (*DeleteConnectionRequest) ProtoMessage()

func (*DeleteConnectionRequest) ProtoReflect 

func (x *DeleteConnectionRequest) ProtoReflect() protoreflect.Message

func (*DeleteConnectionRequest) Reset 

func (x *DeleteConnectionRequest) Reset()

func (*DeleteConnectionRequest) String 

func (x *DeleteConnectionRequest) String() string

type GetConnectionRequest 

type GetConnectionRequest struct {

	// Required. Name of the requested connection, for example:
	// `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [ConnectionService.GetConnection][google.cloud.bigquery.connection.v1.ConnectionService.GetConnection].

func (*GetConnectionRequest) Descriptor deprecated 

func (*GetConnectionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetConnectionRequest.ProtoReflect.Descriptor instead.

func (*GetConnectionRequest) GetName 

func (x *GetConnectionRequest) GetName() string

func (*GetConnectionRequest) ProtoMessage 

func (*GetConnectionRequest) ProtoMessage()

func (*GetConnectionRequest) ProtoReflect 

func (x *GetConnectionRequest) ProtoReflect() protoreflect.Message

func (*GetConnectionRequest) Reset 

func (x *GetConnectionRequest) Reset()

func (*GetConnectionRequest) String 

func (x *GetConnectionRequest) String() string

type ListConnectionsRequest 

type ListConnectionsRequest struct {

	// Required. Parent resource name.
	// Must be in the form: `projects/{project_id}/locations/{location_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Page size.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1.ConnectionService.ListConnections].

func (*ListConnectionsRequest) Descriptor deprecated 

func (*ListConnectionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListConnectionsRequest.ProtoReflect.Descriptor instead.

func (*ListConnectionsRequest) GetPageSize 

func (x *ListConnectionsRequest) GetPageSize() int32

func (*ListConnectionsRequest) GetPageToken 

func (x *ListConnectionsRequest) GetPageToken() string

func (*ListConnectionsRequest) GetParent 

func (x *ListConnectionsRequest) GetParent() string

func (*ListConnectionsRequest) ProtoMessage 

func (*ListConnectionsRequest) ProtoMessage()

func (*ListConnectionsRequest) ProtoReflect 

func (x *ListConnectionsRequest) ProtoReflect() protoreflect.Message

func (*ListConnectionsRequest) Reset 

func (x *ListConnectionsRequest) Reset()

func (*ListConnectionsRequest) String 

func (x *ListConnectionsRequest) String() string

type ListConnectionsResponse 

type ListConnectionsResponse struct {

	// Next page token.
	NextPageToken string `protobuf:"bytes,1,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// List of connections.
	Connections []*Connection `protobuf:"bytes,2,rep,name=connections,proto3" json:"connections,omitempty"`
	// contains filtered or unexported fields
}

The response for [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1.ConnectionService.ListConnections].

func (*ListConnectionsResponse) Descriptor deprecated 

func (*ListConnectionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListConnectionsResponse.ProtoReflect.Descriptor instead.

func (*ListConnectionsResponse) GetConnections 

func (x *ListConnectionsResponse) GetConnections() []*Connection

func (*ListConnectionsResponse) GetNextPageToken 

func (x *ListConnectionsResponse) GetNextPageToken() string

func (*ListConnectionsResponse) ProtoMessage 

func (*ListConnectionsResponse) ProtoMessage()

func (*ListConnectionsResponse) ProtoReflect 

func (x *ListConnectionsResponse) ProtoReflect() protoreflect.Message

func (*ListConnectionsResponse) Reset 

func (x *ListConnectionsResponse) Reset()

func (*ListConnectionsResponse) String 

func (x *ListConnectionsResponse) String() string

type MetastoreServiceConfig added in v1.50.0 

type MetastoreServiceConfig struct {

	// Optional. Resource name of an existing Dataproc Metastore service.
	//
	// Example:
	//
	// * `projects/[project_id]/locations/[region]/services/[service_id]`
	MetastoreService string `protobuf:"bytes,1,opt,name=metastore_service,json=metastoreService,proto3" json:"metastore_service,omitempty"`
	// contains filtered or unexported fields
}

Configuration of the Dataproc Metastore Service.

func (*MetastoreServiceConfig) Descriptor deprecated added in v1.50.0 

func (*MetastoreServiceConfig) Descriptor() ([]byte, []int)

Deprecated: Use MetastoreServiceConfig.ProtoReflect.Descriptor instead.

func (*MetastoreServiceConfig) GetMetastoreService added in v1.50.0 

func (x *MetastoreServiceConfig) GetMetastoreService() string

func (*MetastoreServiceConfig) ProtoMessage added in v1.50.0 

func (*MetastoreServiceConfig) ProtoMessage()

func (*MetastoreServiceConfig) ProtoReflect added in v1.50.0 

func (x *MetastoreServiceConfig) ProtoReflect() protoreflect.Message

func (*MetastoreServiceConfig) Reset added in v1.50.0 

func (x *MetastoreServiceConfig) Reset()

func (*MetastoreServiceConfig) String added in v1.50.0 

func (x *MetastoreServiceConfig) String() string

type SalesforceDataCloudProperties added in v1.53.0 

type SalesforceDataCloudProperties struct {

	// The URL to the user's Salesforce DataCloud instance.
	InstanceUri string `protobuf:"bytes,1,opt,name=instance_uri,json=instanceUri,proto3" json:"instance_uri,omitempty"`
	// Output only. A unique Google-owned and Google-generated service account
	// identity for the connection.
	Identity string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"`
	// The ID of the user's Salesforce tenant.
	TenantId string `protobuf:"bytes,3,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	// contains filtered or unexported fields
}

Connection properties specific to Salesforce DataCloud. This is intended for use only by Salesforce partner projects.

func (*SalesforceDataCloudProperties) Descriptor deprecated added in v1.53.0 

func (*SalesforceDataCloudProperties) Descriptor() ([]byte, []int)

Deprecated: Use SalesforceDataCloudProperties.ProtoReflect.Descriptor instead.

func (*SalesforceDataCloudProperties) GetIdentity added in v1.53.0 

func (x *SalesforceDataCloudProperties) GetIdentity() string

func (*SalesforceDataCloudProperties) GetInstanceUri added in v1.53.0 

func (x *SalesforceDataCloudProperties) GetInstanceUri() string

func (*SalesforceDataCloudProperties) GetTenantId added in v1.53.0 

func (x *SalesforceDataCloudProperties) GetTenantId() string

func (*SalesforceDataCloudProperties) ProtoMessage added in v1.53.0 

func (*SalesforceDataCloudProperties) ProtoMessage()

func (*SalesforceDataCloudProperties) ProtoReflect added in v1.53.0 

func (x *SalesforceDataCloudProperties) ProtoReflect() protoreflect.Message

func (*SalesforceDataCloudProperties) Reset added in v1.53.0 

func (x *SalesforceDataCloudProperties) Reset()

func (*SalesforceDataCloudProperties) String added in v1.53.0 

func (x *SalesforceDataCloudProperties) String() string

type SparkHistoryServerConfig added in v1.50.0 

type SparkHistoryServerConfig struct {

	// Optional. Resource name of an existing Dataproc Cluster to act as a Spark
	// History Server for the connection.
	//
	// Example:
	//
	// * `projects/[project_id]/regions/[region]/clusters/[cluster_name]`
	DataprocCluster string `protobuf:"bytes,1,opt,name=dataproc_cluster,json=dataprocCluster,proto3" json:"dataproc_cluster,omitempty"`
	// contains filtered or unexported fields
}

Configuration of the Spark History Server.

func (*SparkHistoryServerConfig) Descriptor deprecated added in v1.50.0 

func (*SparkHistoryServerConfig) Descriptor() ([]byte, []int)

Deprecated: Use SparkHistoryServerConfig.ProtoReflect.Descriptor instead.

func (*SparkHistoryServerConfig) GetDataprocCluster added in v1.50.0 

func (x *SparkHistoryServerConfig) GetDataprocCluster() string

func (*SparkHistoryServerConfig) ProtoMessage added in v1.50.0 

func (*SparkHistoryServerConfig) ProtoMessage()

func (*SparkHistoryServerConfig) ProtoReflect added in v1.50.0 

func (x *SparkHistoryServerConfig) ProtoReflect() protoreflect.Message

func (*SparkHistoryServerConfig) Reset added in v1.50.0 

func (x *SparkHistoryServerConfig) Reset()

func (*SparkHistoryServerConfig) String added in v1.50.0 

func (x *SparkHistoryServerConfig) String() string

type SparkProperties added in v1.50.0 

type SparkProperties struct {

	// 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-<projectnumber>-<uniqueid>@gcp-sa-bigquery-consp.iam.gserviceaccount.com
	ServiceAccountId string `protobuf:"bytes,1,opt,name=service_account_id,json=serviceAccountId,proto3" json:"service_account_id,omitempty"`
	// Optional. Dataproc Metastore Service configuration for the connection.
	MetastoreServiceConfig *MetastoreServiceConfig `` /* 129-byte string literal not displayed */
	// Optional. Spark History Server configuration for the connection.
	SparkHistoryServerConfig *SparkHistoryServerConfig `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

Container for connection properties to execute stored procedures for Apache Spark.

func (*SparkProperties) Descriptor deprecated added in v1.50.0 

func (*SparkProperties) Descriptor() ([]byte, []int)

Deprecated: Use SparkProperties.ProtoReflect.Descriptor instead.

func (*SparkProperties) GetMetastoreServiceConfig added in v1.50.0 

func (x *SparkProperties) GetMetastoreServiceConfig() *MetastoreServiceConfig

func (*SparkProperties) GetServiceAccountId added in v1.50.0 

func (x *SparkProperties) GetServiceAccountId() string

func (*SparkProperties) GetSparkHistoryServerConfig added in v1.50.0 

func (x *SparkProperties) GetSparkHistoryServerConfig() *SparkHistoryServerConfig

func (*SparkProperties) ProtoMessage added in v1.50.0 

func (*SparkProperties) ProtoMessage()

func (*SparkProperties) ProtoReflect added in v1.50.0 

func (x *SparkProperties) ProtoReflect() protoreflect.Message

func (*SparkProperties) Reset added in v1.50.0 

func (x *SparkProperties) Reset()

func (*SparkProperties) String added in v1.50.0 

func (x *SparkProperties) String() string

type UnimplementedConnectionServiceServer 

type UnimplementedConnectionServiceServer struct {
}

UnimplementedConnectionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedConnectionServiceServer) CreateConnection 

func (*UnimplementedConnectionServiceServer) CreateConnection(context.Context, *CreateConnectionRequest) (*Connection, error)

func (*UnimplementedConnectionServiceServer) DeleteConnection 

func (*UnimplementedConnectionServiceServer) DeleteConnection(context.Context, *DeleteConnectionRequest) (*emptypb.Empty, error)

func (*UnimplementedConnectionServiceServer) GetConnection 

func (*UnimplementedConnectionServiceServer) GetConnection(context.Context, *GetConnectionRequest) (*Connection, error)

func (*UnimplementedConnectionServiceServer) GetIamPolicy 

func (*UnimplementedConnectionServiceServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)

func (*UnimplementedConnectionServiceServer) ListConnections 

func (*UnimplementedConnectionServiceServer) ListConnections(context.Context, *ListConnectionsRequest) (*ListConnectionsResponse, error)

func (*UnimplementedConnectionServiceServer) SetIamPolicy 

func (*UnimplementedConnectionServiceServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)

func (*UnimplementedConnectionServiceServer) TestIamPermissions 

func (*UnimplementedConnectionServiceServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)

func (*UnimplementedConnectionServiceServer) UpdateConnection 

func (*UnimplementedConnectionServiceServer) UpdateConnection(context.Context, *UpdateConnectionRequest) (*Connection, error)

type UpdateConnectionRequest 

type UpdateConnectionRequest struct {

	// Required. Name of the connection to update, for example:
	// `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Connection containing the updated fields.
	Connection *Connection `protobuf:"bytes,2,opt,name=connection,proto3" json:"connection,omitempty"`
	// Required. Update mask for the connection fields to be updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The request for [ConnectionService.UpdateConnection][google.cloud.bigquery.connection.v1.ConnectionService.UpdateConnection].

func (*UpdateConnectionRequest) Descriptor deprecated 

func (*UpdateConnectionRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateConnectionRequest.ProtoReflect.Descriptor instead.

func (*UpdateConnectionRequest) GetConnection 

func (x *UpdateConnectionRequest) GetConnection() *Connection

func (*UpdateConnectionRequest) GetName 

func (x *UpdateConnectionRequest) GetName() string

func (*UpdateConnectionRequest) GetUpdateMask 

func (x *UpdateConnectionRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateConnectionRequest) ProtoMessage 

func (*UpdateConnectionRequest) ProtoMessage()

func (*UpdateConnectionRequest) ProtoReflect 

func (x *UpdateConnectionRequest) ProtoReflect() protoreflect.Message

func (*UpdateConnectionRequest) Reset 

func (x *UpdateConnectionRequest) Reset()

func (*UpdateConnectionRequest) String 

func (x *UpdateConnectionRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.