bqconn

package
v0.0.0-...-1782b29 Latest Latest
Warning

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

 Go to latest Published: Mar 31, 2020 License: MIT Imports: 14 Imported by: 0

Documentation

Overview

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 godoc.org/cloud.google.com/go.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes 

func DefaultAuthScopes() []string

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

Types

type ConnectionCallOptions 

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

ConnectionCallOptions contains the retry settings for each method of ConnectionClient.

type ConnectionClient 

type ConnectionClient struct {

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

ConnectionClient is a client for interacting with .

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewConnectionClient 

func NewConnectionClient(ctx context.Context, opts ...option.ClientOption) (*ConnectionClient, error)

NewConnectionClient creates a new connection service client.

Manages external data source connections and credentials.

Example 
package main

import (
	"context"

	bqconn "github.com/tmc/mkbigqueryconn/bqconn"
)

func main() {
	ctx := context.Background()
	c, err := bqconn.NewConnectionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use client.
	_ = c
}

Output:

func (*ConnectionClient) Close 

func (c *ConnectionClient) Close() error

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

func (*ConnectionClient) Connection 

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

Connection returns a connection to the API service.

Deprecated.

func (*ConnectionClient) CreateConnection 

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

CreateConnection creates a new connection.

Example 
package main

import (
	"context"

	bqconn "github.com/tmc/mkbigqueryconn/bqconn"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	// import connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"

	ctx := context.Background()
	c, err := bqconn.NewConnectionClient(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
}

Output:

func (*ConnectionClient) DeleteConnection 

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

DeleteConnection deletes connection and associated credential.

Example 
package main

import (
	"context"

	bqconn "github.com/tmc/mkbigqueryconn/bqconn"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	ctx := context.Background()
	c, err := bqconn.NewConnectionClient(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.
	}
}

Output:

func (*ConnectionClient) GetConnection 

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

GetConnection returns specified connection.

Example 
package main

import (
	"context"

	bqconn "github.com/tmc/mkbigqueryconn/bqconn"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	// import connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"

	ctx := context.Background()
	c, err := bqconn.NewConnectionClient(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
}

Output:

func (*ConnectionClient) GetIamPolicy 

func (c *ConnectionClient) 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 (
	"context"

	bqconn "github.com/tmc/mkbigqueryconn/bqconn"

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

func main() {
	// import iampb "google.golang.org/genproto/googleapis/iam/v1"

	ctx := context.Background()
	c, err := bqconn.NewConnectionClient(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
}

Output:

func (*ConnectionClient) ListConnections 

func (c *ConnectionClient) ListConnections(ctx context.Context, req *connectionpb.ListConnectionsRequest, opts ...gax.CallOption) (*connectionpb.ListConnectionsResponse, error)

ListConnections returns a list of connections in the given project.

Example 
package main

import (
	"context"

	bqconn "github.com/tmc/mkbigqueryconn/bqconn"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	// import connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"

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

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

Output:

func (*ConnectionClient) SetIamPolicy 

func (c *ConnectionClient) 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 (
	"context"

	bqconn "github.com/tmc/mkbigqueryconn/bqconn"

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

func main() {
	// import iampb "google.golang.org/genproto/googleapis/iam/v1"

	ctx := context.Background()
	c, err := bqconn.NewConnectionClient(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
}

Output:

func (*ConnectionClient) TestIamPermissions 

func (c *ConnectionClient) 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.

Example 
package main

import (
	"context"

	bqconn "github.com/tmc/mkbigqueryconn/bqconn"

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

func main() {
	// import iampb "google.golang.org/genproto/googleapis/iam/v1"

	ctx := context.Background()
	c, err := bqconn.NewConnectionClient(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
}

Output:

func (*ConnectionClient) UpdateConnection 

func (c *ConnectionClient) 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.

Example 
package main

import (
	"context"

	bqconn "github.com/tmc/mkbigqueryconn/bqconn"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	// import connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"

	ctx := context.Background()
	c, err := bqconn.NewConnectionClient(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
}

Output:

func (*ConnectionClient) UpdateConnectionCredential 

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

UpdateConnectionCredential sets the credential for the specified connection.

Example 
package main

import (
	"context"

	bqconn "github.com/tmc/mkbigqueryconn/bqconn"
	connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1"
)

func main() {
	ctx := context.Background()
	c, err := bqconn.NewConnectionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

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

Output:

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.