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 about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go .
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 . 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
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.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
AnalyzeIamPolicyLongrunningOperation
type
AnalyzeIamPolicyLongrunningOperation
struct
{
// contains filtered or unexported fields
}
AnalyzeIamPolicyLongrunningOperation manages a long-running operation from AnalyzeIamPolicyLongrunning.
func (*AnalyzeIamPolicyLongrunningOperation) Done
func
(
op
*
AnalyzeIamPolicyLongrunningOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*AnalyzeIamPolicyLongrunningOperation) Metadata
func
(
op
*
AnalyzeIamPolicyLongrunningOperation
)
Metadata
()
(
*
assetpb
.
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.
AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator
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) Next
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
func
(
it
*
AnalyzeOrgPoliciesResponse_OrgPolicyResultIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator
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) Next
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
func
(
it
*
AnalyzeOrgPolicyGovernedAssetsResponse_GovernedAssetIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator
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) Next
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
func
(
it
*
AnalyzeOrgPolicyGovernedContainersResponse_GovernedContainerIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
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.
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.
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
}
func NewRESTClient
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
}
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
}
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
}
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
}
func (*Client) AnalyzeOrgPolicies
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
}
}
func (*Client) AnalyzeOrgPolicyGovernedAssets
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 10 canned constraints:
storage.uniformBucketLevelAccess
iam.disableServiceAccountKeyCreation
iam.allowedPolicyMemberDomains
compute.vmExternalIpAccess
appengine.enforceServiceAccountActAsCheck
gcp.resourceLocations
compute.trustedImageProjects
compute.skipDefaultNetworkCreation
compute.requireOsLogin
compute.disableNestedVirtualization
This RPC only returns either resources of types supported by searchable asset types (at https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_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
}
}
func (*Client) AnalyzeOrgPolicyGovernedContainers
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
}
}
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
}
func (*Client) BatchGetEffectiveIamPolicies
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
}
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
}
func (*Client) CreateSavedQuery
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
}
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.
}
}
func (*Client) DeleteSavedQuery
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.
}
}
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
}
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
}
func (*Client) GetOperation
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
"google.golang.org/genproto/googleapis/longrunning"
)
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/google.golang.org/genproto/googleapis/longrunning#GetOperationRequest.
}
resp
,
err
:=
c
.
GetOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetSavedQuery
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
}
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
}
}
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
}
func (*Client) ListSavedQueries
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
}
}
func (*Client) QueryAssets
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 Standard SQL (at http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-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 https://cloud.google.com/bigquery/docs/best-practices-performance-output (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
}
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
}
}
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
}
}
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
}
func (*Client) UpdateSavedQuery
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
}
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.
IamPolicySearchResultIterator
type
IamPolicySearchResultIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
assetpb
.
IamPolicySearchResult
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
IamPolicySearchResultIterator manages a stream of *assetpb.IamPolicySearchResult.
func (*IamPolicySearchResultIterator) Next
func
(
it
*
IamPolicySearchResultIterator
)
Next
()
(
*
assetpb
.
IamPolicySearchResult
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*IamPolicySearchResultIterator) PageInfo
func
(
it
*
IamPolicySearchResultIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ResourceSearchResultIterator
type
ResourceSearchResultIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
assetpb
.
ResourceSearchResult
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ResourceSearchResultIterator manages a stream of *assetpb.ResourceSearchResult.
func (*ResourceSearchResultIterator) Next
func
(
it
*
ResourceSearchResultIterator
)
Next
()
(
*
assetpb
.
ResourceSearchResult
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ResourceSearchResultIterator) PageInfo
func
(
it
*
ResourceSearchResultIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
SavedQueryIterator
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) Next
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
func
(
it
*
SavedQueryIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
