asset

package
v0.46.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 13, 2019 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

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

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

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 godoc.org/cloud.google.com/go.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes 

func DefaultAuthScopes() []string

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

Types

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

CallOptions contains the retry settings for each method of Client.

type 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/apiv1p2beta1"
)

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

Output:

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 RESOURCE content, this API outputs history with asset in both non-delete or deleted status. 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.

Example 
package main

import (
	"context"

	asset "cloud.google.com/go/asset/apiv1p2beta1"
	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1"
)

func main() {
	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
}

Output:

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 the client's connection to the API service.

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/apiv1p2beta1"
	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1"
)

func main() {
	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
}

Output:

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/apiv1p2beta1"
	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1"
)

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

Output:

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. The output format is newline-delimited JSON. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API allowing you to keep track of the export.

Example 
package main

import (
	"context"

	asset "cloud.google.com/go/asset/apiv1p2beta1"
	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1"
)

func main() {
	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
}

Output:

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/apiv1p2beta1"
	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1"
)

func main() {
	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
}

Output:

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/apiv1p2beta1"
	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1"
)

func main() {
	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
}

Output:

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/apiv1p2beta1"
	assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1"
)

func main() {
	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
}

Output:

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

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.