longrunning

Documentation

Overview

Package longrunning is an auto-generated package for the Long Running Operations API.

NOTE: This package is in alpha. It is not stable, and is likely to change.

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 pkg.go.dev/cloud.google.com/go.

Index

• func DefaultAuthScopes() []string
• type OperationIterator
  • func (it *OperationIterator) Next() (*longrunningpb.Operation, error)
  • func (it *OperationIterator) PageInfo() *iterator.PageInfo
• type OperationsCallOptions
• type OperationsClient
  • func InternalFromConn(conn *grpc.ClientConn) *OperationsClient
  • func NewOperationsClient(ctx context.Context, opts ...option.ClientOption) (*OperationsClient, error)
  • func (c *OperationsClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
  • func (c *OperationsClient) Close() error
  • func (c *OperationsClient) Connection() *grpc.ClientConn
  • func (c *OperationsClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
  • func (c *OperationsClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
  • func (c *OperationsClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
  • func (c *OperationsClient) SetGoogleClientInfo(keyval ...string)
  • func (c *OperationsClient) WaitOperation(ctx context.Context, req *longrunningpb.WaitOperationRequest, ...) (*longrunningpb.Operation, error)

Examples

• NewOperationsClient
• OperationsClient.CancelOperation
• OperationsClient.DeleteOperation
• OperationsClient.GetOperation
• OperationsClient.ListOperations
• OperationsClient.WaitOperation

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

Types

type OperationIterator

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

OperationIterator manages a stream of *longrunningpb.Operation.

func (*OperationIterator) Next

func (it *OperationIterator) Next() (*longrunningpb.Operation, 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 (*OperationIterator) PageInfo

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

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

type OperationsCallOptions

type OperationsCallOptions struct {
	ListOperations  []gax.CallOption
	GetOperation    []gax.CallOption
	DeleteOperation []gax.CallOption
	CancelOperation []gax.CallOption
	WaitOperation   []gax.CallOption
}

OperationsCallOptions contains the retry settings for each method of OperationsClient.

type OperationsClient

type OperationsClient struct {

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

OperationsClient is a client for interacting with Long Running Operations API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func InternalFromConn

func InternalFromConn(conn *grpc.ClientConn) *OperationsClient

InternalFromConn is for use by the Google Cloud Libraries only.

Deprecated. Use `NewOperationsClient(ctx, option.WithGRPCConn(conn))` instead.

func NewOperationsClient

func NewOperationsClient(ctx context.Context, opts ...option.ClientOption) (*OperationsClient, error)

NewOperationsClient creates a new operations client.

Manages long-running operations with an API service.

When an API method normally takes long time to complete, it can be designed to return Operation to the client, and the client can use this interface to receive the real response asynchronously by polling the operation resource, or pass the operation resource to another API (such as Google Cloud Pub/Sub API) to receive the response. Any API service that returns long-running operations should implement the Operations interface so developers can have a consistent client experience.

Example

package main

import (
	"context"

	longrunning "cloud.google.com/go/longrunning/autogen"
)

func main() {
	ctx := context.Background()
	c, err := longrunning.NewOperationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use client.
	_ = c
}

func (*OperationsClient) CancelOperation

func (c *OperationsClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error

CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Example

package main

import (
	"context"

	longrunning "cloud.google.com/go/longrunning/autogen"

	longrunningpb "google.golang.org/genproto/googleapis/longrunning"
)

func main() {
	ctx := context.Background()
	c, err := longrunning.NewOperationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &longrunningpb.CancelOperationRequest{
		// TODO: Fill request struct fields.
	}
	err = c.CancelOperation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*OperationsClient) Close

func (c *OperationsClient) Close() error

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

func (*OperationsClient) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*OperationsClient) DeleteOperation

func (c *OperationsClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error

DeleteOperation deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Example

package main

import (
	"context"

	longrunning "cloud.google.com/go/longrunning/autogen"

	longrunningpb "google.golang.org/genproto/googleapis/longrunning"
)

func main() {
	ctx := context.Background()
	c, err := longrunning.NewOperationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &longrunningpb.DeleteOperationRequest{
		// TODO: Fill request struct fields.
	}
	err = c.DeleteOperation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*OperationsClient) GetOperation

func (c *OperationsClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)

GetOperation gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Example

package main

import (
	"context"

	longrunning "cloud.google.com/go/longrunning/autogen"

	longrunningpb "google.golang.org/genproto/googleapis/longrunning"
)

func main() {
	// import longrunningpb "google.golang.org/genproto/googleapis/longrunning"

	ctx := context.Background()
	c, err := longrunning.NewOperationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &longrunningpb.GetOperationRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetOperation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*OperationsClient) ListOperations

func (c *OperationsClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator

ListOperations lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Example

package main

import (
	"context"

	longrunning "cloud.google.com/go/longrunning/autogen"
	"google.golang.org/api/iterator"

	longrunningpb "google.golang.org/genproto/googleapis/longrunning"
)

func main() {
	// import longrunningpb "google.golang.org/genproto/googleapis/longrunning"
	// import "google.golang.org/api/iterator"

	ctx := context.Background()
	c, err := longrunning.NewOperationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &longrunningpb.ListOperationsRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListOperations(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*OperationsClient) SetGoogleClientInfo

func (c *OperationsClient) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Also passes any provided key-value pairs. Intended for use by Google-written clients.

Internal use only.

func (*OperationsClient) WaitOperation

func (c *OperationsClient) WaitOperation(ctx context.Context, req *longrunningpb.WaitOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)

WaitOperation waits for the specified long-running operation until it is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Example

package main

import (
	"context"

	longrunning "cloud.google.com/go/longrunning/autogen"

	longrunningpb "google.golang.org/genproto/googleapis/longrunning"
)

func main() {
	// import longrunningpb "google.golang.org/genproto/googleapis/longrunning"

	ctx := context.Background()
	c, err := longrunning.NewOperationsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &longrunningpb.WaitOperationRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.WaitOperation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}