Eventarc API v1 - Package cloud.google.com/go/eventarc/apiv1 (v1.0.0)

Stay organized with collections Save and categorize content based on your preferences.

Package eventarc is an auto-generated package for the Eventarc API.

Example usage

To get started with this package, create a client.

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

req := &eventarcpb.GetTriggerRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/eventarc/v1#GetTriggerRequest.
}
resp, err := c.GetTrigger(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 {
	GetTrigger    []gax.CallOption
	ListTriggers  []gax.CallOption
	CreateTrigger []gax.CallOption
	UpdateTrigger []gax.CallOption
	DeleteTrigger []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 Eventarc API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations.

func NewClient

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

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

Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations.

Example

package main

import (
	"context"

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

func main() {
	ctx := context.Background()
	c, err := eventarc.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) CreateTrigger

CreateTrigger create a new trigger in a particular project and location.

Example

package main

import (
	"context"

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

	eventarcpb "google.golang.org/genproto/googleapis/cloud/eventarc/v1"
)

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

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

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

func (*Client) CreateTriggerOperation

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

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

func (*Client) DeleteTrigger

DeleteTrigger delete a single trigger.

Example

package main

import (
	"context"

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

	eventarcpb "google.golang.org/genproto/googleapis/cloud/eventarc/v1"
)

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

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

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

func (*Client) DeleteTriggerOperation

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

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

func (*Client) GetTrigger

func (c *Client) GetTrigger(ctx context.Context, req *eventarcpb.GetTriggerRequest, opts ...gax.CallOption) (*eventarcpb.Trigger, error)

GetTrigger get a single trigger.

Example

package main

import (
	"context"

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

	eventarcpb "google.golang.org/genproto/googleapis/cloud/eventarc/v1"
)

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

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

func (*Client) ListTriggers

func (c *Client) ListTriggers(ctx context.Context, req *eventarcpb.ListTriggersRequest, opts ...gax.CallOption) *TriggerIterator

ListTriggers list triggers.

Example

package main

import (
	"context"

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

	eventarcpb "google.golang.org/genproto/googleapis/cloud/eventarc/v1"
)

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

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

func (*Client) UpdateTrigger

UpdateTrigger update a single trigger.

Example

package main

import (
	"context"

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

	eventarcpb "google.golang.org/genproto/googleapis/cloud/eventarc/v1"
)

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

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

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

func (*Client) UpdateTriggerOperation

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

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

CreateTriggerOperation

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

CreateTriggerOperation manages a long-running operation from CreateTrigger.

func (*CreateTriggerOperation) Done

func (op *CreateTriggerOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateTriggerOperation) Metadata

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 (*CreateTriggerOperation) Name

func (op *CreateTriggerOperation) 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 (*CreateTriggerOperation) Poll

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 (*CreateTriggerOperation) Wait

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

See documentation of Poll for error-handling information.

DeleteTriggerOperation

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

DeleteTriggerOperation manages a long-running operation from DeleteTrigger.

func (*DeleteTriggerOperation) Done

func (op *DeleteTriggerOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteTriggerOperation) Metadata

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 (*DeleteTriggerOperation) Name

func (op *DeleteTriggerOperation) 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 (*DeleteTriggerOperation) Poll

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 (*DeleteTriggerOperation) Wait

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

See documentation of Poll for error-handling information.

TriggerIterator

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

TriggerIterator manages a stream of *eventarcpb.Trigger.

func (*TriggerIterator) Next

func (it *TriggerIterator) Next() (*eventarcpb.Trigger, 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 (*TriggerIterator) PageInfo

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

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

UpdateTriggerOperation

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

UpdateTriggerOperation manages a long-running operation from UpdateTrigger.

func (*UpdateTriggerOperation) Done

func (op *UpdateTriggerOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateTriggerOperation) Metadata

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 (*UpdateTriggerOperation) Name

func (op *UpdateTriggerOperation) 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 (*UpdateTriggerOperation) Poll

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 (*UpdateTriggerOperation) Wait

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

See documentation of Poll for error-handling information.