Package cloud.google.com/go/bigquery/connection/apiv1/connectionpb (v1.45.0)

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,
	}
)

var File_google_cloud_bigquery_connection_v1_connection_proto protoreflect.FileDescriptor

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

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
}

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

func (x *AwsAccessRole) GetIamRoleId() string

func (x *AwsAccessRole) GetIdentity() string

func (*AwsAccessRole) ProtoMessage()

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

func (x *AwsAccessRole) Reset()

func (x *AwsAccessRole) String() string

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
}

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

func (x *AwsCrossAccountRole) GetExternalId() string

func (x *AwsCrossAccountRole) GetIamRoleId() string

func (x *AwsCrossAccountRole) GetIamUserId() string

func (*AwsCrossAccountRole) ProtoMessage()

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

func (x *AwsCrossAccountRole) Reset()

func (x *AwsCrossAccountRole) String() string

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
}

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

func (x *AwsProperties) GetAccessRole() *AwsAccessRole

func (m *AwsProperties) GetAuthenticationMethod() isAwsProperties_AuthenticationMethod

func (x *AwsProperties) GetCrossAccountRole() *AwsCrossAccountRole

func (*AwsProperties) ProtoMessage()

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

func (x *AwsProperties) Reset()

func (x *AwsProperties) String() string

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 struct {
	// Authentication using Google owned AWS IAM user's access key to assume
	// into customer's AWS IAM Role.
	// Deprecated, do not use.
	//
	// Deprecated: Do not use.
	CrossAccountRole *AwsCrossAccountRole `protobuf:"bytes,2,opt,name=cross_account_role,json=crossAccountRole,proto3,oneof"`
}

type AzureProperties struct {
	Application string `protobuf:"bytes,1,opt,name=application,proto3" json:"application,omitempty"`

	ClientId string `protobuf:"bytes,2,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`

	ObjectId string `protobuf:"bytes,3,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`

	CustomerTenantId string `protobuf:"bytes,4,opt,name=customer_tenant_id,json=customerTenantId,proto3" json:"customer_tenant_id,omitempty"`

	RedirectUri string `protobuf:"bytes,5,opt,name=redirect_uri,json=redirectUri,proto3" json:"redirect_uri,omitempty"`

	FederatedApplicationClientId string "" /* 149 byte string literal not displayed */

	Identity string `protobuf:"bytes,7,opt,name=identity,proto3" json:"identity,omitempty"`

}

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

func (x *AzureProperties) GetApplication() string

func (x *AzureProperties) GetClientId() string

func (x *AzureProperties) GetCustomerTenantId() string

func (x *AzureProperties) GetFederatedApplicationClientId() string

func (x *AzureProperties) GetIdentity() string

func (x *AzureProperties) GetObjectId() string

func (x *AzureProperties) GetRedirectUri() string

func (*AzureProperties) ProtoMessage()

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

func (x *AzureProperties) Reset()

func (x *AzureProperties) String() string

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:
	//
	//	

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

func (x *CloudResourceProperties) GetServiceAccountId() string

func (*CloudResourceProperties) ProtoMessage()

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

func (x *CloudResourceProperties) Reset()

func (x *CloudResourceProperties) String() string

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"`
	// contains filtered or unexported fields
}

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

func (x *CloudSpannerProperties) GetDatabase() string

func (x *CloudSpannerProperties) GetUseParallelism() bool

func (*CloudSpannerProperties) ProtoMessage()

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

func (x *CloudSpannerProperties) Reset()

func (x *CloudSpannerProperties) String() string

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
}

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

func (x *CloudSqlCredential) GetPassword() string

func (x *CloudSqlCredential) GetUsername() string

func (*CloudSqlCredential) ProtoMessage()

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

func (x *CloudSqlCredential) Reset()

func (x *CloudSqlCredential) String() string

type CloudSqlProperties struct {
	InstanceId string `protobuf:"bytes,1,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`

	Database string `protobuf:"bytes,2,opt,name=database,proto3" json:"database,omitempty"`

	Type CloudSqlProperties_DatabaseType "" /* 135 byte string literal not displayed */

	Credential *CloudSqlCredential `protobuf:"bytes,4,opt,name=credential,proto3" json:"credential,omitempty"`

	ServiceAccountId string `protobuf:"bytes,5,opt,name=service_account_id,json=serviceAccountId,proto3" json:"service_account_id,omitempty"`

}

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

