BigQuery Storage API v1alpha - Package cloud.google.com/go/bigquery/storage/apiv1alpha (v1.66.2)

Package storage is an auto-generated package for the BigQuery Storage API.

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

General documentation

For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/bigquery/storage/apiv1alpha@latest
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := storage.NewMetastorePartitionClient(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, mentioned above.

req := &storagepb.BatchCreateMetastorePartitionsRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/storage/apiv1alpha/storagepb#BatchCreateMetastorePartitionsRequest.
}
resp, err := c.BatchCreateMetastorePartitions(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewMetastorePartitionClient 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.

Functions

func DefaultAuthScopes 

func DefaultAuthScopes() []string

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

MetastorePartitionCallOptions

type MetastorePartitionCallOptions struct {
	BatchCreateMetastorePartitions []gax.CallOption
	BatchDeleteMetastorePartitions []gax.CallOption
	BatchUpdateMetastorePartitions []gax.CallOption
	ListMetastorePartitions        []gax.CallOption
	StreamMetastorePartitions      []gax.CallOption
}

MetastorePartitionCallOptions contains the retry settings for each method of MetastorePartitionClient.

MetastorePartitionClient

type MetastorePartitionClient struct {

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

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

BigQuery Metastore Partition Service API. This service is used for managing metastore partitions in BigQuery metastore. The service supports only batch operations for write.

func NewMetastorePartitionClient 

func NewMetastorePartitionClient(ctx context.Context, opts ...option.ClientOption) (*MetastorePartitionClient, error)

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

BigQuery Metastore Partition Service API. This service is used for managing metastore partitions in BigQuery metastore. The service supports only batch operations for write.

Example

package main

import (
	"context"

	storage "cloud.google.com/go/bigquery/storage/apiv1alpha"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := storage.NewMetastorePartitionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*MetastorePartitionClient) BatchCreateMetastorePartitions 

func (c *MetastorePartitionClient) BatchCreateMetastorePartitions(ctx context.Context, req *storagepb.BatchCreateMetastorePartitionsRequest, opts ...gax.CallOption) (*storagepb.BatchCreateMetastorePartitionsResponse, error)

BatchCreateMetastorePartitions adds metastore partitions to a table.

Example

package main

import (
	"context"

	storage "cloud.google.com/go/bigquery/storage/apiv1alpha"
	storagepb "cloud.google.com/go/bigquery/storage/apiv1alpha/storagepb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := storage.NewMetastorePartitionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &storagepb.BatchCreateMetastorePartitionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigquery/storage/apiv1alpha/storagepb#BatchCreateMetastorePartitionsRequest.
	}
	resp, err := c.BatchCreateMetastorePartitions(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*MetastorePartitionClient) BatchDeleteMetastorePartitions 

func (c *MetastorePartitionClient) BatchDeleteMetastorePartitions(ctx context.Context, req *storagepb.BatchDeleteMetastorePartitionsRequest, opts ...gax.CallOption) error

BatchDeleteMetastorePartitions deletes metastore partitions from a table.

Example

package main

import (
	"context"

	storage "cloud.google.com/go/bigquery/storage/apiv1alpha"
	storagepb "cloud.google.com/go/bigquery/storage/apiv1alpha/storagepb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := storage.NewMetastorePartitionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &storagepb.BatchDeleteMetastorePartitionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigquery/storage/apiv1alpha/storagepb#BatchDeleteMetastorePartitionsRequest.
	}
	err = c.BatchDeleteMetastorePartitions(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*MetastorePartitionClient) BatchUpdateMetastorePartitions 

func (c *MetastorePartitionClient) BatchUpdateMetastorePartitions(ctx context.Context, req *storagepb.BatchUpdateMetastorePartitionsRequest, opts ...gax.CallOption) (*storagepb.BatchUpdateMetastorePartitionsResponse, error)

BatchUpdateMetastorePartitions updates metastore partitions in a table.

Example

package main

import (
	"context"

	storage "cloud.google.com/go/bigquery/storage/apiv1alpha"
	storagepb "cloud.google.com/go/bigquery/storage/apiv1alpha/storagepb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := storage.NewMetastorePartitionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &storagepb.BatchUpdateMetastorePartitionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigquery/storage/apiv1alpha/storagepb#BatchUpdateMetastorePartitionsRequest.
	}
	resp, err := c.BatchUpdateMetastorePartitions(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*MetastorePartitionClient) Close 

func (c *MetastorePartitionClient) Close() error

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

func (*MetastorePartitionClient) Connection (deprecated)

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

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not always return the same resource.

func (*MetastorePartitionClient) ListMetastorePartitions 

func (c *MetastorePartitionClient) ListMetastorePartitions(ctx context.Context, req *storagepb.ListMetastorePartitionsRequest, opts ...gax.CallOption) (*storagepb.ListMetastorePartitionsResponse, error)

ListMetastorePartitions gets metastore partitions from a table.

Example

package main

import (
	"context"

	storage "cloud.google.com/go/bigquery/storage/apiv1alpha"
	storagepb "cloud.google.com/go/bigquery/storage/apiv1alpha/storagepb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := storage.NewMetastorePartitionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &storagepb.ListMetastorePartitionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigquery/storage/apiv1alpha/storagepb#ListMetastorePartitionsRequest.
	}
	resp, err := c.ListMetastorePartitions(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*MetastorePartitionClient) StreamMetastorePartitions 

func (c *MetastorePartitionClient) StreamMetastorePartitions(ctx context.Context, opts ...gax.CallOption) (storagepb.MetastorePartitionService_StreamMetastorePartitionsClient, error)

StreamMetastorePartitions this is a bi-di streaming rpc method that allows the client to send a stream of partitions and commit all of them atomically at the end. If the commit is successful, the server will return a response and close the stream. If the commit fails (due to duplicate partitions or other reason), the server will close the stream with an error. This method is only available via the gRPC API (not REST).

Example

package main

import (
	"context"
	"io"

	storage "cloud.google.com/go/bigquery/storage/apiv1alpha"
	storagepb "cloud.google.com/go/bigquery/storage/apiv1alpha/storagepb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := storage.NewMetastorePartitionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()
	stream, err := c.StreamMetastorePartitions(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	go func() {
		reqs := []*storagepb.StreamMetastorePartitionsRequest{
			// TODO: Create requests.
		}
		for _, req := range reqs {
			if err := stream.Send(req); err != nil {
				// TODO: Handle error.
			}
		}
		stream.CloseSend()
	}()
	for {
		resp, err := stream.Recv()
		if err == io.EOF {
			break
		}
		if err != nil {
			// TODO: handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}