eventarc

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 3, 2022 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

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.golang.ir/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.golang.ir/cloud.google.com/go.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes 

func DefaultAuthScopes() []string

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

Types

type CallOptions 

type CallOptions struct {
	GetTrigger              []gax.CallOption
	ListTriggers            []gax.CallOption
	CreateTrigger           []gax.CallOption
	UpdateTrigger           []gax.CallOption
	DeleteTrigger           []gax.CallOption
	GetChannel              []gax.CallOption
	ListChannels            []gax.CallOption
	CreateChannel           []gax.CallOption
	UpdateChannel           []gax.CallOption
	DeleteChannel           []gax.CallOption
	GetChannelConnection    []gax.CallOption
	ListChannelConnections  []gax.CallOption
	CreateChannelConnection []gax.CallOption
	DeleteChannelConnection []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

type ChannelConnectionIterator added in v1.2.0 

type ChannelConnectionIterator 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.ChannelConnection, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ChannelConnectionIterator manages a stream of *eventarcpb.ChannelConnection.

func (*ChannelConnectionIterator) Next added in v1.2.0 

func (it *ChannelConnectionIterator) Next() (*eventarcpb.ChannelConnection, 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 (*ChannelConnectionIterator) PageInfo added in v1.2.0 

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

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

type ChannelIterator added in v1.2.0 

type ChannelIterator 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.Channel, nextPageToken string, err error)
	// contains filtered or unexported fields
}

ChannelIterator manages a stream of *eventarcpb.Channel.

func (*ChannelIterator) Next added in v1.2.0 

func (it *ChannelIterator) Next() (*eventarcpb.Channel, 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 (*ChannelIterator) PageInfo added in v1.2.0 

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

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

type 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
}

Output:

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) CreateChannel added in v1.2.0 

func (c *Client) CreateChannel(ctx context.Context, req *eventarcpb.CreateChannelRequest, opts ...gax.CallOption) (*CreateChannelOperation, error)

CreateChannel create a new channel 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.CreateChannelRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/google.golang.org/genproto/googleapis/cloud/eventarc/v1#CreateChannelRequest.
	}
	op, err := c.CreateChannel(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

Output:

func (*Client) CreateChannelConnection added in v1.2.0 

func (c *Client) CreateChannelConnection(ctx context.Context, req *eventarcpb.CreateChannelConnectionRequest, opts ...gax.CallOption) (*CreateChannelConnectionOperation, error)

CreateChannelConnection create a new ChannelConnection 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.CreateChannelConnectionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/google.golang.org/genproto/googleapis/cloud/eventarc/v1#CreateChannelConnectionRequest.
	}
	op, err := c.CreateChannelConnection(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

Output:

func (*Client) CreateChannelConnectionOperation added in v1.2.0 

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

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

func (*Client) CreateChannelOperation added in v1.2.0 

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

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

func (*Client) CreateTrigger 

func (c *Client) CreateTrigger(ctx context.Context, req *eventarcpb.CreateTriggerRequest, opts ...gax.CallOption) (*CreateTriggerOperation, error)

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.golang.ir/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
}

Output:

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) DeleteChannel added in v1.2.0 

func (c *Client) DeleteChannel(ctx context.Context, req *eventarcpb.DeleteChannelRequest, opts ...gax.CallOption) (*DeleteChannelOperation, error)

DeleteChannel delete a single channel.

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.DeleteChannelRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/google.golang.org/genproto/googleapis/cloud/eventarc/v1#DeleteChannelRequest.
	}
	op, err := c.DeleteChannel(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

Output:

func (*Client) DeleteChannelConnection added in v1.2.0 

func (c *Client) DeleteChannelConnection(ctx context.Context, req *eventarcpb.DeleteChannelConnectionRequest, opts ...gax.CallOption) (*DeleteChannelConnectionOperation, error)

DeleteChannelConnection delete a single ChannelConnection.

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.DeleteChannelConnectionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/google.golang.org/genproto/googleapis/cloud/eventarc/v1#DeleteChannelConnectionRequest.
	}
	op, err := c.DeleteChannelConnection(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

Output:

func (*Client) DeleteChannelConnectionOperation added in v1.2.0 

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

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

func (*Client) DeleteChannelOperation added in v1.2.0 

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

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

func (*Client) DeleteTrigger 

func (c *Client) DeleteTrigger(ctx context.Context, req *eventarcpb.DeleteTriggerRequest, opts ...gax.CallOption) (*DeleteTriggerOperation, error)

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.golang.ir/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
}

