Cloud Asset API v1 - Package cloud.google.com/go/asset/apiv1 (v0.82.0)

Package asset is an auto-generated package for the Cloud Asset API.

The cloud asset API manages the history and inventory of cloud resources.

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 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.

AnalyzeIamPolicyLongrunningOperation

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

AnalyzeIamPolicyLongrunningOperation manages a long-running operation from AnalyzeIamPolicyLongrunning.

func (*AnalyzeIamPolicyLongrunningOperation) Done

func (op *AnalyzeIamPolicyLongrunningOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*AnalyzeIamPolicyLongrunningOperation) Metadata

func (op *AnalyzeIamPolicyLongrunningOperation) Metadata() (*assetpb.AnalyzeIamPolicyLongrunningRequest, 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 (*AnalyzeIamPolicyLongrunningOperation) Name

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

func (op *AnalyzeIamPolicyLongrunningOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*assetpb.AnalyzeIamPolicyLongrunningResponse, 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 (*AnalyzeIamPolicyLongrunningOperation) Wait

func (op *AnalyzeIamPolicyLongrunningOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*assetpb.AnalyzeIamPolicyLongrunningResponse, 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.

CallOptions

type CallOptions struct {
	ExportAssets                []gax.CallOption
	BatchGetAssetsHistory       []gax.CallOption
	CreateFeed                  []gax.CallOption
	GetFeed                     []gax.CallOption
	ListFeeds                   []gax.CallOption
	UpdateFeed                  []gax.CallOption
	DeleteFeed                  []gax.CallOption
	SearchAllResources          []gax.CallOption
	SearchAllIamPolicies        []gax.CallOption
	AnalyzeIamPolicy            []gax.CallOption
	AnalyzeIamPolicyLongrunning []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

Client

type Client struct {

	// LROClient is used internally to handle longrunning operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient

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

Client is a client for interacting with Cloud Asset API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewClient

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

NewClient creates a new asset service client.

Asset service definition.

Example

package main

import (
	"context"

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

func main() {
	ctx := context.Background()
	c, err := asset.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use client.
	_ = c
}

func (*Client) AnalyzeIamPolicy

func (c *Client) AnalyzeIamPolicy(ctx context.Context, req *assetpb.AnalyzeIamPolicyRequest, opts ...gax.CallOption) (*assetpb.AnalyzeIamPolicyResponse, error)

AnalyzeIamPolicy analyzes IAM policies to answer which identities have what accesses on which resources.

Example

package main

import (
	"context"

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

	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
)

func main() {
	// import assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"

	ctx := context.Background()
	c, err := asset.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) AnalyzeIamPolicyLongrunning

func (c *Client) AnalyzeIamPolicyLongrunning(ctx context.Context, req *assetpb.AnalyzeIamPolicyLongrunningRequest, opts ...gax.CallOption) (*AnalyzeIamPolicyLongrunningOperation, error)

AnalyzeIamPolicyLongrunning analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a AnalyzeIamPolicyResponse. This method implements the google.longrunning.Operation, which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the request to help callers to map responses to requests.

Example

package main

import (
	"context"

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

	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
)

func main() {
	// import assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"

	ctx := context.Background()
	c, err := asset.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &assetpb.AnalyzeIamPolicyLongrunningRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.AnalyzeIamPolicyLongrunning(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) AnalyzeIamPolicyLongrunningOperation

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

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

func (*Client) BatchGetAssetsHistory

func (c *Client) BatchGetAssetsHistory(ctx context.Context, req *assetpb.BatchGetAssetsHistoryRequest, opts ...gax.CallOption) (*assetpb.BatchGetAssetsHistoryResponse, error)

BatchGetAssetsHistory batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.

Example

package main

import (
	"context"

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

	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
)

func main() {
	// import assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"

	ctx := context.Background()
	c, err := asset.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) Close

func (c *Client) Close() error

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

func (*Client) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*Client) CreateFeed

func (c *Client) CreateFeed(ctx context.Context, req *assetpb.CreateFeedRequest, opts ...gax.CallOption) (*assetpb.Feed, error)

CreateFeed creates a feed in a parent project/folder/organization to listen to its asset updates.

Example

package main

import (
	"context"

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

	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
)

func main() {
	// import assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"

	ctx := context.Background()
	c, err := asset.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) DeleteFeed

func (c *Client) DeleteFeed(ctx context.Context, req *assetpb.DeleteFeedRequest, opts ...gax.CallOption) error

DeleteFeed deletes an asset feed.

Example

package main

import (
	"context"

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

	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
)

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

	req := &assetpb.DeleteFeedRequest{
		// TODO: Fill request struct fields.
	}
	err = c.DeleteFeed(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*Client) ExportAssets

func (c *Client) ExportAssets(ctx context.Context, req *assetpb.ExportAssetsRequest, opts ...gax.CallOption) (*ExportAssetsOperation, error)

ExportAssets exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a google.cloud.asset.v1.Asset in the JSON format; for BigQuery table destinations, the output table stores the fields in asset proto as columns. This API implements the google.longrunning.Operation API , which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.

Example

package main

import (
	"context"

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

	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
)

func main() {
	// import assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"

	ctx := context.Background()
	c, err := asset.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &assetpb.ExportAssetsRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.ExportAssets(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) ExportAssetsOperation

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

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

func (*Client) GetFeed

func (c *Client) GetFeed(ctx context.Context, req *assetpb.GetFeedRequest, opts ...gax.CallOption) (*assetpb.Feed, error)

GetFeed gets details about an asset feed.

Example

package main

import (
	"context"

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

	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
)

func main() {
	// import assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"

	ctx := context.Background()
	c, err := asset.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) ListFeeds

func (c *Client) ListFeeds(ctx context.Context, req *assetpb.ListFeedsRequest, opts ...gax.CallOption) (*assetpb.ListFeedsResponse, error)

ListFeeds lists all asset feeds in a parent project/folder/organization.

Example

package main

import (
	"context"

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

	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
)

func main() {
	// import assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"

	ctx := context.Background()
	c, err := asset.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) SearchAllIamPolicies

func (c *Client) SearchAllIamPolicies(ctx context.Context, req *assetpb.SearchAllIamPoliciesRequest, opts ...gax.CallOption) *IamPolicySearchResultIterator

SearchAllIamPolicies searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the cloudasset.assets.searchAllIamPolicies permission on the desired scope, otherwise the request will be rejected.

Example

package main

import (
	"context"

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

	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
)

func main() {
	// import assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
	// import "google.golang.org/api/iterator"

	ctx := context.Background()
	c, err := asset.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) SearchAllResources

func (c *Client) SearchAllResources(ctx context.Context, req *assetpb.SearchAllResourcesRequest, opts ...gax.CallOption) *ResourceSearchResultIterator

SearchAllResources searches all Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the cloudasset.assets.searchAllResources permission on the desired scope, otherwise the request will be rejected.

Example

package main

import (
	"context"

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

	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
)

func main() {
	// import assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
	// import "google.golang.org/api/iterator"

	ctx := context.Background()
	c, err := asset.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) UpdateFeed

func (c *Client) UpdateFeed(ctx context.Context, req *assetpb.UpdateFeedRequest, opts ...gax.CallOption) (*assetpb.Feed, error)

UpdateFeed updates an asset feed configuration.

Example

package main

import (
	"context"

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

	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"
)

func main() {
	// import assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1"

	ctx := context.Background()
	c, err := asset.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

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

ExportAssetsOperation

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

ExportAssetsOperation manages a long-running operation from ExportAssets.

func (*ExportAssetsOperation) Done

func (op *ExportAssetsOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ExportAssetsOperation) Metadata

func (op *ExportAssetsOperation) Metadata() (*assetpb.ExportAssetsRequest, error)

func (*ExportAssetsOperation) Name

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

func (op *ExportAssetsOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*assetpb.ExportAssetsResponse, error)

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

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

func (*ExportAssetsOperation) Wait

func (op *ExportAssetsOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*assetpb.ExportAssetsResponse, 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.

IamPolicySearchResultIterator

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

IamPolicySearchResultIterator manages a stream of *assetpb.IamPolicySearchResult.

func (*IamPolicySearchResultIterator) Next

func (it *IamPolicySearchResultIterator) Next() (*assetpb.IamPolicySearchResult, 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 (*IamPolicySearchResultIterator) PageInfo

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

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

ResourceSearchResultIterator

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

ResourceSearchResultIterator manages a stream of *assetpb.ResourceSearchResult.

func (*ResourceSearchResultIterator) Next

func (it *ResourceSearchResultIterator) Next() (*assetpb.ResourceSearchResult, 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 (*ResourceSearchResultIterator) PageInfo

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

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