- 1.64.0 (latest)
- 1.63.1
- 1.62.0
- 1.61.0
- 1.60.0
- 1.59.1
- 1.58.0
- 1.57.1
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.2
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.1
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.2
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.1
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
Package connection is an auto-generated package for the BigQuery Connection API.
Allows users to manage BigQuery connections to external data sources.
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/v1#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
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
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 (
"context"
connection "cloud.google.com/go/bigquery/connection/apiv1"
)
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
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
func (c *Client) CreateConnection(ctx context.Context, req *connectionpb.CreateConnectionRequest, opts ...gax.CallOption) (*connectionpb.Connection, error)
CreateConnection creates a new connection.
Example
package main
import (
"context"
connection "cloud.google.com/go/bigquery/connection/apiv1"
connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1"
)
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/v1#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 (
"context"
connection "cloud.google.com/go/bigquery/connection/apiv1"
connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1"
)
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/v1#DeleteConnectionRequest.
}
err = c.DeleteConnection(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) GetConnection
func (c *Client) GetConnection(ctx context.Context, req *connectionpb.GetConnectionRequest, opts ...gax.CallOption) (*connectionpb.Connection, error)
GetConnection returns specified connection.
Example
package main
import (
"context"
connection "cloud.google.com/go/bigquery/connection/apiv1"
connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1"
)
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/v1#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 (
"context"
connection "cloud.google.com/go/bigquery/connection/apiv1"
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
func (c *Client) ListConnections(ctx context.Context, req *connectionpb.ListConnectionsRequest, opts ...gax.CallOption) *ConnectionIterator
ListConnections returns a list of connections in the given project.
Example
package main
import (
"context"
connection "cloud.google.com/go/bigquery/connection/apiv1"
"google.golang.org/api/iterator"
connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1"
)
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/v1#ListConnectionsRequest.
}
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
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.
Example
package main
import (
"context"
connection "cloud.google.com/go/bigquery/connection/apiv1"
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
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.
Example
package main
import (
"context"
connection "cloud.google.com/go/bigquery/connection/apiv1"
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
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.
Example
package main
import (
"context"
connection "cloud.google.com/go/bigquery/connection/apiv1"
connectionpb "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1"
)
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/v1#UpdateConnectionRequest.
}
resp, err := c.UpdateConnection(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
ConnectionIterator
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
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
func (it *ConnectionIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.