Workload Manager API v1 - Package cloud.google.com/go/workloadmanager/apiv1 (v0.4.0)

Package workloadmanager is an auto-generated package for the Workload Manager API.

Workload Manager is a service that provides tooling for enterprise workloads to automate the deployment and validation of your workloads against best practices and recommendations.

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

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/workloadmanager/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 := workloadmanager.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, mentioned above.

req := &workloadmanagerpb.CreateEvaluationRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#CreateEvaluationRequest.
}
op, err := c.CreateEvaluation(ctx, req)
if err != nil {
    // TODO: Handle error.
}

resp, err := op.Wait(ctx)
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.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

CallOptions

type CallOptions struct {
	ListEvaluations      []gax.CallOption
	GetEvaluation        []gax.CallOption
	CreateEvaluation     []gax.CallOption
	UpdateEvaluation     []gax.CallOption
	DeleteEvaluation     []gax.CallOption
	ListExecutions       []gax.CallOption
	GetExecution         []gax.CallOption
	RunEvaluation        []gax.CallOption
	DeleteExecution      []gax.CallOption
	ListExecutionResults []gax.CallOption
	ListRules            []gax.CallOption
	ListScannedResources []gax.CallOption
	GetLocation          []gax.CallOption
	ListLocations        []gax.CallOption
	CancelOperation      []gax.CallOption
	DeleteOperation      []gax.CallOption
	GetOperation         []gax.CallOption
	ListOperations       []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 Workload Manager API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

The Workload Manager provides various tools to deploy, validate and observe your workloads running on Google Cloud.

func NewClient

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

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

The Workload Manager provides various tools to deploy, validate and observe your workloads running on Google Cloud.

Example

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewRESTClient

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

NewRESTClient creates a new workload manager rest client.

The Workload Manager provides various tools to deploy, validate and observe your workloads running on Google Cloud.

Example

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/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 := workloadmanager.NewRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*Client) CancelOperation

func (c *Client) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error

CancelOperation is a utility method from google.longrunning.Operations.

Example

package main

import (
	"context"

	longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
	workloadmanager "cloud.google.com/go/workloadmanager/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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &longrunningpb.CancelOperationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.
	}
	err = c.CancelOperation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

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 (deprecated)

func (c *Client) 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 (*Client) CreateEvaluation

func (c *Client) CreateEvaluation(ctx context.Context, req *workloadmanagerpb.CreateEvaluationRequest, opts ...gax.CallOption) (*CreateEvaluationOperation, error)

CreateEvaluation creates a new Evaluation in a given project and location.

Example

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.CreateEvaluationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#CreateEvaluationRequest.
	}
	op, err := c.CreateEvaluation(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) CreateEvaluationOperation

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

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

func (*Client) DeleteEvaluation

func (c *Client) DeleteEvaluation(ctx context.Context, req *workloadmanagerpb.DeleteEvaluationRequest, opts ...gax.CallOption) (*DeleteEvaluationOperation, error)

DeleteEvaluation deletes a single Evaluation.

Example

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.DeleteEvaluationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#DeleteEvaluationRequest.
	}
	op, err := c.DeleteEvaluation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) DeleteEvaluationOperation

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

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

func (*Client) DeleteExecution

func (c *Client) DeleteExecution(ctx context.Context, req *workloadmanagerpb.DeleteExecutionRequest, opts ...gax.CallOption) (*DeleteExecutionOperation, error)

DeleteExecution deletes a single Execution.

Example

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.DeleteExecutionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#DeleteExecutionRequest.
	}
	op, err := c.DeleteExecution(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) DeleteExecutionOperation

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

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

func (*Client) DeleteOperation

func (c *Client) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error

DeleteOperation is a utility method from google.longrunning.Operations.

Example

package main

import (
	"context"

	longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
	workloadmanager "cloud.google.com/go/workloadmanager/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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &longrunningpb.DeleteOperationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest.
	}
	err = c.DeleteOperation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*Client) GetEvaluation

func (c *Client) GetEvaluation(ctx context.Context, req *workloadmanagerpb.GetEvaluationRequest, opts ...gax.CallOption) (*workloadmanagerpb.Evaluation, error)

GetEvaluation gets details of a single Evaluation.

Example

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.GetEvaluationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#GetEvaluationRequest.
	}
	resp, err := c.GetEvaluation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) GetExecution

func (c *Client) GetExecution(ctx context.Context, req *workloadmanagerpb.GetExecutionRequest, opts ...gax.CallOption) (*workloadmanagerpb.Execution, error)

