Package cloud.google.com/go/networkmanagement/apiv1 (v0.88.0)

Package networkmanagement is an auto-generated package for the Network Management API.

The Network Management API provides a collection of network performance monitoring and diagnostic capabilities.

NOTE: This package is in beta. It is not stable, and may be subject to changes.

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.

ConnectivityTestIterator

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

ConnectivityTestIterator manages a stream of *networkmanagementpb.ConnectivityTest.

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

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

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

CreateConnectivityTestOperation

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

CreateConnectivityTestOperation manages a long-running operation from CreateConnectivityTest.

func (*CreateConnectivityTestOperation) Done

Done reports whether the long-running operation has completed.

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

DeleteConnectivityTestOperation

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

DeleteConnectivityTestOperation manages a long-running operation from DeleteConnectivityTest.

func (*DeleteConnectivityTestOperation) Done

Done reports whether the long-running operation has completed.

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

ReachabilityCallOptions

type ReachabilityCallOptions struct {
	ListConnectivityTests  []gax.CallOption
	GetConnectivityTest    []gax.CallOption
	CreateConnectivityTest []gax.CallOption
	UpdateConnectivityTest []gax.CallOption
	RerunConnectivityTest  []gax.CallOption
	DeleteConnectivityTest []gax.CallOption
}

ReachabilityCallOptions contains the retry settings for each method of ReachabilityClient.

ReachabilityClient

type ReachabilityClient struct {

	// The call options for this service.
	CallOptions *ReachabilityCallOptions

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

ReachabilityClient is a client for interacting with Network Management API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

The Reachability service in the Google Cloud Network Management API provides services that analyze the reachability within a single Google Virtual Private Cloud (VPC) network, between peered VPC networks, between VPC and on-premises networks, or between VPC networks and internet hosts. A reachability analysis is based on Google Cloud network configurations.

You can use the analysis results to verify these configurations and to troubleshoot connectivity issues.

func NewReachabilityClient

func NewReachabilityClient(ctx context.Context, opts ...option.ClientOption) (*ReachabilityClient, error)

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

The Reachability service in the Google Cloud Network Management API provides services that analyze the reachability within a single Google Virtual Private Cloud (VPC) network, between peered VPC networks, between VPC and on-premises networks, or between VPC networks and internet hosts. A reachability analysis is based on Google Cloud network configurations.

You can use the analysis results to verify these configurations and to troubleshoot connectivity issues.

Example

package main

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

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

	// TODO: Use client.
	_ = c
}

func (*ReachabilityClient) Close

func (c *ReachabilityClient) Close() error

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

func (*ReachabilityClient) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*ReachabilityClient) CreateConnectivityTest

CreateConnectivityTest creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.

If the endpoint specifications in ConnectivityTest are invalid (for example, containing non-existent resources in the network, or you don’t have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN.

If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. For more information, see the Connectivity Test documentation.

Example

package main

import (
	networkmanagement "cloud.google.com/go/networkmanagement/apiv1"
	"context"
	networkmanagementpb "google.golang.org/genproto/googleapis/cloud/networkmanagement/v1"
)

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

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

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

func (*ReachabilityClient) CreateConnectivityTestOperation

func (c *ReachabilityClient) CreateConnectivityTestOperation(name string) *CreateConnectivityTestOperation

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

func (*ReachabilityClient) DeleteConnectivityTest

DeleteConnectivityTest deletes a specific ConnectivityTest.

Example

package main

import (
	networkmanagement "cloud.google.com/go/networkmanagement/apiv1"
	"context"
	networkmanagementpb "google.golang.org/genproto/googleapis/cloud/networkmanagement/v1"
)

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

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

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

func (*ReachabilityClient) DeleteConnectivityTestOperation

func (c *ReachabilityClient) DeleteConnectivityTestOperation(name string) *DeleteConnectivityTestOperation

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

func (*ReachabilityClient) GetConnectivityTest

GetConnectivityTest gets the details of a specific Connectivity Test.

Example

package main

import (
	networkmanagement "cloud.google.com/go/networkmanagement/apiv1"
	"context"
	networkmanagementpb "google.golang.org/genproto/googleapis/cloud/networkmanagement/v1"
)

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

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

func (*ReachabilityClient) ListConnectivityTests

ListConnectivityTests lists all Connectivity Tests owned by a project.

Example

package main

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

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

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

func (*ReachabilityClient) RerunConnectivityTest

RerunConnectivityTest rerun an existing ConnectivityTest. After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.

Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes.

If the endpoint specifications in ConnectivityTest become invalid (for example, specified resources are deleted in the network, or you lost read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN.

Example

package main

import (
	networkmanagement "cloud.google.com/go/networkmanagement/apiv1"
	"context"
	networkmanagementpb "google.golang.org/genproto/googleapis/cloud/networkmanagement/v1"
)

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

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

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

func (*ReachabilityClient) RerunConnectivityTestOperation

func (c *ReachabilityClient) RerunConnectivityTestOperation(name string) *RerunConnectivityTestOperation

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

func (*ReachabilityClient) UpdateConnectivityTest

UpdateConnectivityTest updates the configuration of an existing ConnectivityTest. After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result.

If the endpoint specifications in ConnectivityTest are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN.

If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. See the documentation in ConnectivityTest for for more details.

Example

package main

import (
	networkmanagement "cloud.google.com/go/networkmanagement/apiv1"
	"context"
	networkmanagementpb "google.golang.org/genproto/googleapis/cloud/networkmanagement/v1"
)

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

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

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

func (*ReachabilityClient) UpdateConnectivityTestOperation

func (c *ReachabilityClient) UpdateConnectivityTestOperation(name string) *UpdateConnectivityTestOperation

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

RerunConnectivityTestOperation

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

RerunConnectivityTestOperation manages a long-running operation from RerunConnectivityTest.

func (*RerunConnectivityTestOperation) Done

Done reports whether the long-running operation has completed.

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

UpdateConnectivityTestOperation

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

UpdateConnectivityTestOperation manages a long-running operation from UpdateConnectivityTest.

func (*UpdateConnectivityTestOperation) Done

Done reports whether the long-running operation has completed.

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