package apigeeconnect

import "cloud.google.com/go/apigeeconnect/apiv1"

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

General documentation

For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:

Example usage

To get started with this package, create a client. 

// go get cloud.google.com/go/apigeeconnect/apiv1@latest
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
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, mentioned above. 

req := &apigeeconnectpb.ListConnectionsRequest{
	// TODO: Fill request struct fields.
	// See https://pkg.go.dev/cloud.google.com/go/apigeeconnect/apiv1/apigeeconnectpb#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

	// If you need to access the underlying RPC response,
	// you can do so by casting the `Response` as below.
	// Otherwise, remove this line. Only populated after
	// first call to Next(). Not safe for concurrent access.
	_ = it.Response.(*apigeeconnectpb.ListConnectionsResponse)
}

Use of Context

The ctx passed to NewConnectionClient 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.

Index

Examples

Functions

func DefaultAuthScopes 

func DefaultAuthScopes() []string

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

Types

type ConnectionCallOptions 

type ConnectionCallOptions struct {
	ListConnections []gax.CallOption
}

ConnectionCallOptions contains the retry settings for each method of ConnectionClient.

type 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

Code:play  

package main

import (
	"context"

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

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	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: Connections are now pooled so this method does not always return the same resource.

func (*ConnectionClient) ListConnections 

func (c *ConnectionClient) ListConnections(ctx context.Context, req *apigeeconnectpb.ListConnectionsRequest, opts ...gax.CallOption) *ConnectionIterator

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

Example

Code:play  

package main

import (
	"context"

	apigeeconnect "cloud.google.com/go/apigeeconnect/apiv1"
	apigeeconnectpb "cloud.google.com/go/apigeeconnect/apiv1/apigeeconnectpb"
	"google.golang.org/api/iterator"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	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/cloud.google.com/go/apigeeconnect/apiv1/apigeeconnectpb#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

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*apigeeconnectpb.ListConnectionsResponse)
	}
}
Example (All)

Code:play  

package main

import (
	"context"

	apigeeconnect "cloud.google.com/go/apigeeconnect/apiv1"
	apigeeconnectpb "cloud.google.com/go/apigeeconnect/apiv1/apigeeconnectpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	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/cloud.google.com/go/apigeeconnect/apiv1/apigeeconnectpb#ListConnectionsRequest.
	}
	for resp, err := range c.ListConnections(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

type 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) All 

func (it *ConnectionIterator) All() iter.Seq2[*apigeeconnectpb.Connection, error]

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*ConnectionIterator) Next 

func (it *ConnectionIterator) Next() (*apigeeconnectpb.Connection, 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 (*ConnectionIterator) PageInfo 

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

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

type TetherCallOptions 

type TetherCallOptions struct {
	Egress []gax.CallOption
}

TetherCallOptions contains the retry settings for each method of TetherClient.

type 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

Code:play  

package main

import (
	"context"

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

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	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: Connections are now pooled so this method does not always return the same resource.

func (*TetherClient) Egress 

func (c *TetherClient) Egress(ctx context.Context, opts ...gax.CallOption) (apigeeconnectpb.Tether_EgressClient, error)

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

Code:play  

package main

import (
	"context"
	"io"

	apigeeconnect "cloud.google.com/go/apigeeconnect/apiv1"
	apigeeconnectpb "cloud.google.com/go/apigeeconnect/apiv1/apigeeconnectpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	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
	}
}

Source Files

auxiliary.go auxiliary_go123.go connection_client.go doc.go helpers.go tether_client.go version.go

Directories

PathSynopsis
apiv1/apigeeconnectpb
Version
v1.7.3 (latest)
Published
Jan 2, 2025
Platform
linux/amd64
Imports
19 packages
Last checked
5 days ago –

Tools for package owners.