...
▽

Package datatransfer

import "cloud.google.com/go/bigquery/datatransfer/apiv1"
Overview
Index
Examples
Subdirectories

Overview ▾

Package datatransfer is an auto-generated package for the BigQuery Data Transfer API.

Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.

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. 

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 := datatransfer.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()
// 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 := datatransfer.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.CheckValidCredsRequest{
	// TODO: Fill request struct fields.
	// See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#CheckValidCredsRequest.
}
resp, err := c.CheckValidCreds(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.

Index ▾

func DataSourcePath(project, dataSource string) string
func DefaultAuthScopes() []string
func LocationDataSourcePath(project, location, dataSource string) string
func LocationPath(project, location string) string
func LocationRunPath(project, location, transferConfig, run string) string
func LocationTransferConfigPath(project, location, transferConfig string) string
func ProjectPath(project string) string
func RunPath(project, transferConfig, run string) string
func TransferConfigPath(project, transferConfig string) string
type CallOptions
type Client
    func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
    func NewRESTClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
    func (c *Client) CheckValidCreds(ctx context.Context, req *datatransferpb.CheckValidCredsRequest, opts ...gax.CallOption) (*datatransferpb.CheckValidCredsResponse, error)
    func (c *Client) Close() error
    func (c *Client) Connection() *grpc.ClientConn
    func (c *Client) CreateTransferConfig(ctx context.Context, req *datatransferpb.CreateTransferConfigRequest, opts ...gax.CallOption) (*datatransferpb.TransferConfig, error)
    func (c *Client) DeleteTransferConfig(ctx context.Context, req *datatransferpb.DeleteTransferConfigRequest, opts ...gax.CallOption) error
    func (c *Client) DeleteTransferRun(ctx context.Context, req *datatransferpb.DeleteTransferRunRequest, opts ...gax.CallOption) error
    func (c *Client) EnrollDataSources(ctx context.Context, req *datatransferpb.EnrollDataSourcesRequest, opts ...gax.CallOption) error
    func (c *Client) GetDataSource(ctx context.Context, req *datatransferpb.GetDataSourceRequest, opts ...gax.CallOption) (*datatransferpb.DataSource, error)
    func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
    func (c *Client) GetTransferConfig(ctx context.Context, req *datatransferpb.GetTransferConfigRequest, opts ...gax.CallOption) (*datatransferpb.TransferConfig, error)
    func (c *Client) GetTransferRun(ctx context.Context, req *datatransferpb.GetTransferRunRequest, opts ...gax.CallOption) (*datatransferpb.TransferRun, error)
    func (c *Client) ListDataSources(ctx context.Context, req *datatransferpb.ListDataSourcesRequest, opts ...gax.CallOption) *DataSourceIterator
    func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
    func (c *Client) ListTransferConfigs(ctx context.Context, req *datatransferpb.ListTransferConfigsRequest, opts ...gax.CallOption) *TransferConfigIterator
    func (c *Client) ListTransferLogs(ctx context.Context, req *datatransferpb.ListTransferLogsRequest, opts ...gax.CallOption) *TransferMessageIterator
    func (c *Client) ListTransferRuns(ctx context.Context, req *datatransferpb.ListTransferRunsRequest, opts ...gax.CallOption) *TransferRunIterator
    func (c *Client) ScheduleTransferRuns(ctx context.Context, req *datatransferpb.ScheduleTransferRunsRequest, opts ...gax.CallOption) (*datatransferpb.ScheduleTransferRunsResponse, error)
    func (c *Client) StartManualTransferRuns(ctx context.Context, req *datatransferpb.StartManualTransferRunsRequest, opts ...gax.CallOption) (*datatransferpb.StartManualTransferRunsResponse, error)
    func (c *Client) UnenrollDataSources(ctx context.Context, req *datatransferpb.UnenrollDataSourcesRequest, opts ...gax.CallOption) error
    func (c *Client) UpdateTransferConfig(ctx context.Context, req *datatransferpb.UpdateTransferConfigRequest, opts ...gax.CallOption) (*datatransferpb.TransferConfig, error)
type DataSourceIterator
    func (it *DataSourceIterator) Next() (*datatransferpb.DataSource, error)
    func (it *DataSourceIterator) PageInfo() *iterator.PageInfo
type LocationIterator
    func (it *LocationIterator) Next() (*locationpb.Location, error)
    func (it *LocationIterator) PageInfo() *iterator.PageInfo
type TransferConfigIterator
    func (it *TransferConfigIterator) Next() (*datatransferpb.TransferConfig, error)
    func (it *TransferConfigIterator) PageInfo() *iterator.PageInfo
type TransferMessageIterator
    func (it *TransferMessageIterator) Next() (*datatransferpb.TransferMessage, error)
    func (it *TransferMessageIterator) PageInfo() *iterator.PageInfo
type TransferRunIterator
    func (it *TransferRunIterator) Next() (*datatransferpb.TransferRun, error)
    func (it *TransferRunIterator) PageInfo() *iterator.PageInfo

Package files

auxiliary.go data_transfer_client.go doc.go path_funcs.go version.go

func DataSourcePath 

func DataSourcePath(project, dataSource string) string

DataSourcePath returns the path for the data source resource.

Deprecated: Use 

fmt.Sprintf("projects/%s/dataSources/%s", project, dataSource)

instead.

func DefaultAuthScopes 

func DefaultAuthScopes() []string

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

func LocationDataSourcePath 

func LocationDataSourcePath(project, location, dataSource string) string

LocationDataSourcePath returns the path for the location data source resource.

Deprecated: Use 

fmt.Sprintf("projects/%s/locations/%s/dataSources/%s", project, location, dataSource)

instead.

func LocationPath 

func LocationPath(project, location string) string

LocationPath returns the path for the location resource.

Deprecated: Use 

fmt.Sprintf("projects/%s/locations/%s", project, location)

instead.

func LocationRunPath 

func LocationRunPath(project, location, transferConfig, run string) string

LocationRunPath returns the path for the location run resource.

Deprecated: Use 

fmt.Sprintf("projects/%s/locations/%s/transferConfigs/%s/runs/%s", project, location, transferConfig, run)

instead.

func LocationTransferConfigPath 

func LocationTransferConfigPath(project, location, transferConfig string) string

LocationTransferConfigPath returns the path for the location transfer config resource.

Deprecated: Use 

fmt.Sprintf("projects/%s/locations/%s/transferConfigs/%s", project, location, transferConfig)

instead.

func ProjectPath 

func ProjectPath(project string) string

ProjectPath returns the path for the project resource.

Deprecated: Use 

fmt.Sprintf("projects/%s", project)

instead.

func RunPath 

func RunPath(project, transferConfig, run string) string

RunPath returns the path for the run resource.

Deprecated: Use 

fmt.Sprintf("projects/%s/transferConfigs/%s/runs/%s", project, transferConfig, run)

instead.

func TransferConfigPath 

func TransferConfigPath(project, transferConfig string) string

TransferConfigPath returns the path for the transfer config resource.

Deprecated: Use 

fmt.Sprintf("projects/%s/transferConfigs/%s", project, transferConfig)

instead.

type CallOptions

CallOptions contains the retry settings for each method of Client. 

type CallOptions struct {
    GetDataSource           []gax.CallOption
    ListDataSources         []gax.CallOption
    CreateTransferConfig    []gax.CallOption
    UpdateTransferConfig    []gax.CallOption
    DeleteTransferConfig    []gax.CallOption
    GetTransferConfig       []gax.CallOption
    ListTransferConfigs     []gax.CallOption
    ScheduleTransferRuns    []gax.CallOption
    StartManualTransferRuns []gax.CallOption
    GetTransferRun          []gax.CallOption
    DeleteTransferRun       []gax.CallOption
    ListTransferRuns        []gax.CallOption
    ListTransferLogs        []gax.CallOption
    CheckValidCreds         []gax.CallOption
    EnrollDataSources       []gax.CallOption
    UnenrollDataSources     []gax.CallOption
    GetLocation             []gax.CallOption
    ListLocations           []gax.CallOption
}

type Client

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

This API allows users to manage their data transfers into BigQuery. 

type Client struct {

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

func NewClient 

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

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

This API allows users to manage their data transfers into BigQuery.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

// TODO: Use client.
_ = c

func NewRESTClient 

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

NewRESTClient creates a new data transfer service rest client.

This API allows users to manage their data transfers into BigQuery.

▾ Example

Code:

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 := datatransfer.NewRESTClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

// TODO: Use client.
_ = c

func (*Client) CheckValidCreds 

func (c *Client) CheckValidCreds(ctx context.Context, req *datatransferpb.CheckValidCredsRequest, opts ...gax.CallOption) (*datatransferpb.CheckValidCredsResponse, error)

CheckValidCreds returns true if valid credentials exist for the given data source and requesting user.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.CheckValidCredsRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#CheckValidCredsRequest.
}
resp, err := c.CheckValidCreds(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

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: Connections are now pooled so this method does not always return the same resource.

func (*Client) CreateTransferConfig 

func (c *Client) CreateTransferConfig(ctx context.Context, req *datatransferpb.CreateTransferConfigRequest, opts ...gax.CallOption) (*datatransferpb.TransferConfig, error)

CreateTransferConfig creates a new data transfer configuration.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.CreateTransferConfigRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#CreateTransferConfigRequest.
}
resp, err := c.CreateTransferConfig(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) DeleteTransferConfig 

func (c *Client) DeleteTransferConfig(ctx context.Context, req *datatransferpb.DeleteTransferConfigRequest, opts ...gax.CallOption) error

DeleteTransferConfig deletes a data transfer configuration, including any associated transfer runs and logs.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.DeleteTransferConfigRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#DeleteTransferConfigRequest.
}
err = c.DeleteTransferConfig(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*Client) DeleteTransferRun 