GetExecution gets details of a single Execution.

Example

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.GetExecutionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#GetExecutionRequest.
	}
	resp, err := c.GetExecution(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) GetLocation

func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)

GetLocation gets information about a location.

Example

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	locationpb "google.golang.org/genproto/googleapis/cloud/location"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &locationpb.GetLocationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
	}
	resp, err := c.GetLocation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) GetOperation

func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)

GetOperation is a utility method from google.longrunning.Operations.

Example

package main

import (
	"context"

	longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
	workloadmanager "cloud.google.com/go/workloadmanager/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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &longrunningpb.GetOperationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
	}
	resp, err := c.GetOperation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) ListEvaluations

func (c *Client) ListEvaluations(ctx context.Context, req *workloadmanagerpb.ListEvaluationsRequest, opts ...gax.CallOption) *EvaluationIterator

ListEvaluations lists Evaluations in a given project and location.

Examples

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
	"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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.ListEvaluationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#ListEvaluationsRequest.
	}
	it := c.ListEvaluations(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.(*workloadmanagerpb.ListEvaluationsResponse)
	}
}

all

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.ListEvaluationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#ListEvaluationsRequest.
	}
	for resp, err := range c.ListEvaluations(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*Client) ListExecutionResults

func (c *Client) ListExecutionResults(ctx context.Context, req *workloadmanagerpb.ListExecutionResultsRequest, opts ...gax.CallOption) *ExecutionResultIterator

ListExecutionResults lists the result of a single evaluation.

Examples

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
	"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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.ListExecutionResultsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#ListExecutionResultsRequest.
	}
	it := c.ListExecutionResults(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.(*workloadmanagerpb.ListExecutionResultsResponse)
	}
}

all

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.ListExecutionResultsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#ListExecutionResultsRequest.
	}
	for resp, err := range c.ListExecutionResults(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*Client) ListExecutions

func (c *Client) ListExecutions(ctx context.Context, req *workloadmanagerpb.ListExecutionsRequest, opts ...gax.CallOption) *ExecutionIterator

ListExecutions lists Executions in a given project and location.

Examples

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
	"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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.ListExecutionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#ListExecutionsRequest.
	}
	it := c.ListExecutions(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.(*workloadmanagerpb.ListExecutionsResponse)
	}
}

all

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.ListExecutionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#ListExecutionsRequest.
	}
	for resp, err := range c.ListExecutions(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*Client) ListLocations

func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator

ListLocations lists information about the supported locations for this service. This method can be called in two ways:

List all public locations: Use the path GET /v1/locations.

List project-visible locations: Use the path
GET /v1/projects/{project_id}/locations. This may include public
locations as well as private or other locations specifically visible
to the project.

Examples

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"
	"google.golang.org/api/iterator"

	locationpb "google.golang.org/genproto/googleapis/cloud/location"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &locationpb.ListLocationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
	}
	it := c.ListLocations(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.(*locationpb.ListLocationsResponse)
	}
}

all

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	locationpb "google.golang.org/genproto/googleapis/cloud/location"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &locationpb.ListLocationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
	}
	for resp, err := range c.ListLocations(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*Client) ListOperations

func (c *Client) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator

ListOperations is a utility method from google.longrunning.Operations.

Examples

package main

import (
	"context"

	longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"
	"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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &longrunningpb.ListOperationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
	}
	it := c.ListOperations(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.(*longrunningpb.ListOperationsResponse)
	}
}

all

package main

import (
	"context"

	longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
	workloadmanager "cloud.google.com/go/workloadmanager/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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &longrunningpb.ListOperationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
	}
	for resp, err := range c.ListOperations(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*Client) ListRules

func (c *Client) ListRules(ctx context.Context, req *workloadmanagerpb.ListRulesRequest, opts ...gax.CallOption) (*workloadmanagerpb.ListRulesResponse, error)

ListRules lists rules in a given project.

Example

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.ListRulesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#ListRulesRequest.
	}
	resp, err := c.ListRules(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) ListScannedResources

func (c *Client) ListScannedResources(ctx context.Context, req *workloadmanagerpb.ListScannedResourcesRequest, opts ...gax.CallOption) *ScannedResourceIterator

ListScannedResources list all scanned resources for a single Execution.

Examples

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
	"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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.ListScannedResourcesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#ListScannedResourcesRequest.
	}
	it := c.ListScannedResources(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.(*workloadmanagerpb.ListScannedResourcesResponse)
	}
}

