Package cloud.google.com/go/datastream/apiv1alpha1 (v0.91.1)

Package datastream is an auto-generated package for the Datastream 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 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 {
	ListConnectionProfiles    []gax.CallOption
	GetConnectionProfile      []gax.CallOption
	CreateConnectionProfile   []gax.CallOption
	UpdateConnectionProfile   []gax.CallOption
	DeleteConnectionProfile   []gax.CallOption
	DiscoverConnectionProfile []gax.CallOption
	ListStreams               []gax.CallOption
	GetStream                 []gax.CallOption
	CreateStream              []gax.CallOption
	UpdateStream              []gax.CallOption
	DeleteStream              []gax.CallOption
	FetchErrors               []gax.CallOption
	FetchStaticIps            []gax.CallOption
	CreatePrivateConnection   []gax.CallOption
	GetPrivateConnection      []gax.CallOption
	ListPrivateConnections    []gax.CallOption
	DeletePrivateConnection   []gax.CallOption
	CreateRoute               []gax.CallOption
	GetRoute                  []gax.CallOption
	ListRoutes                []gax.CallOption
	DeleteRoute               []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 Datastream API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Datastream service

func NewClient

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

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

Datastream service

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
)

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

CreateConnectionProfile use this method to create a connection profile in a project and location.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

	req := &datastreampb.CreateConnectionProfileRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.CreateConnectionProfile(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) CreateConnectionProfileOperation

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

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

func (*Client) CreatePrivateConnection

CreatePrivateConnection use this method to create a private connectivity configuration.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

	req := &datastreampb.CreatePrivateConnectionRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.CreatePrivateConnection(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) CreatePrivateConnectionOperation

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

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

func (*Client) CreateRoute

CreateRoute use this method to create a route for a private connectivity in a project and location.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

	req := &datastreampb.CreateRouteRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.CreateRoute(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) CreateRouteOperation

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

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

func (*Client) CreateStream

CreateStream use this method to create a stream.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

	req := &datastreampb.CreateStreamRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.CreateStream(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) CreateStreamOperation

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

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

func (*Client) DeleteConnectionProfile

DeleteConnectionProfile use this method to delete a connection profile…

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

	req := &datastreampb.DeleteConnectionProfileRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.DeleteConnectionProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) DeleteConnectionProfileOperation

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

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

func (*Client) DeletePrivateConnection

DeletePrivateConnection use this method to delete a private connectivity configuration.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

	req := &datastreampb.DeletePrivateConnectionRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.DeletePrivateConnection(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) DeletePrivateConnectionOperation

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

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

func (*Client) DeleteRoute

DeleteRoute use this method to delete a route.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

	req := &datastreampb.DeleteRouteRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.DeleteRoute(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) DeleteRouteOperation

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

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

func (*Client) DeleteStream

DeleteStream use this method to delete a stream.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

	req := &datastreampb.DeleteStreamRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.DeleteStream(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) DeleteStreamOperation

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

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

func (*Client) DiscoverConnectionProfile

DiscoverConnectionProfile use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects under a parent data object that’s optionally supplied in the request.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

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

func (*Client) FetchErrors

FetchErrors use this method to fetch any errors associated with a stream.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

	req := &datastreampb.FetchErrorsRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.FetchErrors(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) FetchErrorsOperation

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

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

func (*Client) FetchStaticIps

func (c *Client) FetchStaticIps(ctx context.Context, req *datastreampb.FetchStaticIpsRequest, opts ...gax.CallOption) *StringIterator

FetchStaticIps the FetchStaticIps API call exposes the static ips used by Datastream. Typically, a request returns children data objects under a parent data object that’s optionally supplied in the request.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	"google.golang.org/api/iterator"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

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

func (*Client) GetConnectionProfile

GetConnectionProfile use this method to get details about a connection profile.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

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

func (*Client) GetPrivateConnection

GetPrivateConnection use this method to get details about a private connectivity configuration.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

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

func (*Client) GetRoute

GetRoute use this method to get details about a route.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

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

func (*Client) GetStream

GetStream use this method to get details about a stream.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

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

func (*Client) ListConnectionProfiles

ListConnectionProfiles use this method to list connection profiles created in a project and location.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	"google.golang.org/api/iterator"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

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

func (*Client) ListPrivateConnections

ListPrivateConnections use this method to list private connectivity configurations in a project and location.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	"google.golang.org/api/iterator"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

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

func (*Client) ListRoutes

func (c *Client) ListRoutes(ctx context.Context, req *datastreampb.ListRoutesRequest, opts ...gax.CallOption) *RouteIterator

ListRoutes use this method to list routes created for a private connectivity in a project and location.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	"google.golang.org/api/iterator"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

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

func (*Client) ListStreams

func (c *Client) ListStreams(ctx context.Context, req *datastreampb.ListStreamsRequest, opts ...gax.CallOption) *StreamIterator

ListStreams use this method to list streams in a project and location.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	"google.golang.org/api/iterator"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

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

func (*Client) UpdateConnectionProfile

UpdateConnectionProfile use this method to update the parameters of a connection profile.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

	req := &datastreampb.UpdateConnectionProfileRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.UpdateConnectionProfile(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) UpdateConnectionProfileOperation

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

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

func (*Client) UpdateStream