func (c *Client) DeleteTransferRun(ctx context.Context, req *datatransferpb.DeleteTransferRunRequest, opts ...gax.CallOption) error

DeleteTransferRun deletes the specified transfer run.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.DeleteTransferRunRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#DeleteTransferRunRequest.
}
err = c.DeleteTransferRun(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*Client) EnrollDataSources 

func (c *Client) EnrollDataSources(ctx context.Context, req *datatransferpb.EnrollDataSourcesRequest, opts ...gax.CallOption) error

EnrollDataSources enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI (at https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for BigQuery Web UI (at https://cloud.google.com/bigquery/bigquery-web-ui) and Data Transfer Service (at https://cloud.google.com/bigquery/docs/working-with-transfers).

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.EnrollDataSourcesRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#EnrollDataSourcesRequest.
}
err = c.EnrollDataSources(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*Client) GetDataSource 

func (c *Client) GetDataSource(ctx context.Context, req *datatransferpb.GetDataSourceRequest, opts ...gax.CallOption) (*datatransferpb.DataSource, error)

GetDataSource retrieves a supported data source and returns its settings.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.GetDataSourceRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#GetDataSourceRequest.
}
resp, err := c.GetDataSource(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) GetLocation 

func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)

GetLocation gets information about a location.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &locationpb.GetLocationRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
}
resp, err := c.GetLocation(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) GetTransferConfig 

