BigQuery Connection API v1beta1 - Package cloud.google.com/go/bigquery/connection/apiv1beta1 (v1.28.0)

Stay organized with collections Save and categorize content based on your preferences.

Package connection is an auto-generated package for the BigQuery Connection API.

Allows users to manage BigQuery connections to external data sources.

NOTE: This package is in beta. It is not stable, and may be subject to changes.

Example usage

To get started with this package, create a client.

ctx := context.Background()
c, err := connection.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client.

ctx := context.Background()
c, err := connection.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &connectionpb.CreateConnectionRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1#CreateConnectionRequest.
}
resp, err := c.CreateConnection(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

CallOptions

type CallOptions struct {
	CreateConnection           []gax.CallOption
	GetConnection              []gax.CallOption
	ListConnections            []gax.CallOption
	UpdateConnection           []gax.CallOption
	UpdateConnectionCredential []gax.CallOption
	DeleteConnection           []gax.CallOption
	GetIamPolicy               []gax.CallOption
	SetIamPolicy               []gax.CallOption
	TestIamPermissions         []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

Client

type Client struct {

	// The call options for this service.
	CallOptions *CallOptions
	// contains filtered or unexported fields
}

Client is a client for interacting with BigQuery Connection API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Manages external data source connections and credentials.

func NewClient

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new connection service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Manages external data source connections and credentials.

Example

package main

import (
	connection "cloud.google.com/go/bigquery/connection/apiv1beta1"
	"context"
)

func main() {
	ctx := context.Background()
	c, err := connection.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*Client) Close

func (c *Client) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*Client) Connection

func (c *Client) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*Client) CreateConnection

CreateConnection creates a new connection.

Example

package main

import (
	connection "cloud.google.com/go/bigquery/connection/apiv1beta1"
	"context"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	ctx := context.Background()
	c, err := connection.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &connectionpb.CreateConnectionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1#CreateConnectionRequest.
	}
	resp, err := c.CreateConnection(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) DeleteConnection

func (c *Client) DeleteConnection(ctx context.Context, req *connectionpb.DeleteConnectionRequest, opts ...gax.CallOption) error

DeleteConnection deletes connection and associated credential.

Example

package main

import (
	connection "cloud.google.com/go/bigquery/connection/apiv1beta1"
	"context"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	ctx := context.Background()
	c, err := connection.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &connectionpb.DeleteConnectionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1#DeleteConnectionRequest.
	}
	err = c.DeleteConnection(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*Client) GetConnection

GetConnection returns specified connection.

Example

package main

import (
	connection "cloud.google.com/go/bigquery/connection/apiv1beta1"
	"context"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	ctx := context.Background()
	c, err := connection.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &connectionpb.GetConnectionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1#GetConnectionRequest.
	}
	resp, err := c.GetConnection(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) GetIamPolicy

func (c *Client) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

GetIamPolicy gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Example

package main

import (
	connection "cloud.google.com/go/bigquery/connection/apiv1beta1"
	"context"
	iampb "google.golang.org/genproto/googleapis/iam/v1"
)

func main() {
	ctx := context.Background()
	c, err := connection.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &iampb.GetIamPolicyRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/iam/v1#GetIamPolicyRequest.
	}
	resp, err := c.GetIamPolicy(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) ListConnections

ListConnections returns a list of connections in the given project.

Example

package main

import (
	connection "cloud.google.com/go/bigquery/connection/apiv1beta1"
	"context"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	ctx := context.Background()
	c, err := connection.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &connectionpb.ListConnectionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1#ListConnectionsRequest.
	}
	resp, err := c.ListConnections(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) SetIamPolicy

func (c *Client) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

SetIamPolicy sets the access control policy on the specified resource. Replaces any existing policy.

Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Example

package main

import (
	connection "cloud.google.com/go/bigquery/connection/apiv1beta1"
	"context"
	iampb "google.golang.org/genproto/googleapis/iam/v1"
)

func main() {
	ctx := context.Background()
	c, err := connection.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &iampb.SetIamPolicyRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/iam/v1#SetIamPolicyRequest.
	}
	resp, err := c.SetIamPolicy(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) TestIamPermissions

TestIamPermissions 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.

Example

package main

import (
	connection "cloud.google.com/go/bigquery/connection/apiv1beta1"
	"context"
	iampb "google.golang.org/genproto/googleapis/iam/v1"
)

func main() {
	ctx := context.Background()
	c, err := connection.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &iampb.TestIamPermissionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/iam/v1#TestIamPermissionsRequest.
	}
	resp, err := c.TestIamPermissions(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) UpdateConnection

UpdateConnection updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

Example

package main

import (
	connection "cloud.google.com/go/bigquery/connection/apiv1beta1"
	"context"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	ctx := context.Background()
	c, err := connection.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &connectionpb.UpdateConnectionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1#UpdateConnectionRequest.
	}
	resp, err := c.UpdateConnection(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) UpdateConnectionCredential

func (c *Client) UpdateConnectionCredential(ctx context.Context, req *connectionpb.UpdateConnectionCredentialRequest, opts ...gax.CallOption) error

UpdateConnectionCredential sets the credential for the specified connection.

Example

package main

import (
	connection "cloud.google.com/go/bigquery/connection/apiv1beta1"
	"context"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	ctx := context.Background()
	c, err := connection.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &connectionpb.UpdateConnectionCredentialRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1#UpdateConnectionCredentialRequest.
	}
	err = c.UpdateConnectionCredential(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}