UpdateStream use this method to update the configuration of a stream.

Example

package main

import (
	datastream "cloud.google.com/go/datastream/apiv1alpha1"
	"context"
	datastreampb "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1"
)

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

	req := &datastreampb.UpdateStreamRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.UpdateStream(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) UpdateStreamOperation

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

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

ConnectionProfileIterator

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

ConnectionProfileIterator manages a stream of *datastreampb.ConnectionProfile.

func (*ConnectionProfileIterator) Next

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 (*ConnectionProfileIterator) PageInfo

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

CreateConnectionProfileOperation

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

CreateConnectionProfileOperation manages a long-running operation from CreateConnectionProfile.

func (*CreateConnectionProfileOperation) Done

Done reports whether the long-running operation has completed.

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

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 (*CreateConnectionProfileOperation) 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 (*CreateConnectionProfileOperation) 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.

CreatePrivateConnectionOperation

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

CreatePrivateConnectionOperation manages a long-running operation from CreatePrivateConnection.

func (*CreatePrivateConnectionOperation) Done

Done reports whether the long-running operation has completed.

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

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 (*CreatePrivateConnectionOperation) 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 (*CreatePrivateConnectionOperation) 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.

CreateRouteOperation

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

CreateRouteOperation manages a long-running operation from CreateRoute.

func (*CreateRouteOperation) Done

func (op *CreateRouteOperation) Done() bool

Done reports whether the long-running operation has completed.

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

func (op *CreateRouteOperation) 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 (*CreateRouteOperation) 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 (*CreateRouteOperation) 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.

CreateStreamOperation

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

CreateStreamOperation manages a long-running operation from CreateStream.

func (*CreateStreamOperation) Done

func (op *CreateStreamOperation) Done() bool

Done reports whether the long-running operation has completed.

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

func (op *CreateStreamOperation) 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 (*CreateStreamOperation) 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 (*CreateStreamOperation) 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.

DeleteConnectionProfileOperation

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

DeleteConnectionProfileOperation manages a long-running operation from DeleteConnectionProfile.

func (*DeleteConnectionProfileOperation) Done

Done reports whether the long-running operation has completed.

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

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 (*DeleteConnectionProfileOperation) 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 (*DeleteConnectionProfileOperation) 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.

DeletePrivateConnectionOperation

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

DeletePrivateConnectionOperation manages a long-running operation from DeletePrivateConnection.

func (*DeletePrivateConnectionOperation) Done

Done reports whether the long-running operation has completed.

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

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 (*DeletePrivateConnectionOperation) 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 (*DeletePrivateConnectionOperation) 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.

DeleteRouteOperation

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

DeleteRouteOperation manages a long-running operation from DeleteRoute.

func (*DeleteRouteOperation) Done

func (op *DeleteRouteOperation) Done() bool

Done reports whether the long-running operation has completed.

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

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

func (op *DeleteRouteOperation) 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 (*DeleteRouteOperation) Wait

func (op *DeleteRouteOperation) 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.

DeleteStreamOperation

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

DeleteStreamOperation manages a long-running operation from DeleteStream.

func (*DeleteStreamOperation) Done

func (op *DeleteStreamOperation) Done() bool

Done reports whether the long-running operation has completed.

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

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

func (op *DeleteStreamOperation) 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 (*DeleteStreamOperation) Wait

func (op *DeleteStreamOperation) 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.

FetchErrorsOperation

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

FetchErrorsOperation manages a long-running operation from FetchErrors.

func (*FetchErrorsOperation) Done

func (op *FetchErrorsOperation) Done() bool

Done reports whether the long-running operation has completed.

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

func (op *FetchErrorsOperation) 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 (*FetchErrorsOperation) 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 (*FetchErrorsOperation) 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.

PrivateConnectionIterator

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

PrivateConnectionIterator manages a stream of *datastreampb.PrivateConnection.

func (*PrivateConnectionIterator) Next

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 (*PrivateConnectionIterator) PageInfo

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

RouteIterator

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

RouteIterator manages a stream of *datastreampb.Route.

func (*RouteIterator) Next

func (it *RouteIterator) Next() (*datastreampb.Route, 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 (*RouteIterator) PageInfo

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

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

StreamIterator

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

StreamIterator manages a stream of *datastreampb.Stream.

func (*StreamIterator) Next

func (it *StreamIterator) Next() (*datastreampb.Stream, 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 (*StreamIterator) PageInfo

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

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

StringIterator

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

StringIterator manages a stream of string.

func (*StringIterator) Next

func (it *StringIterator) Next() (string, 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 (*StringIterator) PageInfo

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

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

UpdateConnectionProfileOperation

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

UpdateConnectionProfileOperation manages a long-running operation from UpdateConnectionProfile.

func (*UpdateConnectionProfileOperation) Done

Done reports whether the long-running operation has completed.

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

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 (*UpdateConnectionProfileOperation) 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 (*UpdateConnectionProfileOperation) 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.

UpdateStreamOperation

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

UpdateStreamOperation manages a long-running operation from UpdateStream.

func (*UpdateStreamOperation) Done

func (op *UpdateStreamOperation) Done() bool

Done reports whether the long-running operation has completed.

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

func (op *UpdateStreamOperation) 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 (*UpdateStreamOperation) 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 (*UpdateStreamOperation) 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.