Storage Transfer API v1 - Package cloud.google.com/go/storagetransfer/apiv1 (v1.1.0)

Version 1.1.0

• 1.12.0 (latest)
• 1.11.2
• 1.10.11
• 1.9.1
• 1.8.1
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.1.0

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Package storagetransfer is an auto-generated package for the Storage Transfer API.

Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.

Example usage

To get started with this package, create a client.

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

req := &storagetransferpb.GetGoogleServiceAccountRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/storagetransfer/v1#GetGoogleServiceAccountRequest.
}
resp, err := c.GetGoogleServiceAccount(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 {
	GetGoogleServiceAccount []gax.CallOption
	CreateTransferJob       []gax.CallOption
	UpdateTransferJob       []gax.CallOption
	GetTransferJob          []gax.CallOption
	ListTransferJobs        []gax.CallOption
	PauseTransferOperation  []gax.CallOption
	ResumeTransferOperation []gax.CallOption
	RunTransferJob          []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

Client

type Client struct {

	// The call options for this service.
	CallOptions *CallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

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

Storage Transfer Service and its protos. Transfers data between between Google Cloud Storage buckets or from a data source external to Google to a Cloud Storage bucket.

func NewClient

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

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

Storage Transfer Service and its protos. Transfers data between between Google Cloud Storage buckets or from a data source external to Google to a Cloud Storage bucket.

Example

package main

import (
	"context"

	storagetransfer "cloud.google.com/go/storagetransfer/apiv1"
)

func main() {
	ctx := context.Background()
	c, err := storagetransfer.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

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.

func (*Client) CreateTransferJob

func (c *Client) CreateTransferJob(ctx context.Context, req *storagetransferpb.CreateTransferJobRequest, opts ...gax.CallOption) (*storagetransferpb.TransferJob, error)

CreateTransferJob creates a transfer job that runs periodically.

Example

package main

import (
	"context"

	storagetransfer "cloud.google.com/go/storagetransfer/apiv1"

	storagetransferpb "google.golang.org/genproto/googleapis/storagetransfer/v1"
)

func main() {
	ctx := context.Background()
	c, err := storagetransfer.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &storagetransferpb.CreateTransferJobRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/storagetransfer/v1#CreateTransferJobRequest.
	}
	resp, err := c.CreateTransferJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) GetGoogleServiceAccount

func (c *Client) GetGoogleServiceAccount(ctx context.Context, req *storagetransferpb.GetGoogleServiceAccountRequest, opts ...gax.CallOption) (*storagetransferpb.GoogleServiceAccount, error)

GetGoogleServiceAccount returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Cloud Platform Console project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.

Example

package main

import (
	"context"

	storagetransfer "cloud.google.com/go/storagetransfer/apiv1"

	storagetransferpb "google.golang.org/genproto/googleapis/storagetransfer/v1"
)

func main() {
	ctx := context.Background()
	c, err := storagetransfer.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &storagetransferpb.GetGoogleServiceAccountRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/storagetransfer/v1#GetGoogleServiceAccountRequest.
	}
	resp, err := c.GetGoogleServiceAccount(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) GetTransferJob

func (c *Client) GetTransferJob(ctx context.Context, req *storagetransferpb.GetTransferJobRequest, opts ...gax.CallOption) (*storagetransferpb.TransferJob, error)

GetTransferJob gets a transfer job.

Example

package main

import (
	"context"

	storagetransfer "cloud.google.com/go/storagetransfer/apiv1"

	storagetransferpb "google.golang.org/genproto/googleapis/storagetransfer/v1"
)

func main() {
	ctx := context.Background()
	c, err := storagetransfer.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &storagetransferpb.GetTransferJobRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/storagetransfer/v1#GetTransferJobRequest.
	}
	resp, err := c.GetTransferJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) ListTransferJobs

func (c *Client) ListTransferJobs(ctx context.Context, req *storagetransferpb.ListTransferJobsRequest, opts ...gax.CallOption) *TransferJobIterator

ListTransferJobs lists transfer jobs.

Example

package main

import (
	"context"

	storagetransfer "cloud.google.com/go/storagetransfer/apiv1"
	"google.golang.org/api/iterator"

	storagetransferpb "google.golang.org/genproto/googleapis/storagetransfer/v1"
)

func main() {
	ctx := context.Background()
	c, err := storagetransfer.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

func (*Client) PauseTransferOperation

func (c *Client) PauseTransferOperation(ctx context.Context, req *storagetransferpb.PauseTransferOperationRequest, opts ...gax.CallOption) error

PauseTransferOperation pauses a transfer operation.

Example

package main

import (
	"context"

	storagetransfer "cloud.google.com/go/storagetransfer/apiv1"

	storagetransferpb "google.golang.org/genproto/googleapis/storagetransfer/v1"
)

func main() {
	ctx := context.Background()
	c, err := storagetransfer.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &storagetransferpb.PauseTransferOperationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/storagetransfer/v1#PauseTransferOperationRequest.
	}
	err = c.PauseTransferOperation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*Client) ResumeTransferOperation

func (c *Client) ResumeTransferOperation(ctx context.Context, req *storagetransferpb.ResumeTransferOperationRequest, opts ...gax.CallOption) error

ResumeTransferOperation resumes a transfer operation that is paused.

Example

package main

import (
	"context"

	storagetransfer "cloud.google.com/go/storagetransfer/apiv1"

	storagetransferpb "google.golang.org/genproto/googleapis/storagetransfer/v1"
)

func main() {
	ctx := context.Background()
	c, err := storagetransfer.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &storagetransferpb.ResumeTransferOperationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/storagetransfer/v1#ResumeTransferOperationRequest.
	}
	err = c.ResumeTransferOperation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*Client) RunTransferJob

func (c *Client) RunTransferJob(ctx context.Context, req *storagetransferpb.RunTransferJobRequest, opts ...gax.CallOption) (*RunTransferJobOperation, error)

RunTransferJob attempts to start a new TransferOperation for the current TransferJob. A TransferJob has a maximum of one active TransferOperation. If this method is called while a TransferOperation is active, an error wil be returned.

Example

package main

import (
	"context"

	storagetransfer "cloud.google.com/go/storagetransfer/apiv1"

	storagetransferpb "google.golang.org/genproto/googleapis/storagetransfer/v1"
)

func main() {
	ctx := context.Background()
	c, err := storagetransfer.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &storagetransferpb.RunTransferJobRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/storagetransfer/v1#RunTransferJobRequest.
	}
	op, err := c.RunTransferJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*Client) RunTransferJobOperation

