Package cloud.google.com/go/apigeeconnect/apiv1

Package apigeeconnect is an auto-generated package for the Apigee Connect API.

Example usage

To get started with this package, create a client.

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

req := &apigeeconnectpb.ListConnectionsRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/apigeeconnect/v1#ListConnectionsRequest.
}
it := c.ListConnections(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    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.

ConnectionCallOptions

type ConnectionCallOptions struct {
	ListConnections []gax.CallOption
}

ConnectionCallOptions contains the retry settings for each method of ConnectionClient.

ConnectionClient

type ConnectionClient struct {

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

ConnectionClient is a client for interacting with Apigee Connect API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service Interface for the Apigee Connect connection management APIs.

func NewConnectionClient

func NewConnectionClient(ctx context.Context, opts ...option.ClientOption) (*ConnectionClient, error)

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

Service Interface for the Apigee Connect connection management APIs.

Example

package main

import (
	apigeeconnect "cloud.google.com/go/apigeeconnect/apiv1"
	"context"
)

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

	// TODO: Use client.
	_ = c
}

func (*ConnectionClient) Close

func (c *ConnectionClient) Close() error

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

func (*ConnectionClient) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*ConnectionClient) ListConnections

ListConnections lists connections that are currently active for the given Apigee Connect endpoint.

Example

package main

import (
	apigeeconnect "cloud.google.com/go/apigeeconnect/apiv1"
	"context"
	"google.golang.org/api/iterator"
	apigeeconnectpb "google.golang.org/genproto/googleapis/cloud/apigeeconnect/v1"
)

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

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

ConnectionIterator

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

ConnectionIterator manages a stream of *apigeeconnectpb.Connection.

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

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

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

TetherCallOptions

type TetherCallOptions struct {
	Egress []gax.CallOption
}

TetherCallOptions contains the retry settings for each method of TetherClient.

TetherClient

type TetherClient struct {

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

TetherClient is a client for interacting with Apigee Connect API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.

func NewTetherClient

func NewTetherClient(ctx context.Context, opts ...option.ClientOption) (*TetherClient, error)

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

Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.

Example

package main

import (
	apigeeconnect "cloud.google.com/go/apigeeconnect/apiv1"
	"context"
)

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

	// TODO: Use client.
	_ = c
}

func (*TetherClient) Close

func (c *TetherClient) Close() error

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

func (*TetherClient) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*TetherClient) Egress

Egress egress streams egress requests and responses. Logically, this is not actually a streaming request, but uses streaming as a mechanism to flip the client-server relationship of gRPC so that the server can act as a client. The listener, the RPC server, accepts connections from the dialer, the RPC client. The listener streams http requests and the dialer streams http responses.

Example

package main

import (
	apigeeconnect "cloud.google.com/go/apigeeconnect/apiv1"
	"context"
	apigeeconnectpb "google.golang.org/genproto/googleapis/cloud/apigeeconnect/v1"
	"io"
)

func main() {
	ctx := context.Background()
	c, err := apigeeconnect.NewTetherClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()
	stream, err := c.Egress(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	go func() {
		reqs := []*apigeeconnectpb.EgressResponse{
			// TODO: Create requests.
		}
		for _, req := range reqs {
			if err := stream.Send(req); err != nil {
				// TODO: Handle error.
			}
		}
		stream.CloseSend()
	}()
	for {
		resp, err := stream.Recv()
		if err == io.EOF {
			break
		}
		if err != nil {
			// TODO: handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}