Documentation
¶
Overview ¶
Package asset is an auto-generated package for the Cloud Asset API.
The cloud asset API manages the history and inventory of cloud resources.
NOTE: This package is in beta. It is not stable, and may be subject to changes.
Use of Context ¶
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
For information about setting deadlines, reusing contexts, and more please visit 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 AssetIterator ¶
type AssetIterator 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.Asset, nextPageToken string, err error)
// contains filtered or unexported fields
}
AssetIterator manages a stream of *assetpb.Asset.
func (*AssetIterator) Next ¶
func (it *AssetIterator) Next() (*assetpb.Asset, 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 (*AssetIterator) PageInfo ¶
func (it *AssetIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type CallOptions ¶
type CallOptions struct {
ListAssets []gax.CallOption
}
CallOptions contains the retry settings for each method of Client.
type Client ¶
type Client struct {
// 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 ¶
NewClient creates a new asset service client.
Asset service definition.
Example ¶
package main
import (
"context"
asset "cloud.google.com/go/asset/apiv1p5beta1"
)
func main() {
ctx := context.Background()
c, err := asset.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use client.
_ = c
}
Output:
func (*Client) Close ¶
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) ListAssets ¶
func (c *Client) ListAssets(ctx context.Context, req *assetpb.ListAssetsRequest, opts ...gax.CallOption) *AssetIterator
ListAssets lists assets with time and resource types and returns paged results in response.
Example ¶
package main
import (
"context"
asset "cloud.google.com/go/asset/apiv1p5beta1"
"google.golang.org/api/iterator"
assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1p5beta1"
)
func main() {
// import assetpb "google.golang.org/genproto/googleapis/cloud/asset/v1p5beta1"
// import "google.golang.org/api/iterator"
ctx := context.Background()
c, err := asset.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
req := &assetpb.ListAssetsRequest{
// TODO: Fill request struct fields.
}
it := c.ListAssets(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
Output:
Source Files