Documentation ¶
Overview ¶
Package asset is an auto-generated package for the Cloud Asset API.
The Cloud Asset API manages the history and inventory of Google Cloud resources.
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:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage ¶
To get started with this package, create a client.
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 := asset.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.
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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.AnalyzeIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#AnalyzeIamPolicyRequest. } resp, err := c.AnalyzeIamPolicy(ctx, req) 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.
Index ¶
- func DefaultAuthScopes() []string
- type AnalyzeIamPolicyLongrunningOperation
- func (op *AnalyzeIamPolicyLongrunningOperation) Done() bool
- func (op *AnalyzeIamPolicyLongrunningOperation) Metadata() (*assetpb.AnalyzeIamPolicyLongrunningMetadata, error)
- func (op *AnalyzeIamPolicyLongrunningOperation) Name() string
- func (op *AnalyzeIamPolicyLongrunningOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*assetpb.AnalyzeIamPolicyLongrunningResponse, error)
- func (op *AnalyzeIamPolicyLongrunningOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*assetpb.AnalyzeIamPolicyLongrunningResponse, error)
- type AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator
- func (it *AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator) All() iter.Seq2[*assetpb.AnalyzeOrgPoliciesResponse_OrgPolicyResult, error]
- func (it *AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator) Next() (*assetpb.AnalyzeOrgPoliciesResponse_OrgPolicyResult, error)
- func (it *AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator) PageInfo() *iterator.PageInfo
- type AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator
- func (it *AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator) All() ...
- func (it *AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator) Next() (*assetpb.AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAsset, error)
- func (it *AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator) PageInfo() *iterator.PageInfo
- type AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator
- func (it *AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator) All() ...
- func (it *AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator) Next() (*assetpb.AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainer, error)
- func (it *AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator) PageInfo() *iterator.PageInfo
- type AssetIterator
- type CallOptions
- type Client
- func (c *Client) AnalyzeIamPolicy(ctx context.Context, req *assetpb.AnalyzeIamPolicyRequest, ...) (*assetpb.AnalyzeIamPolicyResponse, error)
- func (c *Client) AnalyzeIamPolicyLongrunning(ctx context.Context, req *assetpb.AnalyzeIamPolicyLongrunningRequest, ...) (*AnalyzeIamPolicyLongrunningOperation, error)
- func (c *Client) AnalyzeIamPolicyLongrunningOperation(name string) *AnalyzeIamPolicyLongrunningOperation
- func (c *Client) AnalyzeMove(ctx context.Context, req *assetpb.AnalyzeMoveRequest, opts ...gax.CallOption) (*assetpb.AnalyzeMoveResponse, error)
- func (c *Client) AnalyzeOrgPolicies(ctx context.Context, req *assetpb.AnalyzeOrgPoliciesRequest, ...) *AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator
- func (c *Client) AnalyzeOrgPolicyGovernedAssets(ctx context.Context, req *assetpb.AnalyzeOrgPolicyGovernedAssetsRequest, ...) *AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator
- func (c *Client) AnalyzeOrgPolicyGovernedContainers(ctx context.Context, req *assetpb.AnalyzeOrgPolicyGovernedContainersRequest, ...) *AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator
- func (c *Client) BatchGetAssetsHistory(ctx context.Context, req *assetpb.BatchGetAssetsHistoryRequest, ...) (*assetpb.BatchGetAssetsHistoryResponse, error)
- func (c *Client) BatchGetEffectiveIamPolicies(ctx context.Context, req *assetpb.BatchGetEffectiveIamPoliciesRequest, ...) (*assetpb.BatchGetEffectiveIamPoliciesResponse, error)
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConndeprecated
- func (c *Client) CreateFeed(ctx context.Context, req *assetpb.CreateFeedRequest, opts ...gax.CallOption) (*assetpb.Feed, error)
- func (c *Client) CreateSavedQuery(ctx context.Context, req *assetpb.CreateSavedQueryRequest, ...) (*assetpb.SavedQuery, error)
- func (c *Client) DeleteFeed(ctx context.Context, req *assetpb.DeleteFeedRequest, opts ...gax.CallOption) error
- func (c *Client) DeleteSavedQuery(ctx context.Context, req *assetpb.DeleteSavedQueryRequest, ...) error
- func (c *Client) ExportAssets(ctx context.Context, req *assetpb.ExportAssetsRequest, opts ...gax.CallOption) (*ExportAssetsOperation, error)
- func (c *Client) ExportAssetsOperation(name string) *ExportAssetsOperation
- func (c *Client) GetFeed(ctx context.Context, req *assetpb.GetFeedRequest, opts ...gax.CallOption) (*assetpb.Feed, error)
- func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *Client) GetSavedQuery(ctx context.Context, req *assetpb.GetSavedQueryRequest, opts ...gax.CallOption) (*assetpb.SavedQuery, error)
- func (c *Client) ListAssets(ctx context.Context, req *assetpb.ListAssetsRequest, opts ...gax.CallOption) *AssetIterator
- func (c *Client) ListFeeds(ctx context.Context, req *assetpb.ListFeedsRequest, opts ...gax.CallOption) (*assetpb.ListFeedsResponse, error)
- func (c *Client) ListSavedQueries(ctx context.Context, req *assetpb.ListSavedQueriesRequest, ...) *SavedQueryIterator
- func (c *Client) QueryAssets(ctx context.Context, req *assetpb.QueryAssetsRequest, opts ...gax.CallOption) (*assetpb.QueryAssetsResponse, error)
- func (c *Client) SearchAllIamPolicies(ctx context.Context, req *assetpb.SearchAllIamPoliciesRequest, ...) *IamPolicySearchResultIterator
- func (c *Client) SearchAllResources(ctx context.Context, req *assetpb.SearchAllResourcesRequest, ...) *ResourceSearchResultIterator
- func (c *Client) UpdateFeed(ctx context.Context, req *assetpb.UpdateFeedRequest, opts ...gax.CallOption) (*assetpb.Feed, error)
- func (c *Client) UpdateSavedQuery(ctx context.Context, req *assetpb.UpdateSavedQueryRequest, ...) (*assetpb.SavedQuery, error)
- type ExportAssetsOperation
- func (op *ExportAssetsOperation) Done() bool
- func (op *ExportAssetsOperation) Metadata() (*assetpb.ExportAssetsRequest, error)
- func (op *ExportAssetsOperation) Name() string
- func (op *ExportAssetsOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*assetpb.ExportAssetsResponse, error)
- func (op *ExportAssetsOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*assetpb.ExportAssetsResponse, error)
- type IamPolicySearchResultIterator
- type ResourceSearchResultIterator
- type SavedQueryIterator
Examples ¶
- Client.AnalyzeIamPolicy
- Client.AnalyzeIamPolicyLongrunning
- Client.AnalyzeMove
- Client.AnalyzeOrgPolicies
- Client.AnalyzeOrgPolicies (All)
- Client.AnalyzeOrgPolicyGovernedAssets
- Client.AnalyzeOrgPolicyGovernedAssets (All)
- Client.AnalyzeOrgPolicyGovernedContainers
- Client.AnalyzeOrgPolicyGovernedContainers (All)
- Client.BatchGetAssetsHistory
- Client.BatchGetEffectiveIamPolicies
- Client.CreateFeed
- Client.CreateSavedQuery
- Client.DeleteFeed
- Client.DeleteSavedQuery
- Client.ExportAssets
- Client.GetFeed
- Client.GetOperation
- Client.GetSavedQuery
- Client.ListAssets
- Client.ListAssets (All)
- Client.ListFeeds
- Client.ListSavedQueries
- Client.ListSavedQueries (All)
- Client.QueryAssets
- Client.SearchAllIamPolicies
- Client.SearchAllIamPolicies (All)
- Client.SearchAllResources
- Client.SearchAllResources (All)
- Client.UpdateFeed
- Client.UpdateSavedQuery
- NewClient
- NewRESTClient
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 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.AnalyzeIamPolicyLongrunningMetadata, 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.
type AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator ¶ added in v1.11.1
type AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator 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.AnalyzeOrgPoliciesResponse_OrgPolicyResult, nextPageToken string, err error) // contains filtered or unexported fields }
AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator manages a stream of *assetpb.AnalyzeOrgPoliciesResponse_OrgPolicyResult.
func (*AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator) All ¶ added in v1.20.1
func (it *AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator) All() iter.Seq2[*assetpb.AnalyzeOrgPoliciesResponse_OrgPolicyResult, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator) Next ¶ added in v1.11.1
func (it *AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator) Next() (*assetpb.AnalyzeOrgPoliciesResponse_OrgPolicyResult, 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 (*AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator) PageInfo ¶ added in v1.11.1
func (it *AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator ¶ added in v1.11.1
type AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator 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.AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAsset, nextPageToken string, err error) // contains filtered or unexported fields }
AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator manages a stream of *assetpb.AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAsset.
func (*AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator) All ¶ added in v1.20.1
func (it *AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator) All() iter.Seq2[*assetpb.AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAsset, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator) Next ¶ added in v1.11.1
func (it *AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator) Next() (*assetpb.AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAsset, 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 (*AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator) PageInfo ¶ added in v1.11.1
func (it *AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator ¶ added in v1.11.1
type AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator 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.AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainer, nextPageToken string, err error) // contains filtered or unexported fields }
AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator manages a stream of *assetpb.AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainer.
func (*AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator) All ¶ added in v1.20.1
func (it *AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator) All() iter.Seq2[*assetpb.AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainer, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator) Next ¶ added in v1.11.1
func (it *AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator) Next() (*assetpb.AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainer, 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 (*AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator) PageInfo ¶ added in v1.11.1
func (it *AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
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) All ¶ added in v1.20.1
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
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 { ExportAssets []gax.CallOption ListAssets []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 AnalyzeMove []gax.CallOption QueryAssets []gax.CallOption CreateSavedQuery []gax.CallOption GetSavedQuery []gax.CallOption ListSavedQueries []gax.CallOption UpdateSavedQuery []gax.CallOption DeleteSavedQuery []gax.CallOption BatchGetEffectiveIamPolicies []gax.CallOption AnalyzeOrgPolicies []gax.CallOption AnalyzeOrgPolicyGovernedContainers []gax.CallOption AnalyzeOrgPolicyGovernedAssets []gax.CallOption GetOperation []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 // 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 Cloud Asset API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Asset service definition.
func NewClient ¶
NewClient creates a new asset service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Asset service definition.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func NewRESTClient ¶ added in v1.11.0
NewRESTClient creates a new asset service rest client.
Asset service definition.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/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 := asset.NewRESTClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
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 "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.AnalyzeIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#AnalyzeIamPolicyRequest. } resp, err := c.AnalyzeIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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 metadata for the long-running operation.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.AnalyzeIamPolicyLongrunningRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#AnalyzeIamPolicyLongrunningRequest. } 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 }
Output:
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) AnalyzeMove ¶
func (c *Client) AnalyzeMove(ctx context.Context, req *assetpb.AnalyzeMoveRequest, opts ...gax.CallOption) (*assetpb.AnalyzeMoveResponse, error)
AnalyzeMove analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user’s permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.AnalyzeMoveRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#AnalyzeMoveRequest. } resp, err := c.AnalyzeMove(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) AnalyzeOrgPolicies ¶ added in v1.11.1
func (c *Client) AnalyzeOrgPolicies(ctx context.Context, req *assetpb.AnalyzeOrgPoliciesRequest, opts ...gax.CallOption) *AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator
AnalyzeOrgPolicies analyzes organization policies under a scope.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" "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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.AnalyzeOrgPoliciesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#AnalyzeOrgPoliciesRequest. } it := c.AnalyzeOrgPolicies(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.(*assetpb.AnalyzeOrgPoliciesResponse) } }
Output:
Example (All) ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.AnalyzeOrgPoliciesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#AnalyzeOrgPoliciesRequest. } for resp, err := range c.AnalyzeOrgPolicies(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) AnalyzeOrgPolicyGovernedAssets ¶ added in v1.11.1
func (c *Client) AnalyzeOrgPolicyGovernedAssets(ctx context.Context, req *assetpb.AnalyzeOrgPolicyGovernedAssetsRequest, opts ...gax.CallOption) *AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator
AnalyzeOrgPolicyGovernedAssets analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following canned constraints:
constraints/ainotebooks.accessMode constraints/ainotebooks.disableFileDownloads constraints/ainotebooks.disableRootAccess constraints/ainotebooks.disableTerminal constraints/ainotebooks.environmentOptions constraints/ainotebooks.requireAutoUpgradeSchedule constraints/ainotebooks.restrictVpcNetworks constraints/compute.disableGuestAttributesAccess constraints/compute.disableInstanceDataAccessApis constraints/compute.disableNestedVirtualization constraints/compute.disableSerialPortAccess constraints/compute.disableSerialPortLogging constraints/compute.disableVpcExternalIpv6 constraints/compute.requireOsLogin constraints/compute.requireShieldedVm constraints/compute.restrictLoadBalancerCreationForTypes constraints/compute.restrictProtocolForwardingCreationForTypes constraints/compute.restrictXpnProjectLienRemoval constraints/compute.setNewProjectDefaultToZonalDNSOnly constraints/compute.skipDefaultNetworkCreation constraints/compute.trustedImageProjects constraints/compute.vmCanIpForward constraints/compute.vmExternalIpAccess constraints/gcp.detailedAuditLoggingMode constraints/gcp.resourceLocations constraints/iam.allowedPolicyMemberDomains constraints/iam.automaticIamGrantsForDefaultServiceAccounts constraints/iam.disableServiceAccountCreation constraints/iam.disableServiceAccountKeyCreation constraints/iam.disableServiceAccountKeyUpload constraints/iam.restrictCrossProjectServiceAccountLienRemoval constraints/iam.serviceAccountKeyExpiryHours constraints/resourcemanager.accessBoundaries constraints/resourcemanager.allowedExportDestinations constraints/sql.restrictAuthorizedNetworks constraints/sql.restrictNoncompliantDiagnosticDataAccess constraints/sql.restrictNoncompliantResourceCreation constraints/sql.restrictPublicIp constraints/storage.publicAccessPrevention constraints/storage.restrictAuthTypes constraints/storage.uniformBucketLevelAccess
This RPC only returns either resources of types supported by search APIs (at https://cloud.google.com/asset-inventory/docs/supported-asset-types) or IAM policies.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" "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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.AnalyzeOrgPolicyGovernedAssetsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#AnalyzeOrgPolicyGovernedAssetsRequest. } it := c.AnalyzeOrgPolicyGovernedAssets(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.(*assetpb.AnalyzeOrgPolicyGovernedAssetsResponse) } }
Output:
Example (All) ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.AnalyzeOrgPolicyGovernedAssetsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#AnalyzeOrgPolicyGovernedAssetsRequest. } for resp, err := range c.AnalyzeOrgPolicyGovernedAssets(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) AnalyzeOrgPolicyGovernedContainers ¶ added in v1.11.1
func (c *Client) AnalyzeOrgPolicyGovernedContainers(ctx context.Context, req *assetpb.AnalyzeOrgPolicyGovernedContainersRequest, opts ...gax.CallOption) *AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator
AnalyzeOrgPolicyGovernedContainers analyzes organization policies governed containers (projects, folders or organization) under a scope.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" "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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.AnalyzeOrgPolicyGovernedContainersRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#AnalyzeOrgPolicyGovernedContainersRequest. } it := c.AnalyzeOrgPolicyGovernedContainers(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.(*assetpb.AnalyzeOrgPolicyGovernedContainersResponse) } }
Output:
Example (All) ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.AnalyzeOrgPolicyGovernedContainersRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#AnalyzeOrgPolicyGovernedContainersRequest. } for resp, err := range c.AnalyzeOrgPolicyGovernedContainers(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
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 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 "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.BatchGetAssetsHistoryRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#BatchGetAssetsHistoryRequest. } resp, err := c.BatchGetAssetsHistory(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) BatchGetEffectiveIamPolicies ¶ added in v1.3.0
func (c *Client) BatchGetEffectiveIamPolicies(ctx context.Context, req *assetpb.BatchGetEffectiveIamPoliciesRequest, opts ...gax.CallOption) (*assetpb.BatchGetEffectiveIamPoliciesResponse, error)
BatchGetEffectiveIamPolicies gets effective IAM policies for a batch of resources.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.BatchGetEffectiveIamPoliciesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#BatchGetEffectiveIamPoliciesRequest. } resp, err := c.BatchGetEffectiveIamPolicies(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
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
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) 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 "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.CreateFeedRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#CreateFeedRequest. } resp, err := c.CreateFeed(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateSavedQuery ¶ added in v1.3.0
func (c *Client) CreateSavedQuery(ctx context.Context, req *assetpb.CreateSavedQueryRequest, opts ...gax.CallOption) (*assetpb.SavedQuery, error)
CreateSavedQuery creates a saved query in a parent project/folder/organization.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.CreateSavedQueryRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#CreateSavedQueryRequest. } resp, err := c.CreateSavedQuery(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/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.DeleteFeedRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#DeleteFeedRequest. } err = c.DeleteFeed(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteSavedQuery ¶ added in v1.3.0
func (c *Client) DeleteSavedQuery(ctx context.Context, req *assetpb.DeleteSavedQueryRequest, opts ...gax.CallOption) error
DeleteSavedQuery deletes a saved query.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.DeleteSavedQueryRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#DeleteSavedQueryRequest. } err = c.DeleteSavedQuery(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/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 Protobuf 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 "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.ExportAssetsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#ExportAssetsRequest. } 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/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.GetFeedRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#GetFeedRequest. } resp, err := c.GetFeed(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetOperation ¶ added in v1.4.0
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" asset "cloud.google.com/go/asset/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := asset.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 }
Output:
func (*Client) GetSavedQuery ¶ added in v1.3.0
func (c *Client) GetSavedQuery(ctx context.Context, req *assetpb.GetSavedQueryRequest, opts ...gax.CallOption) (*assetpb.SavedQuery, error)
GetSavedQuery gets details about a saved query.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.GetSavedQueryRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#GetSavedQueryRequest. } resp, err := c.GetSavedQuery(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" "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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.ListAssetsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#ListAssetsRequest. } 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 // 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.(*assetpb.ListAssetsResponse) } }
Output:
Example (All) ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.ListAssetsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#ListAssetsRequest. } for resp, err := range c.ListAssets(ctx, req).All() { 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/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.ListFeedsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#ListFeedsRequest. } resp, err := c.ListFeeds(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ListSavedQueries ¶ added in v1.3.0
func (c *Client) ListSavedQueries(ctx context.Context, req *assetpb.ListSavedQueriesRequest, opts ...gax.CallOption) *SavedQueryIterator
ListSavedQueries lists all saved queries in a parent project/folder/organization.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" "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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.ListSavedQueriesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#ListSavedQueriesRequest. } it := c.ListSavedQueries(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.(*assetpb.ListSavedQueriesResponse) } }
Output:
Example (All) ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.ListSavedQueriesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#ListSavedQueriesRequest. } for resp, err := range c.ListSavedQueries(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) QueryAssets ¶ added in v1.4.0
func (c *Client) QueryAssets(ctx context.Context, req *assetpb.QueryAssetsRequest, opts ...gax.CallOption) (*assetpb.QueryAssetsResponse, error)
QueryAssets issue a job that queries assets using a SQL statement compatible with BigQuery SQL (at https://cloud.google.com/bigquery/docs/introduction-sql).
If the query execution finishes within timeout and there’s no pagination, the full query results will be returned in the QueryAssetsResponse.
Otherwise, full query results can be obtained by issuing extra requests with the job_reference from the a previous QueryAssets call.
Note, the query result has approximately 10 GB limitation enforced by BigQuery (at https://cloud.google.com/bigquery/docs/best-practices-performance-output). Queries return larger results will result in errors.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.QueryAssetsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#QueryAssetsRequest. } resp, err := c.QueryAssets(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
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" assetpb "cloud.google.com/go/asset/apiv1/assetpb" "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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.SearchAllIamPoliciesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#SearchAllIamPoliciesRequest. } 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 // 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.(*assetpb.SearchAllIamPoliciesResponse) } }
Output:
Example (All) ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.SearchAllIamPoliciesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#SearchAllIamPoliciesRequest. } for resp, err := range c.SearchAllIamPolicies(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) SearchAllResources ¶
func (c *Client) SearchAllResources(ctx context.Context, req *assetpb.SearchAllResourcesRequest, opts ...gax.CallOption) *ResourceSearchResultIterator
SearchAllResources searches all Google 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" assetpb "cloud.google.com/go/asset/apiv1/assetpb" "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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.SearchAllResourcesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#SearchAllResourcesRequest. } 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 // 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.(*assetpb.SearchAllResourcesResponse) } }
Output:
Example (All) ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.SearchAllResourcesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#SearchAllResourcesRequest. } for resp, err := range c.SearchAllResources(ctx, req).All() { 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/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.UpdateFeedRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#UpdateFeedRequest. } resp, err := c.UpdateFeed(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateSavedQuery ¶ added in v1.3.0
func (c *Client) UpdateSavedQuery(ctx context.Context, req *assetpb.UpdateSavedQueryRequest, opts ...gax.CallOption) (*assetpb.SavedQuery, error)
UpdateSavedQuery updates a saved query.
Example ¶
package main import ( "context" asset "cloud.google.com/go/asset/apiv1" assetpb "cloud.google.com/go/asset/apiv1/assetpb" ) 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 := asset.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &assetpb.UpdateSavedQueryRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/asset/apiv1/assetpb#UpdateSavedQueryRequest. } resp, err := c.UpdateSavedQuery(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.
type 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) All ¶ added in v1.20.1
func (it *IamPolicySearchResultIterator) All() iter.Seq2[*assetpb.IamPolicySearchResult, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
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.
type 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) All ¶ added in v1.20.1
func (it *ResourceSearchResultIterator) All() iter.Seq2[*assetpb.ResourceSearchResult, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
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.
type SavedQueryIterator ¶ added in v1.3.0
type SavedQueryIterator 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.SavedQuery, nextPageToken string, err error) // contains filtered or unexported fields }
SavedQueryIterator manages a stream of *assetpb.SavedQuery.
func (*SavedQueryIterator) All ¶ added in v1.20.1
func (it *SavedQueryIterator) All() iter.Seq2[*assetpb.SavedQuery, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*SavedQueryIterator) Next ¶ added in v1.3.0
func (it *SavedQueryIterator) Next() (*assetpb.SavedQuery, 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 (*SavedQueryIterator) PageInfo ¶ added in v1.3.0
func (it *SavedQueryIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.