Output:

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) GetChannel added in v1.2.0 

func (c *Client) GetChannel(ctx context.Context, req *eventarcpb.GetChannelRequest, opts ...gax.CallOption) (*eventarcpb.Channel, error)

GetChannel get a single Channel.

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.GetChannelRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/google.golang.org/genproto/googleapis/cloud/eventarc/v1#GetChannelRequest.
	}
	resp, err := c.GetChannel(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Output:

func (*Client) GetChannelConnection added in v1.2.0 

func (c *Client) GetChannelConnection(ctx context.Context, req *eventarcpb.GetChannelConnectionRequest, opts ...gax.CallOption) (*eventarcpb.ChannelConnection, error)

GetChannelConnection get a single ChannelConnection.

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.GetChannelConnectionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/google.golang.org/genproto/googleapis/cloud/eventarc/v1#GetChannelConnectionRequest.
	}
	resp, err := c.GetChannelConnection(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Output:

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.golang.ir/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
}

Output:

func (*Client) ListChannelConnections added in v1.2.0 

func (c *Client) ListChannelConnections(ctx context.Context, req *eventarcpb.ListChannelConnectionsRequest, opts ...gax.CallOption) *ChannelConnectionIterator

ListChannelConnections list channel connections.

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.ListChannelConnectionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/google.golang.org/genproto/googleapis/cloud/eventarc/v1#ListChannelConnectionsRequest.
	}
	it := c.ListChannelConnections(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) ListChannels added in v1.2.0 

func (c *Client) ListChannels(ctx context.Context, req *eventarcpb.ListChannelsRequest, opts ...gax.CallOption) *ChannelIterator

ListChannels list channels.

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.ListChannelsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/google.golang.org/genproto/googleapis/cloud/eventarc/v1#ListChannelsRequest.
	}
	it := c.ListChannels(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) 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.golang.ir/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
	}
}

Output:

func (*Client) UpdateChannel added in v1.2.0 

func (c *Client) UpdateChannel(ctx context.Context, req *eventarcpb.UpdateChannelRequest, opts ...gax.CallOption) (*UpdateChannelOperation, error)

UpdateChannel update a single channel.

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.UpdateChannelRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/google.golang.org/genproto/googleapis/cloud/eventarc/v1#UpdateChannelRequest.
	}
	op, err := c.UpdateChannel(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

Output:

func (*Client) UpdateChannelOperation added in v1.2.0 

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

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

func (*Client) UpdateTrigger 

func (c *Client) UpdateTrigger(ctx context.Context, req *eventarcpb.UpdateTriggerRequest, opts ...gax.CallOption) (*UpdateTriggerOperation, error)

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.golang.ir/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
}

Output:

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.

type CreateChannelConnectionOperation added in v1.2.0 

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

CreateChannelConnectionOperation manages a long-running operation from CreateChannelConnection.

func (*CreateChannelConnectionOperation) Done added in v1.2.0 

func (op *CreateChannelConnectionOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateChannelConnectionOperation) Metadata added in v1.2.0 