all

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.ListScannedResourcesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#ListScannedResourcesRequest.
	}
	for resp, err := range c.ListScannedResources(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*Client) RunEvaluation

func (c *Client) RunEvaluation(ctx context.Context, req *workloadmanagerpb.RunEvaluationRequest, opts ...gax.CallOption) (*RunEvaluationOperation, error)

RunEvaluation creates a new Execution in a given project and location.

Example

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.RunEvaluationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#RunEvaluationRequest.
	}
	op, err := c.RunEvaluation(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) RunEvaluationOperation

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

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

func (*Client) UpdateEvaluation

func (c *Client) UpdateEvaluation(ctx context.Context, req *workloadmanagerpb.UpdateEvaluationRequest, opts ...gax.CallOption) (*UpdateEvaluationOperation, error)

UpdateEvaluation updates the parameters of a single Evaluation.

Example

package main

import (
	"context"

	workloadmanager "cloud.google.com/go/workloadmanager/apiv1"

	workloadmanagerpb "cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb"
)

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 := workloadmanager.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &workloadmanagerpb.UpdateEvaluationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/workloadmanager/apiv1/workloadmanagerpb#UpdateEvaluationRequest.
	}
	op, err := c.UpdateEvaluation(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) UpdateEvaluationOperation

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

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

CreateEvaluationOperation

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

CreateEvaluationOperation manages a long-running operation from CreateEvaluation.

func (*CreateEvaluationOperation) Done

func (op *CreateEvaluationOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateEvaluationOperation) Metadata

