Documentation ¶
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.
Example usage ¶
To get started with this package, create a client.
ctx := context.Background() 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() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#GetDataSourceRequest. } resp, err := c.GetDataSource(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.
Index ¶
- func DataSourcePath(project, dataSource string) stringdeprecated
- func DefaultAuthScopes() []string
- func LocationDataSourcePath(project, location, dataSource string) stringdeprecated
- func LocationPath(project, location string) stringdeprecated
- func LocationRunPath(project, location, transferConfig, run string) stringdeprecated
- func LocationTransferConfigPath(project, location, transferConfig string) stringdeprecated
- func ProjectPath(project string) stringdeprecated
- func RunPath(project, transferConfig, run string) stringdeprecated
- func TransferConfigPath(project, transferConfig string) stringdeprecated
- type CallOptions
- type Client
- func (c *Client) CheckValidCreds(ctx context.Context, req *datatransferpb.CheckValidCredsRequest, ...) (*datatransferpb.CheckValidCredsResponse, error)
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConn
- func (c *Client) CreateTransferConfig(ctx context.Context, req *datatransferpb.CreateTransferConfigRequest, ...) (*datatransferpb.TransferConfig, error)
- func (c *Client) DeleteTransferConfig(ctx context.Context, req *datatransferpb.DeleteTransferConfigRequest, ...) error
- func (c *Client) DeleteTransferRun(ctx context.Context, req *datatransferpb.DeleteTransferRunRequest, ...) error
- func (c *Client) EnrollDataSources(ctx context.Context, req *datatransferpb.EnrollDataSourcesRequest, ...) error
- func (c *Client) GetDataSource(ctx context.Context, req *datatransferpb.GetDataSourceRequest, ...) (*datatransferpb.DataSource, error)
- func (c *Client) GetTransferConfig(ctx context.Context, req *datatransferpb.GetTransferConfigRequest, ...) (*datatransferpb.TransferConfig, error)
- func (c *Client) GetTransferRun(ctx context.Context, req *datatransferpb.GetTransferRunRequest, ...) (*datatransferpb.TransferRun, error)
- func (c *Client) ListDataSources(ctx context.Context, req *datatransferpb.ListDataSourcesRequest, ...) *DataSourceIterator
- func (c *Client) ListTransferConfigs(ctx context.Context, req *datatransferpb.ListTransferConfigsRequest, ...) *TransferConfigIterator
- func (c *Client) ListTransferLogs(ctx context.Context, req *datatransferpb.ListTransferLogsRequest, ...) *TransferMessageIterator
- func (c *Client) ListTransferRuns(ctx context.Context, req *datatransferpb.ListTransferRunsRequest, ...) *TransferRunIterator
- func (c *Client) ScheduleTransferRuns(ctx context.Context, req *datatransferpb.ScheduleTransferRunsRequest, ...) (*datatransferpb.ScheduleTransferRunsResponse, error)deprecated
- func (c *Client) StartManualTransferRuns(ctx context.Context, req *datatransferpb.StartManualTransferRunsRequest, ...) (*datatransferpb.StartManualTransferRunsResponse, error)
- func (c *Client) UpdateTransferConfig(ctx context.Context, req *datatransferpb.UpdateTransferConfigRequest, ...) (*datatransferpb.TransferConfig, error)
- type DataSourceIterator
- type TransferConfigIterator
- type TransferMessageIterator
- type TransferRunIterator
Examples ¶
- Client.CheckValidCreds
- Client.CreateTransferConfig
- Client.DeleteTransferConfig
- Client.DeleteTransferRun
- Client.EnrollDataSources
- Client.GetDataSource
- Client.GetTransferConfig
- Client.GetTransferRun
- Client.ListDataSources
- Client.ListTransferConfigs
- Client.ListTransferLogs
- Client.ListTransferRuns
- Client.ScheduleTransferRuns
- Client.StartManualTransferRuns
- Client.UpdateTransferConfig
- NewClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DataSourcePath
deprecated
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
func LocationDataSourcePath
deprecated
func LocationPath
deprecated
func LocationRunPath
deprecated
func LocationTransferConfigPath
deprecated
func ProjectPath
deprecated
func TransferConfigPath
deprecated
Types ¶
type CallOptions ¶
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 }
CallOptions contains the retry settings for each method of Client.
type 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 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.
func NewClient ¶
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" ) func main() { ctx := context.Background() c, err := datatransfer.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#CheckValidCredsRequest. } resp, err := c.CheckValidCreds(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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) 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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#CreateTransferConfigRequest. } resp, err := c.CreateTransferConfig(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#DeleteTransferConfigRequest. } err = c.DeleteTransferConfig(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteTransferRun ¶
func (c *Client) DeleteTransferRun(ctx context.Context, req *datatransferpb.DeleteTransferRunRequest, opts ...gax.CallOption) error
DeleteTransferRun deletes the specified transfer run.
Example ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#DeleteTransferRunRequest. } err = c.DeleteTransferRun(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) EnrollDataSources ¶ added in v1.28.0
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 ‘https://bigquery.cloud.google.com (at https://bigquery.cloud.google.com)’ (and the documents can be found at https://cloud.google.com/bigquery/bigquery-web-ui (at https://cloud.google.com/bigquery/bigquery-web-ui) and https://cloud.google.com/bigquery/docs/working-with-transfers (at https://cloud.google.com/bigquery/docs/working-with-transfers)).
Example ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#EnrollDataSourcesRequest. } err = c.EnrollDataSources(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#GetDataSourceRequest. } resp, err := c.GetDataSource(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#GetTransferConfigRequest. } resp, err := c.GetTransferConfig(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#GetTransferRunRequest. } resp, err := c.GetTransferRun(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" "google.golang.org/api/iterator" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#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 } }
Output:
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" "google.golang.org/api/iterator" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#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 } }
Output:
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" "google.golang.org/api/iterator" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#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 } }
Output:
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" "google.golang.org/api/iterator" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#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 } }
Output:
func (*Client) ScheduleTransferRuns
deprecated
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#ScheduleTransferRunsRequest. } resp, err := c.ScheduleTransferRuns(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#StartManualTransferRunsRequest. } resp, err := c.StartManualTransferRuns(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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 ¶
package main import ( "context" datatransfer "cloud.google.com/go/bigquery/datatransfer/apiv1" datatransferpb "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1" ) func main() { ctx := context.Background() 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/google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1#UpdateTransferConfigRequest. } resp, err := c.UpdateTransferConfig(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
type DataSourceIterator ¶
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 }
DataSourceIterator manages a stream of *datatransferpb.DataSource.
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 TransferConfigIterator ¶
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 }
TransferConfigIterator manages a stream of *datatransferpb.TransferConfig.
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 ¶
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 }
TransferMessageIterator manages a stream of *datatransferpb.TransferMessage.
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 ¶
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 }
TransferRunIterator manages a stream of *datatransferpb.TransferRun.
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.