go: cloud.google.com/go/bigquery/connection/apiv1 Index | Examples | Files

package connection

import "cloud.google.com/go/bigquery/connection/apiv1"

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

Allows users to manage BigQuery connections to external data sources.

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 pkg.go.dev/cloud.google.com/go.

Index

Examples

Package Files

connection_client.go doc.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

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

type CallOptions Uses

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

CallOptions contains the retry settings for each method of Client.

type Client Uses

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.

func NewClient Uses

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

NewClient creates a new connection service client.

Manages external data source connections and credentials.

Code:

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

func (*Client) Close Uses

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 Uses

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

Connection returns a connection to the API service.

Deprecated.

func (*Client) CreateConnection Uses

func (c *Client) CreateConnection(ctx context.Context, req *connectionpb.CreateConnectionRequest, opts ...gax.CallOption) (*connectionpb.Connection, error)

CreateConnection creates a new connection.

Code:

// import connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1"

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

req := &connectionpb.CreateConnectionRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.CreateConnection(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) DeleteConnection Uses

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

DeleteConnection deletes connection and associated credential.

Code:

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

req := &connectionpb.DeleteConnectionRequest{
    // TODO: Fill request struct fields.
}
err = c.DeleteConnection(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*Client) GetConnection Uses

func (c *Client) GetConnection(ctx context.Context, req *connectionpb.GetConnectionRequest, opts ...gax.CallOption) (*connectionpb.Connection, error)

GetConnection returns specified connection.

Code:

// import connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1"

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

req := &connectionpb.GetConnectionRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.GetConnection(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) GetIamPolicy Uses

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.

Code:

// import iampb "google.golang.org/genproto/googleapis/iam/v1"

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

req := &iampb.GetIamPolicyRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.GetIamPolicy(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) ListConnections Uses

func (c *Client) ListConnections(ctx context.Context, req *connectionpb.ListConnectionsRequest, opts ...gax.CallOption) *ConnectionIterator

ListConnections returns a list of connections in the given project.

Code:

// import connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1"
// import "google.golang.org/api/iterator"

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

req := &connectionpb.ListConnectionsRequest{
    // TODO: Fill request struct fields.
}
it := c.ListConnections(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*Client) SetIamPolicy Uses

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 NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Code:

// import iampb "google.golang.org/genproto/googleapis/iam/v1"

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

req := &iampb.SetIamPolicyRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.SetIamPolicy(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) TestIamPermissions Uses

func (c *Client) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)

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.

Code:

// import iampb "google.golang.org/genproto/googleapis/iam/v1"

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

req := &iampb.TestIamPermissionsRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.TestIamPermissions(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) UpdateConnection Uses

func (c *Client) UpdateConnection(ctx context.Context, req *connectionpb.UpdateConnectionRequest, opts ...gax.CallOption) (*connectionpb.Connection, error)

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

Code:

// import connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1"

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

req := &connectionpb.UpdateConnectionRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.UpdateConnection(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

type ConnectionIterator Uses

type ConnectionIterator struct {

    // Response is the raw response for the current page.
    // It must be cast to the RPC response type.
    // Calling Next() or InternalFetch() updates this value.
    Response interface{}

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*connectionpb.Connection, nextPageToken string, err error)
    // contains filtered or unexported fields
}

ConnectionIterator manages a stream of *connectionpb.Connection.

func (*ConnectionIterator) Next Uses

func (it *ConnectionIterator) Next() (*connectionpb.Connection, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*ConnectionIterator) PageInfo Uses

func (it *ConnectionIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

Package connection imports 21 packages (graph) and is imported by 1 packages. Updated 2021-01-26. Refresh now. Tools for package owners.