go: cloud.google.com/go/asset/v1beta1 Index | Examples | Files

package asset

import "cloud.google.com/go/asset/v1beta1"

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

NOTE: This package is in alpha. It is not stable, and is likely to change.

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

Index

Examples

Package Files

asset_client.go doc.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

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

type CallOptions Uses

type CallOptions struct {
    ExportAssets          []gax.CallOption
    BatchGetAssetsHistory []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

type Client Uses

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 Uses

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

NewClient creates a new asset service client.

Asset service definition.

Code:

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

func (*Client) BatchGetAssetsHistory Uses

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.

Code:

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 Uses

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 Uses

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

Connection returns the client's connection to the API service.

func (*Client) ExportAssets Uses

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.

Code:

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 Uses

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.

type ExportAssetsOperation Uses

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

ExportAssetsOperation manages a long-running operation from ExportAssets.

func (*ExportAssetsOperation) Done Uses

func (op *ExportAssetsOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ExportAssetsOperation) Metadata Uses

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 Uses

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 Uses

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 Uses

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.

Package asset imports 15 packages (graph). Updated 2019-10-14. Refresh now. Tools for package owners.