func (op *CreateEvaluationOperation) Metadata() (*workloadmanagerpb.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 (*CreateEvaluationOperation) Name

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

func (op *CreateEvaluationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*workloadmanagerpb.Evaluation, 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 (*CreateEvaluationOperation) Wait

func (op *CreateEvaluationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*workloadmanagerpb.Evaluation, 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.

DeleteEvaluationOperation

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

DeleteEvaluationOperation manages a long-running operation from DeleteEvaluation.

func (*DeleteEvaluationOperation) Done

func (op *DeleteEvaluationOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteEvaluationOperation) Metadata

func (op *DeleteEvaluationOperation) Metadata() (*workloadmanagerpb.OperationMetadata, error)

func (*DeleteEvaluationOperation) Name

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

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

func (*DeleteEvaluationOperation) Wait

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

DeleteExecutionOperation

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

DeleteExecutionOperation manages a long-running operation from DeleteExecution.

func (*DeleteExecutionOperation) Done

func (op *DeleteExecutionOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteExecutionOperation) Metadata

func (op *DeleteExecutionOperation) Metadata() (*workloadmanagerpb.OperationMetadata, error)

func (*DeleteExecutionOperation) Name

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

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

func (*DeleteExecutionOperation) Wait

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

EvaluationIterator

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

EvaluationIterator manages a stream of *workloadmanagerpb.Evaluation.

func (*EvaluationIterator) All

func (it *EvaluationIterator) All() iter.Seq2[*workloadmanagerpb.Evaluation, error]

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

func (*EvaluationIterator) Next

func (it *EvaluationIterator) Next() (*workloadmanagerpb.Evaluation, 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 (*EvaluationIterator) PageInfo

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

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

ExecutionIterator

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

ExecutionIterator manages a stream of *workloadmanagerpb.Execution.

func (*ExecutionIterator) All

func (it *ExecutionIterator) All() iter.Seq2[*workloadmanagerpb.Execution, error]

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

func (*ExecutionIterator) Next

func (it *ExecutionIterator) Next() (*workloadmanagerpb.Execution, 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 (*ExecutionIterator) PageInfo

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

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

ExecutionResultIterator

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

ExecutionResultIterator manages a stream of *workloadmanagerpb.ExecutionResult.

func (*ExecutionResultIterator) All

func (it *ExecutionResultIterator) All() iter.Seq2[*workloadmanagerpb.ExecutionResult, error]

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

func (*ExecutionResultIterator) Next

func (it *ExecutionResultIterator) Next() (*workloadmanagerpb.ExecutionResult, 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 (*ExecutionResultIterator) PageInfo

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

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

LocationIterator

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

LocationIterator manages a stream of *locationpb.Location.

func (*LocationIterator) All

func (it *LocationIterator) All() iter.Seq2[*locationpb.Location, error]

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

func (*LocationIterator) Next

func (it *LocationIterator) Next() (*locationpb.Location, 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 (*LocationIterator) PageInfo

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

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

OperationIterator

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

OperationIterator manages a stream of *longrunningpb.Operation.

func (*OperationIterator) All

func (it *OperationIterator) All() iter.Seq2[*longrunningpb.Operation, error]

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

func (*OperationIterator) Next

func (it *OperationIterator) Next() (*longrunningpb.Operation, 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 (*OperationIterator) PageInfo

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

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

RunEvaluationOperation

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

RunEvaluationOperation manages a long-running operation from RunEvaluation.

func (*RunEvaluationOperation) Done

func (op *RunEvaluationOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RunEvaluationOperation) Metadata

func (op *RunEvaluationOperation) Metadata() (*workloadmanagerpb.OperationMetadata, error)

func (*RunEvaluationOperation) Name

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

func (op *RunEvaluationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*workloadmanagerpb.Execution, error)

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

func (*RunEvaluationOperation) Wait

func (op *RunEvaluationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*workloadmanagerpb.Execution, 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.

ScannedResourceIterator

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

ScannedResourceIterator manages a stream of *workloadmanagerpb.ScannedResource.

func (*ScannedResourceIterator) All

func (it *ScannedResourceIterator) All() iter.Seq2[*workloadmanagerpb.ScannedResource, error]

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

func (*ScannedResourceIterator) Next

func (it *ScannedResourceIterator) Next() (*workloadmanagerpb.ScannedResource, 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 (*ScannedResourceIterator) PageInfo

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

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

UpdateEvaluationOperation

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

UpdateEvaluationOperation manages a long-running operation from UpdateEvaluation.

func (*UpdateEvaluationOperation) Done

func (op *UpdateEvaluationOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateEvaluationOperation) Metadata

func (op *UpdateEvaluationOperation) Metadata() (*workloadmanagerpb.OperationMetadata, error)

func (*UpdateEvaluationOperation) Name

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

func (op *UpdateEvaluationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*workloadmanagerpb.Evaluation, error)

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

func (*UpdateEvaluationOperation) Wait

func (op *UpdateEvaluationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*workloadmanagerpb.Evaluation, 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.

Workload Manager API v1 - Package cloud.google.com/go/workloadmanager/apiv1 (v0.4.0) Stay organized with collections Save and categorize content based on your preferences.

General documentation

Example usage

Using the Client

Use of Context

Functions

func DefaultAuthScopes

CallOptions

Client

func NewClient

Example

func NewRESTClient

Example

func (*Client) CancelOperation

Example

func (*Client) Close

func (*Client) Connection (deprecated)

func (*Client) CreateEvaluation

Example

func (*Client) CreateEvaluationOperation

func (*Client) DeleteEvaluation

Example

func (*Client) DeleteEvaluationOperation

func (*Client) DeleteExecution

Example

func (*Client) DeleteExecutionOperation

func (*Client) DeleteOperation

Example

func (*Client) GetEvaluation

Example

func (*Client) GetExecution

Example

func (*Client) GetLocation

Example

func (*Client) GetOperation

Example

func (*Client) ListEvaluations

Examples

all

func (*Client) ListExecutionResults

Examples

all

func (*Client) ListExecutions

Examples

all

func (*Client) ListLocations

Examples

all

func (*Client) ListOperations

Examples

all

func (*Client) ListRules

Example

func (*Client) ListScannedResources

Examples

all

func (*Client) RunEvaluation

Example

func (*Client) RunEvaluationOperation

func (*Client) UpdateEvaluation

Example

func (*Client) UpdateEvaluationOperation

CreateEvaluationOperation

func (*CreateEvaluationOperation) Done

func (*CreateEvaluationOperation) Metadata

func (*CreateEvaluationOperation) Name

func (*CreateEvaluationOperation) Poll

func (*CreateEvaluationOperation) Wait

DeleteEvaluationOperation

func (*DeleteEvaluationOperation) Done

func (*DeleteEvaluationOperation) Metadata

func (*DeleteEvaluationOperation) Name

func (*DeleteEvaluationOperation) Poll

func (*DeleteEvaluationOperation) Wait

DeleteExecutionOperation

func (*DeleteExecutionOperation) Done

func (*DeleteExecutionOperation) Metadata

func (*DeleteExecutionOperation) Name

func (*DeleteExecutionOperation) Poll

func (*DeleteExecutionOperation) Wait

Workload Manager API v1 - Package cloud.google.com/go/workloadmanager/apiv1 (v0.4.0)