func (op *CreateChannelConnectionOperation) Metadata() (*eventarcpb.OperationMetadata, 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 (*CreateChannelConnectionOperation) Name added in v1.2.0 

func (op *CreateChannelConnectionOperation) 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 (*CreateChannelConnectionOperation) Poll added in v1.2.0 

func (op *CreateChannelConnectionOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.ChannelConnection, 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 (*CreateChannelConnectionOperation) Wait added in v1.2.0 

func (op *CreateChannelConnectionOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.ChannelConnection, 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.

type CreateChannelOperation added in v1.2.0 

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

CreateChannelOperation manages a long-running operation from CreateChannel.

func (*CreateChannelOperation) Done added in v1.2.0 

func (op *CreateChannelOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateChannelOperation) Metadata added in v1.2.0 

func (op *CreateChannelOperation) Metadata() (*eventarcpb.OperationMetadata, 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 (*CreateChannelOperation) Name added in v1.2.0 

func (op *CreateChannelOperation) 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 (*CreateChannelOperation) Poll added in v1.2.0 

func (op *CreateChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Channel, 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 (*CreateChannelOperation) Wait added in v1.2.0 

func (op *CreateChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Channel, 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.

type 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 

func (op *CreateTriggerOperation) Metadata() (*eventarcpb.OperationMetadata, 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 (*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 

func (op *CreateTriggerOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Trigger, 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 (*CreateTriggerOperation) Wait 

func (op *CreateTriggerOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Trigger, 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.

type DeleteChannelConnectionOperation added in v1.2.0 

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

DeleteChannelConnectionOperation manages a long-running operation from DeleteChannelConnection.

func (*DeleteChannelConnectionOperation) Done added in v1.2.0 

func (op *DeleteChannelConnectionOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteChannelConnectionOperation) Metadata added in v1.2.0 

func (op *DeleteChannelConnectionOperation) Metadata() (*eventarcpb.OperationMetadata, 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 (*DeleteChannelConnectionOperation) Name added in v1.2.0 

func (op *DeleteChannelConnectionOperation) 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 (*DeleteChannelConnectionOperation) Poll added in v1.2.0 

func (op *DeleteChannelConnectionOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.ChannelConnection, 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 (*DeleteChannelConnectionOperation) Wait added in v1.2.0 

func (op *DeleteChannelConnectionOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.ChannelConnection, 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.

type DeleteChannelOperation added in v1.2.0 

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

DeleteChannelOperation manages a long-running operation from DeleteChannel.

func (*DeleteChannelOperation) Done added in v1.2.0 

func (op *DeleteChannelOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteChannelOperation) Metadata added in v1.2.0 

func (op *DeleteChannelOperation) Metadata() (*eventarcpb.OperationMetadata, 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 (*DeleteChannelOperation) Name added in v1.2.0 

func (op *DeleteChannelOperation) 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 (*DeleteChannelOperation) Poll added in v1.2.0 

func (op *DeleteChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Channel, 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 (*DeleteChannelOperation) Wait added in v1.2.0 

func (op *DeleteChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Channel, 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.

type 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 

func (op *DeleteTriggerOperation) Metadata() (*eventarcpb.OperationMetadata, 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 (*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 

func (op *DeleteTriggerOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Trigger, 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 (*DeleteTriggerOperation) Wait 

func (op *DeleteTriggerOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Trigger, 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.

type 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.

type UpdateChannelOperation added in v1.2.0 

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

UpdateChannelOperation manages a long-running operation from UpdateChannel.

func (*UpdateChannelOperation) Done added in v1.2.0 

func (op *UpdateChannelOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateChannelOperation) Metadata added in v1.2.0 

func (op *UpdateChannelOperation) Metadata() (*eventarcpb.OperationMetadata, 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 (*UpdateChannelOperation) Name added in v1.2.0 

func (op *UpdateChannelOperation) 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 (*UpdateChannelOperation) Poll added in v1.2.0 

func (op *UpdateChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Channel, 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 (*UpdateChannelOperation) Wait added in v1.2.0 

func (op *UpdateChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Channel, 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.

type 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 

func (op *UpdateTriggerOperation) Metadata() (*eventarcpb.OperationMetadata, 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 (*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 

func (op *UpdateTriggerOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Trigger, 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 (*UpdateTriggerOperation) Wait 

func (op *UpdateTriggerOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*eventarcpb.Trigger, 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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.