func (x *CloudSqlProperties) GetCredential() *CloudSqlCredential

func (x *CloudSqlProperties) GetDatabase() string

func (x *CloudSqlProperties) GetInstanceId() string

func (x *CloudSqlProperties) GetServiceAccountId() string

func (x *CloudSqlProperties) GetType() CloudSqlProperties_DatabaseType

func (*CloudSqlProperties) ProtoMessage()

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

func (x *CloudSqlProperties) Reset()

func (x *CloudSqlProperties) String() string

type CloudSqlProperties_DatabaseType int32

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() protoreflect.EnumDescriptor

func (x CloudSqlProperties_DatabaseType) Enum() *CloudSqlProperties_DatabaseType

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

func (x CloudSqlProperties_DatabaseType) Number() protoreflect.EnumNumber

func (x CloudSqlProperties_DatabaseType) String() string

func (CloudSqlProperties_DatabaseType) Type() protoreflect.EnumType

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
	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
}

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

func (x *Connection) GetAws() *AwsProperties

func (x *Connection) GetAzure() *AzureProperties

func (x *Connection) GetCloudResource() *CloudResourceProperties

func (x *Connection) GetCloudSpanner() *CloudSpannerProperties

func (x *Connection) GetCloudSql() *CloudSqlProperties

func (x *Connection) GetCreationTime() int64

func (x *Connection) GetDescription() string

func (x *Connection) GetFriendlyName() string

func (x *Connection) GetHasCredential() bool

func (x *Connection) GetLastModifiedTime() int64

func (x *Connection) GetName() string

func (m *Connection) GetProperties() isConnection_Properties

func (*Connection) ProtoMessage()

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

func (x *Connection) Reset()

func (x *Connection) String() string

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 *v1.GetIamPolicyRequest, opts ...grpc.CallOption) (*v1.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 *v1.SetIamPolicyRequest, opts ...grpc.CallOption) (*v1.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 *v1.TestIamPermissionsRequest, opts ...grpc.CallOption) (*v1.TestIamPermissionsResponse, error)
}

func NewConnectionServiceClient(cc grpc.ClientConnInterface) ConnectionServiceClient

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, *v1.GetIamPolicyRequest) (*v1.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, *v1.SetIamPolicyRequest) (*v1.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, *v1.TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, error)
}

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

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

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

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

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

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
}

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

func (x *CreateConnectionRequest) GetConnection() *Connection

func (x *CreateConnectionRequest) GetConnectionId() string

func (x *CreateConnectionRequest) GetParent() string

func (*CreateConnectionRequest) ProtoMessage()

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

func (x *CreateConnectionRequest) Reset()

func (x *CreateConnectionRequest) String() string

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
}

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

func (x *DeleteConnectionRequest) GetName() string

func (*DeleteConnectionRequest) ProtoMessage()

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

func (x *DeleteConnectionRequest) Reset()

func (x *DeleteConnectionRequest) String() string

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
}

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

func (x *GetConnectionRequest) GetName() string

func (*GetConnectionRequest) ProtoMessage()

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

func (x *GetConnectionRequest) Reset()

func (x *GetConnectionRequest) String() string

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
}

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

func (x *ListConnectionsRequest) GetPageSize() int32

func (x *ListConnectionsRequest) GetPageToken() string

func (x *ListConnectionsRequest) GetParent() string

func (*ListConnectionsRequest) ProtoMessage()

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

func (x *ListConnectionsRequest) Reset()

func (x *ListConnectionsRequest) String() string

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
}

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

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

func (x *ListConnectionsResponse) GetNextPageToken() string

func (*ListConnectionsResponse) ProtoMessage()

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

func (x *ListConnectionsResponse) Reset()

func (x *ListConnectionsResponse) String() string

type UnimplementedConnectionServiceServer struct {
}

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

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

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

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

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

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

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

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

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
}

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

func (x *UpdateConnectionRequest) GetConnection() *Connection

func (x *UpdateConnectionRequest) GetName() string

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

func (*UpdateConnectionRequest) ProtoMessage()

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

func (x *UpdateConnectionRequest) Reset()

func (x *UpdateConnectionRequest) String() string