func (c *Client) RunTransferJobOperation(name string) *RunTransferJobOperation

RunTransferJobOperation returns a new RunTransferJobOperation from a given name. The name must be that of a previously created RunTransferJobOperation, possibly from a different process.

func (*Client) UpdateTransferJob

func (c *Client) UpdateTransferJob(ctx context.Context, req *storagetransferpb.UpdateTransferJobRequest, opts ...gax.CallOption) (*storagetransferpb.TransferJob, error)

UpdateTransferJob updates a transfer job. Updating a job’s transfer spec does not affect transfer operations that are running already.

Note: The job’s status field can be modified using this RPC (for example, to set a job’s status to DELETED, DISABLED, or ENABLED).

Example

package main

import (
	"context"

	storagetransfer "cloud.google.com/go/storagetransfer/apiv1"

	storagetransferpb "google.golang.org/genproto/googleapis/storagetransfer/v1"
)

func main() {
	ctx := context.Background()
	c, err := storagetransfer.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &storagetransferpb.UpdateTransferJobRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/storagetransfer/v1#UpdateTransferJobRequest.
	}
	resp, err := c.UpdateTransferJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

RunTransferJobOperation

type RunTransferJobOperation struct {
	// contains filtered or unexported fields
}

RunTransferJobOperation manages a long-running operation from RunTransferJob.

func (*RunTransferJobOperation) Done

func (op *RunTransferJobOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RunTransferJobOperation) Metadata

func (op *RunTransferJobOperation) Metadata() (*storagetransferpb.TransferOperation, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*RunTransferJobOperation) Name

func (op *RunTransferJobOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*RunTransferJobOperation) Poll

func (op *RunTransferJobOperation) Poll(ctx context.Context, opts ...gax.CallOption) error

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*RunTransferJobOperation) Wait

func (op *RunTransferJobOperation) Wait(ctx context.Context, opts ...gax.CallOption) error

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

TransferJobIterator

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

TransferJobIterator manages a stream of *storagetransferpb.TransferJob.

func (*TransferJobIterator) Next

func (it *TransferJobIterator) Next() (*storagetransferpb.TransferJob, 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 (*TransferJobIterator) PageInfo

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

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