func (c *Client) GetTransferConfig(ctx context.Context, req *datatransferpb.GetTransferConfigRequest, opts ...gax.CallOption) (*datatransferpb.TransferConfig, error)

GetTransferConfig returns information about a data transfer config.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.GetTransferConfigRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#GetTransferConfigRequest.
}
resp, err := c.GetTransferConfig(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) GetTransferRun 

func (c *Client) GetTransferRun(ctx context.Context, req *datatransferpb.GetTransferRunRequest, opts ...gax.CallOption) (*datatransferpb.TransferRun, error)

GetTransferRun returns information about the particular transfer run.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.GetTransferRunRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#GetTransferRunRequest.
}
resp, err := c.GetTransferRun(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) ListDataSources 

func (c *Client) ListDataSources(ctx context.Context, req *datatransferpb.ListDataSourcesRequest, opts ...gax.CallOption) *DataSourceIterator

ListDataSources lists supported data sources and returns their settings.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.ListDataSourcesRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#ListDataSourcesRequest.
}
it := c.ListDataSources(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp

    // If you need to access the underlying RPC response,
    // you can do so by casting the `Response` as below.
    // Otherwise, remove this line. Only populated after
    // first call to Next(). Not safe for concurrent access.
    _ = it.Response.(*datatransferpb.ListDataSourcesResponse)
}

func (*Client) ListLocations 

func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator

ListLocations lists information about the supported locations for this service.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &locationpb.ListLocationsRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
it := c.ListLocations(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp

    // If you need to access the underlying RPC response,
    // you can do so by casting the `Response` as below.
    // Otherwise, remove this line. Only populated after
    // first call to Next(). Not safe for concurrent access.
    _ = it.Response.(*locationpb.ListLocationsResponse)
}

func (*Client) ListTransferConfigs 

func (c *Client) ListTransferConfigs(ctx context.Context, req *datatransferpb.ListTransferConfigsRequest, opts ...gax.CallOption) *TransferConfigIterator

ListTransferConfigs returns information about all transfer configs owned by a project in the specified location.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.ListTransferConfigsRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#ListTransferConfigsRequest.
}
it := c.ListTransferConfigs(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp

    // If you need to access the underlying RPC response,
    // you can do so by casting the `Response` as below.
    // Otherwise, remove this line. Only populated after
    // first call to Next(). Not safe for concurrent access.
    _ = it.Response.(*datatransferpb.ListTransferConfigsResponse)
}

func (*Client) ListTransferLogs 

func (c *Client) ListTransferLogs(ctx context.Context, req *datatransferpb.ListTransferLogsRequest, opts ...gax.CallOption) *TransferMessageIterator

ListTransferLogs returns log messages for the transfer run.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.ListTransferLogsRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#ListTransferLogsRequest.
}
it := c.ListTransferLogs(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp

    // If you need to access the underlying RPC response,
    // you can do so by casting the `Response` as below.
    // Otherwise, remove this line. Only populated after
    // first call to Next(). Not safe for concurrent access.
    _ = it.Response.(*datatransferpb.ListTransferLogsResponse)
}

func (*Client) ListTransferRuns 

func (c *Client) ListTransferRuns(ctx context.Context, req *datatransferpb.ListTransferRunsRequest, opts ...gax.CallOption) *TransferRunIterator

ListTransferRuns returns information about running and completed transfer runs.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.ListTransferRunsRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#ListTransferRunsRequest.
}
it := c.ListTransferRuns(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp

    // If you need to access the underlying RPC response,
    // you can do so by casting the `Response` as below.
    // Otherwise, remove this line. Only populated after
    // first call to Next(). Not safe for concurrent access.
    _ = it.Response.(*datatransferpb.ListTransferRunsResponse)
}

func (*Client) ScheduleTransferRuns 

func (c *Client) ScheduleTransferRuns(ctx context.Context, req *datatransferpb.ScheduleTransferRunsRequest, opts ...gax.CallOption) (*datatransferpb.ScheduleTransferRunsResponse, error)

ScheduleTransferRuns creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

Deprecated: ScheduleTransferRuns may be removed in a future version.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.ScheduleTransferRunsRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#ScheduleTransferRunsRequest.
}
resp, err := c.ScheduleTransferRuns(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) StartManualTransferRuns 

func (c *Client) StartManualTransferRuns(ctx context.Context, req *datatransferpb.StartManualTransferRunsRequest, opts ...gax.CallOption) (*datatransferpb.StartManualTransferRunsResponse, error)

StartManualTransferRuns start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.StartManualTransferRunsRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#StartManualTransferRunsRequest.
}
resp, err := c.StartManualTransferRuns(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) UnenrollDataSources 

func (c *Client) UnenrollDataSources(ctx context.Context, req *datatransferpb.UnenrollDataSourcesRequest, opts ...gax.CallOption) error

UnenrollDataSources unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the BigQuery UI (at https://console.cloud.google.com/bigquery). Data transfers configurations of unenrolled data sources will not be scheduled.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.UnenrollDataSourcesRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#UnenrollDataSourcesRequest.
}
err = c.UnenrollDataSources(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*Client) UpdateTransferConfig 

func (c *Client) UpdateTransferConfig(ctx context.Context, req *datatransferpb.UpdateTransferConfigRequest, opts ...gax.CallOption) (*datatransferpb.TransferConfig, error)

UpdateTransferConfig updates a data transfer configuration. All fields must be set, even if they are not updated.

▾ Example

Code:

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 := datatransfer.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &datatransferpb.UpdateTransferConfigRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb#UpdateTransferConfigRequest.
}
resp, err := c.UpdateTransferConfig(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

type DataSourceIterator

DataSourceIterator manages a stream of *datatransferpb.DataSource. 

type DataSourceIterator 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 []*datatransferpb.DataSource, nextPageToken string, err error)
    // contains filtered or unexported fields
}

func (*DataSourceIterator) Next 

func (it *DataSourceIterator) Next() (*datatransferpb.DataSource, 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 (*DataSourceIterator) PageInfo 

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

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

type LocationIterator

LocationIterator manages a stream of *locationpb.Location. 

type LocationIterator 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 []*locationpb.Location, nextPageToken string, err error)
    // contains filtered or unexported fields
}

func (*LocationIterator) Next 

func (it *LocationIterator) Next() (*locationpb.Location, 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 (*LocationIterator) PageInfo 

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

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

type TransferConfigIterator

TransferConfigIterator manages a stream of *datatransferpb.TransferConfig. 

type TransferConfigIterator 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 []*datatransferpb.TransferConfig, nextPageToken string, err error)
    // contains filtered or unexported fields
}

func (*TransferConfigIterator) Next 

func (it *TransferConfigIterator) Next() (*datatransferpb.TransferConfig, 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 (*TransferConfigIterator) PageInfo 

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

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

type TransferMessageIterator

TransferMessageIterator manages a stream of *datatransferpb.TransferMessage. 

type TransferMessageIterator 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 []*datatransferpb.TransferMessage, nextPageToken string, err error)
    // contains filtered or unexported fields
}

func (*TransferMessageIterator) Next 

func (it *TransferMessageIterator) Next() (*datatransferpb.TransferMessage, 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 (*TransferMessageIterator) PageInfo 

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

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

type TransferRunIterator

TransferRunIterator manages a stream of *datatransferpb.TransferRun. 

type TransferRunIterator 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 []*datatransferpb.TransferRun, nextPageToken string, err error)
    // contains filtered or unexported fields
}

func (*TransferRunIterator) Next 

func (it *TransferRunIterator) Next() (*datatransferpb.TransferRun, 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 (*TransferRunIterator) PageInfo 

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

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

Subdirectories

Name Synopsis
..
datatransferpb