Index
AssetService(interface)AnalyzeIamPolicyLongrunningMetadata(message)AnalyzeIamPolicyLongrunningRequest(message)AnalyzeIamPolicyLongrunningResponse(message)AnalyzeIamPolicyRequest(message)AnalyzeIamPolicyResponse(message)AnalyzeIamPolicyResponse.IamPolicyAnalysis(message)AnalyzeMoveRequest(message)AnalyzeMoveRequest.AnalysisView(enum)AnalyzeMoveResponse(message)AnalyzeOrgPoliciesRequest(message)AnalyzeOrgPoliciesResponse(message)AnalyzeOrgPoliciesResponse.OrgPolicyResult(message)AnalyzeOrgPolicyGovernedAssetsRequest(message)AnalyzeOrgPolicyGovernedAssetsResponse(message)AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset(message)AnalyzeOrgPolicyGovernedAssetsResponse.GovernedIamPolicy(message)AnalyzeOrgPolicyGovernedAssetsResponse.GovernedResource(message)AnalyzeOrgPolicyGovernedContainersRequest(message)AnalyzeOrgPolicyGovernedContainersResponse(message)AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer(message)AnalyzerOrgPolicy(message)AnalyzerOrgPolicy.Rule(message)AnalyzerOrgPolicy.Rule.StringValues(message)AnalyzerOrgPolicyConstraint(message)AnalyzerOrgPolicyConstraint.Constraint(message)AnalyzerOrgPolicyConstraint.Constraint.BooleanConstraint(message)AnalyzerOrgPolicyConstraint.Constraint.ConstraintDefault(enum)AnalyzerOrgPolicyConstraint.Constraint.ListConstraint(message)AnalyzerOrgPolicyConstraint.CustomConstraint(message)AnalyzerOrgPolicyConstraint.CustomConstraint.ActionType(enum)AnalyzerOrgPolicyConstraint.CustomConstraint.MethodType(enum)Asset(message)AssetEnrichment(message)AttachedResource(message)BatchGetAssetsHistoryRequest(message)BatchGetAssetsHistoryResponse(message)BatchGetEffectiveIamPoliciesRequest(message)BatchGetEffectiveIamPoliciesResponse(message)BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy(message)BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.PolicyInfo(message)BigQueryDestination(message)ConditionEvaluation(message)ConditionEvaluation.EvaluationValue(enum)ContentType(enum)CreateFeedRequest(message)CreateSavedQueryRequest(message)DeleteFeedRequest(message)DeleteSavedQueryRequest(message)EffectiveTagDetails(message)ExportAssetsRequest(message)ExportAssetsResponse(message)Feed(message)FeedOutputConfig(message)GcsDestination(message)GcsOutputResult(message)GetFeedRequest(message)GetSavedQueryRequest(message)IamPolicyAnalysisOutputConfig(message)IamPolicyAnalysisOutputConfig.BigQueryDestination(message)IamPolicyAnalysisOutputConfig.BigQueryDestination.PartitionKey(enum)IamPolicyAnalysisOutputConfig.GcsDestination(message)IamPolicyAnalysisQuery(message)IamPolicyAnalysisQuery.AccessSelector(message)IamPolicyAnalysisQuery.ConditionContext(message)IamPolicyAnalysisQuery.IdentitySelector(message)IamPolicyAnalysisQuery.Options(message)IamPolicyAnalysisQuery.ResourceSelector(message)IamPolicyAnalysisResult(message)IamPolicyAnalysisResult.Access(message)IamPolicyAnalysisResult.AccessControlList(message)IamPolicyAnalysisResult.Edge(message)IamPolicyAnalysisResult.Identity(message)IamPolicyAnalysisResult.IdentityList(message)IamPolicyAnalysisResult.Resource(message)IamPolicyAnalysisState(message)IamPolicySearchResult(message)IamPolicySearchResult.Explanation(message)IamPolicySearchResult.Explanation.Permissions(message)ListAssetsRequest(message)ListAssetsResponse(message)ListFeedsRequest(message)ListFeedsResponse(message)ListSavedQueriesRequest(message)ListSavedQueriesResponse(message)MoveAnalysis(message)MoveAnalysisResult(message)MoveImpact(message)OutputConfig(message)OutputResult(message)PartitionSpec(message)PartitionSpec.PartitionKey(enum)PubsubDestination(message)QueryAssetsOutputConfig(message)QueryAssetsOutputConfig.BigQueryDestination(message)QueryAssetsRequest(message)QueryAssetsResponse(message)QueryResult(message)RelatedAsset(message)RelatedAssets(message) (deprecated)RelatedResource(message)RelatedResources(message)RelationshipAttributes(message) (deprecated)Resource(message)ResourceOwners(message)ResourceSearchResult(message)SavedQuery(message)SavedQuery.QueryContent(message)SearchAllIamPoliciesRequest(message)SearchAllIamPoliciesResponse(message)SearchAllResourcesRequest(message)SearchAllResourcesResponse(message)TableFieldSchema(message)TableSchema(message)Tag(message)TemporalAsset(message)TemporalAsset.PriorAssetState(enum)TimeWindow(message)UpdateFeedRequest(message)UpdateSavedQueryRequest(message)VersionedResource(message)
AssetService
Asset service definition.
| AnalyzeIamPolicy |
|---|
|
Analyzes IAM policies to answer which identities have what accesses on which resources.
|
| 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
|
| 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.
|
| AnalyzeOrgPolicies |
|---|
|
Analyzes organization policies under a scope.
|
| AnalyzeOrgPolicyGovernedAssets |
|---|
|
Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following canned constraints:
This RPC only returns either resources of types supported by search APIs or IAM policies.
|
| AnalyzeOrgPolicyGovernedContainers |
|---|
|
Analyzes organization policies governed containers (projects, folders or organization) under a scope.
|
| 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.
|
| BatchGetEffectiveIamPolicies |
|---|
|
Gets effective IAM policies for a batch of resources.
|
| CreateFeed |
|---|
|
Creates a feed in a parent project/folder/organization to listen to its asset updates.
|
| CreateSavedQuery |
|---|
|
Creates a saved query in a parent project/folder/organization.
|
| DeleteFeed |
|---|
|
Deletes an asset feed.
|
| DeleteSavedQuery |
|---|
|
Deletes a saved query.
|
| 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
|
| GetFeed |
|---|
|
Gets details about an asset feed.
|
| GetSavedQuery |
|---|
|
Gets details about a saved query.
|
| ListAssets |
|---|
|
Lists assets with time and resource types and returns paged results in response.
|
| ListFeeds |
|---|
|
Lists all asset feeds in a parent project/folder/organization.
|
| ListSavedQueries |
|---|
|
Lists all saved queries in a parent project/folder/organization.
|
| QueryAssets |
|---|
|
Issue a job that queries assets using a SQL statement compatible with BigQuery SQL. If the query execution finishes within timeout and there's no pagination, the full query results will be returned in the Otherwise, full query results can be obtained by issuing extra requests with the Note, the query result has approximately 10 GB limitation enforced by BigQuery. Queries return larger results will result in errors.
|
| SearchAllIamPolicies |
|---|
|
Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the
|
| SearchAllResources |
|---|
|
Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the
|
| UpdateFeed |
|---|
|
Updates an asset feed configuration.
|
| UpdateSavedQuery |
|---|
|
Updates a saved query.
|
AnalyzeIamPolicyLongrunningMetadata
Represents the metadata of the longrunning operation for the AnalyzeIamPolicyLongrunning RPC.
| Fields | |
|---|---|
create_time |
Output only. The time the operation was created. |
AnalyzeIamPolicyLongrunningRequest
A request message for AssetService.AnalyzeIamPolicyLongrunning.
| Fields | |
|---|---|
analysis_query |
Required. The request query. |
saved_analysis_query |
Optional. The name of a saved query, which must be in the format of:
If both Note that you cannot override primitive fields with default value, such as 0 or empty string, etc., because we use proto3, which doesn't support field presence yet. |
output_config |
Required. Output configuration indicating where the results will be output to. |
AnalyzeIamPolicyLongrunningResponse
This type has no fields.
A response message for AssetService.AnalyzeIamPolicyLongrunning.
AnalyzeIamPolicyRequest
A request message for AssetService.AnalyzeIamPolicy.
| Fields | |
|---|---|
analysis_query |
Required. The request query. |
saved_analysis_query |
Optional. The name of a saved query, which must be in the format of:
If both Note that you cannot override primitive fields with default value, such as 0 or empty string, etc., because we use proto3, which doesn't support field presence yet. |
execution_timeout |
Optional. Amount of time executable has to complete. See JSON representation of Duration. If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty. |
AnalyzeIamPolicyResponse
A response message for AssetService.AnalyzeIamPolicy.
| Fields | |
|---|---|
main_analysis |
The main analysis that matches the original request. |
service_account_impersonation_analysis[] |
The service account impersonation analysis if [AnalyzeIamPolicyRequest.analyze_service_account_impersonation][] is enabled. |
fully_explored |
Represents whether all entries in the |
IamPolicyAnalysis
An analysis message to group the query and results.
| Fields | |
|---|---|
analysis_query |
The analysis query. |
analysis_results[] |
A list of |
fully_explored |
Represents whether all entries in the |
non_critical_errors[] |
A list of non-critical errors happened during the query handling. |
AnalyzeMoveRequest
The request message for performing resource move analysis.
| Fields | |
|---|---|
resource |
Required. Name of the resource to perform the analysis against. Only Google Cloud projects are supported as of today. Hence, this can only be a project ID (such as "projects/my-project-id") or a project number (such as "projects/12345"). |
destination_parent |
Required. Name of the Google Cloud folder or organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified desitination parent. This can only be a folder number (such as "folders/123") or an organization number (such as "organizations/123"). |
view |
Analysis view indicating what information should be included in the analysis response. If unspecified, the default view is FULL. |
AnalysisView
View enum for supporting partial analysis responses.
| Enums | |
|---|---|
ANALYSIS_VIEW_UNSPECIFIED |
The default/unset value. The API will default to the FULL view. |
FULL |
Full analysis including all level of impacts of the specified resource move. |
BASIC |
Basic analysis only including blockers which will prevent the specified resource move at runtime. |
AnalyzeMoveResponse
The response message for resource move analysis.
| Fields | |
|---|---|
move_analysis[] |
The list of analyses returned from performing the intended resource move analysis. The analysis is grouped by different Google Cloud services. |
AnalyzeOrgPoliciesRequest
A request message for AssetService.AnalyzeOrgPolicies.
| Fields | |
|---|---|
scope |
Required. The organization to scope the request. Only organization policies within the scope will be analyzed.
Authorization requires one or more of the following IAM permissions on the specified resource
|
constraint |
Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint. |
filter |
The expression to filter When filtering by a specific field, the only supported operator is |
page_token |
The pagination token to retrieve the next page. |
page_size |
The maximum number of items to return per page. If unspecified, |
AnalyzeOrgPoliciesResponse
The response message for AssetService.AnalyzeOrgPolicies.
| Fields | |
|---|---|
org_policy_results[] |
The organization policies under the |
constraint |
The definition of the constraint in the request. |
next_page_token |
The page token to fetch the next page for |
OrgPolicyResult
The organization policy result to the query.
| Fields | |
|---|---|
consolidated_policy |
The consolidated organization policy for the analyzed resource. The consolidated organization policy is computed by merging and evaluating [AnalyzeOrgPoliciesResponse.policy_bundle][]. The evaluation will respect the organization policy hierarchy rules. |
policy_bundle[] |
The ordered list of all organization policies from the [AnalyzeOrgPoliciesResponse.OrgPolicyResult.consolidated_policy.attached_resource][]. to the scope specified in the request. If the constraint is defined with default policy, it will also appear in the list. |
project |
The project that this consolidated policy belongs to, in the format of projects/{PROJECT_NUMBER}. This field is available when the consolidated policy belongs to a project. |
folders[] |
The folder(s) that this consolidated policy belongs to, in the format of folders/{FOLDER_NUMBER}. This field is available when the consolidated policy belongs (directly or cascadingly) to one or more folders. |
organization |
The organization that this consolidated policy belongs to, in the format of organizations/{ORGANIZATION_NUMBER}. This field is available when the consolidated policy belongs (directly or cascadingly) to an organization. |
AnalyzeOrgPolicyGovernedAssetsRequest
A request message for AssetService.AnalyzeOrgPolicyGovernedAssets.
| Fields | |
|---|---|
scope |
Required. The organization to scope the request. Only organization policies within the scope will be analyzed. The output assets will also be limited to the ones governed by those in-scope organization policies.
Authorization requires one or more of the following IAM permissions on the specified resource
|
constraint |
Required. The name of the constraint to analyze governed assets for. The analysis only contains analyzed organization policies for the provided constraint. |
filter |
The expression to filter For governed resources, filtering is currently available for bare literal values and the following fields: * governed_resource.project * governed_resource.folders * consolidated_policy.rules.enforce When filtering by For governed IAM policies, filtering is currently available for bare literal values and the following fields: * governed_iam_policy.project * governed_iam_policy.folders * consolidated_policy.rules.enforce When filtering by |
page_token |
The pagination token to retrieve the next page. |
page_size |
The maximum number of items to return per page. If unspecified, |
AnalyzeOrgPolicyGovernedAssetsResponse
The response message for AssetService.AnalyzeOrgPolicyGovernedAssets.
| Fields | |
|---|---|
governed_assets[] |
The list of the analyzed governed assets. |
constraint |
The definition of the constraint in the request. |
next_page_token |
The page token to fetch the next page for |
GovernedAsset
Represents a Google Cloud asset(resource or IAM policy) governed by the organization policies of the AnalyzeOrgPolicyGovernedAssetsRequest.constraint.
| Fields | |
|---|---|
consolidated_policy |
The consolidated policy for the analyzed asset. The consolidated policy is computed by merging and evaluating |
policy_bundle[] |
The ordered list of all organization policies from the [AnalyzeOrgPoliciesResponse.OrgPolicyResult.consolidated_policy.attached_resource][] to the scope specified in the request. If the constraint is defined with default policy, it will also appear in the list. |
Union field
|
|
governed_resource |
A Google Cloud resource governed by the organization policies of the |
governed_iam_policy |
An IAM policy governed by the organization policies of the |
GovernedIamPolicy
The IAM policies governed by the organization policies of the AnalyzeOrgPolicyGovernedAssetsRequest.constraint.
| Fields | |
|---|---|
attached_resource |
The full resource name of the resource on which this IAM policy is set. Example: |
policy |
The IAM policy directly set on the given resource. |
project |
The project that this IAM policy belongs to, in the format of projects/{PROJECT_NUMBER}. This field is available when the IAM policy belongs to a project. |
folders[] |
The folder(s) that this IAM policy belongs to, in the format of folders/{FOLDER_NUMBER}. This field is available when the IAM policy belongs (directly or cascadingly) to one or more folders. |
organization |
The organization that this IAM policy belongs to, in the format of organizations/{ORGANIZATION_NUMBER}. This field is available when the IAM policy belongs (directly or cascadingly) to an organization. |
asset_type |
The asset type of the |
GovernedResource
The Google Cloud resources governed by the organization policies of the AnalyzeOrgPolicyGovernedAssetsRequest.constraint.
| Fields | |
|---|---|
full_resource_name |
The full resource name of the Google Cloud resource. |
parent |
The full resource name of the parent of |
project |
The project that this resource belongs to, in the format of projects/{PROJECT_NUMBER}. This field is available when the resource belongs to a project. |
folders[] |
The folder(s) that this resource belongs to, in the format of folders/{FOLDER_NUMBER}. This field is available when the resource belongs (directly or cascadingly) to one or more folders. |
organization |
The organization that this resource belongs to, in the format of organizations/{ORGANIZATION_NUMBER}. This field is available when the resource belongs (directly or cascadingly) to an organization. |
asset_type |
The asset type of the |
effective_tags[] |
The effective tags on this resource. |
AnalyzeOrgPolicyGovernedContainersRequest
A request message for AssetService.AnalyzeOrgPolicyGovernedContainers.
| Fields | |
|---|---|
scope |
Required. The organization to scope the request. Only organization policies within the scope will be analyzed. The output containers will also be limited to the ones governed by those in-scope organization policies.
Authorization requires one or more of the following IAM permissions on the specified resource
|
constraint |
Required. The name of the constraint to analyze governed containers for. The analysis only contains organization policies for the provided constraint. |
filter |
The expression to filter When filtering by a specific field, the only supported operator is |
page_token |
The pagination token to retrieve the next page. |
page_size |
The maximum number of items to return per page. If unspecified, |
AnalyzeOrgPolicyGovernedContainersResponse
The response message for AssetService.AnalyzeOrgPolicyGovernedContainers.
| Fields | |
|---|---|
governed_containers[] |
The list of the analyzed governed containers. |
constraint |
The definition of the constraint in the request. |
next_page_token |
The page token to fetch the next page for |
GovernedContainer
The organization/folder/project resource governed by organization policies of AnalyzeOrgPolicyGovernedContainersRequest.constraint.
| Fields | |
|---|---|
full_resource_name |
The full resource name of an organization/folder/project resource. |
parent |
The full resource name of the parent of |
consolidated_policy |
The consolidated organization policy for the analyzed resource. The consolidated organization policy is computed by merging and evaluating |
policy_bundle[] |
The ordered list of all organization policies from the [AnalyzeOrgPoliciesResponse.OrgPolicyResult.consolidated_policy.attached_resource][]. to the scope specified in the request. If the constraint is defined with default policy, it will also appear in the list. |
project |
The project that this resource belongs to, in the format of projects/{PROJECT_NUMBER}. This field is available when the resource belongs to a project. |
folders[] |
The folder(s) that this resource belongs to, in the format of folders/{FOLDER_NUMBER}. This field is available when the resource belongs (directly or cascadingly) to one or more folders. |
organization |
The organization that this resource belongs to, in the format of organizations/{ORGANIZATION_NUMBER}. This field is available when the resource belongs (directly or cascadingly) to an organization. |
effective_tags[] |
The effective tags on this resource. |
AnalyzerOrgPolicy
This organization policy message is a modified version of the one defined in the Organization Policy system. This message contains several fields defined in the original organization policy with some new fields for analysis purpose.
| Fields | |
|---|---|
attached_resource |
The full resource name of an organization/folder/project resource where this organization policy is set. Notice that some type of constraints are defined with default policy. This field will be empty for them. |
applied_resource |
The full resource name of an organization/folder/project resource where this organization policy applies to. For any user defined org policies, this field has the same value as the [attached_resource] field. Only for default policy, this field has the different value. |
rules[] |
List of rules for this organization policy. |
inherit_from_parent |
If |
reset |
Ignores policies set above this resource and restores the default behavior of the constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, |
Rule
This rule message is a customized version of the one defined in the Organization Policy system. In addition to the fields defined in the original organization policy, it contains additional field(s) under specific circumstances to support analysis results.
| Fields | |
|---|---|
condition |
The evaluating condition for this rule. |
condition_evaluation |
The condition evaluation result for this rule. Only populated if it meets all the following criteria:
|
Union field
|
|
values |
List of values to be used for this policy rule. This field can be set only in policies for list constraints. |
allow_all |
Setting this to true means that all values are allowed. This field can be set only in Policies for list constraints. |
deny_all |
Setting this to true means that all values are denied. This field can be set only in Policies for list constraints. |
enforce |
If |
StringValues
The string values for the list constraints.
| Fields | |
|---|---|
allowed_values[] |
List of values allowed at this resource. |
denied_values[] |
List of values denied at this resource. |
AnalyzerOrgPolicyConstraint
The organization policy constraint definition.
| Fields | |
|---|---|
Union field
|
|
google_defined_constraint |
The definition of the canned constraint defined by Google. |
custom_constraint |
The definition of the custom constraint. |
Constraint
The definition of a constraint.
| Fields | |
|---|---|
name |
The unique name of the constraint. Format of the name should be * For example, |
display_name |
The human readable name of the constraint. |
description |
Detailed description of what this |
constraint_default |
The evaluation behavior of this constraint in the absence of 'Policy'. |
Union field Immutable after creation. |
|
list_constraint |
Defines this constraint as being a ListConstraint. |
boolean_constraint |
Defines this constraint as being a BooleanConstraint. |
BooleanConstraint
This type has no fields.
A Constraint that is either enforced or not.
For example a constraint constraints/compute.disableSerialPortAccess. If it is enforced on a VM instance, serial port connections will not be opened to that instance.
ConstraintDefault
Specifies the default behavior in the absence of any Policy for the Constraint. This must not be CONSTRAINT_DEFAULT_UNSPECIFIED.
| Enums | |
|---|---|
CONSTRAINT_DEFAULT_UNSPECIFIED |
This is only used for distinguishing unset values and should never be used. |
ALLOW |
Indicate that all values are allowed for list constraints. Indicate that enforcement is off for boolean constraints. |
DENY |
Indicate that all values are denied for list constraints. Indicate that enforcement is on for boolean constraints. |
ListConstraint
A Constraint that allows or disallows a list of string values, which are configured by an organization's policy administrator with a Policy.
| Fields | |
|---|---|
supports_in |
Indicates whether values grouped into categories can be used in |
supports_under |
Indicates whether subtrees of Cloud Resource Manager resource hierarchy can be used in |
CustomConstraint
The definition of a custom constraint.
| Fields | |
|---|---|
name |
Name of the constraint. This is unique within the organization. Format of the name should be * Example : "organizations/123/customConstraints/custom.createOnlyE2TypeVms" |
resource_types[] |
The Resource Instance type on which this policy applies to. Format will be of the form : " |
method_types[] |
All the operations being applied for this constraint. |
condition |
Organization Policy condition/expression. For example: |
action_type |
Allow or deny type. |
display_name |
One line display name for the UI. |
description |
Detailed information about this custom policy constraint. |
ActionType
Allow or deny type.
| Enums | |
|---|---|
ACTION_TYPE_UNSPECIFIED |
Unspecified. Will results in user error. |
ALLOW |
Allowed action type. |
DENY |
Deny action type. |
MethodType
The operation in which this constraint will be applied. For example: If the constraint applies only when create VMs, the method_types will be "CREATE" only. If the constraint applied when create or delete VMs, the method_types will be "CREATE" and "DELETE".
| Enums | |
|---|---|
METHOD_TYPE_UNSPECIFIED |
Unspecified. Will results in user error. |
CREATE |
Constraint applied when creating the resource. |
UPDATE |
Constraint applied when updating the resource. |
DELETE |
Constraint applied when deleting the resource. |
REMOVE_GRANT |
Constraint applied when removing an IAM grant. |
GOVERN_TAGS |
Constraint applied when enforcing forced tagging. |
Asset
An asset in Google Cloud. An asset can be any resource in the Google Cloud resource hierarchy, a resource outside the Google Cloud resource hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy), or a relationship (e.g. an INSTANCE_TO_INSTANCEGROUP relationship). See Supported asset types for more information.
| Fields | |
|---|---|
update_time |
The last update timestamp of an asset. update_time is updated when create/update/delete operation is performed. |
name |
The full name of the asset. Example: See Resource names for more information. |
asset_type |
The type of the asset. Example: See Supported asset types for more information. |
resource |
A representation of the resource. |
iam_policy |
A representation of the IAM policy set on a Google Cloud resource. There can be a maximum of one IAM policy set on any given resource. In addition, IAM policies inherit their granted access scope from any policies set on parent resources in the resource hierarchy. Therefore, the effectively policy is the union of both the policy set on this resource and each policy set on all of the resource's ancestry resource levels in the hierarchy. See this topic for more information. |
org_policy[] |
A representation of an organization policy. There can be more than one organization policy with different constraints set on a given resource. |
os_inventory |
A representation of runtime OS Inventory information. See this topic for more information. |
related_assets |
DEPRECATED. This field only presents for the purpose of backward-compatibility. The server will never generate responses with this field. The related assets of the asset of one relationship type. One asset only represents one type of relationship. |
related_asset |
One related asset of the current asset. |
ancestors[] |
The ancestry path of an asset in Google Cloud resource hierarchy, represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the asset is a project, folder, or organization, the ancestry path starts from the asset itself. Example: |
Union field access_context_policy. A representation of an access policy. access_context_policy can be only one of the following: |
|
access_policy |
Also refer to the access policy user guide. |
access_level |
Also refer to the access level user guide. |
service_perimeter |
Also refer to the service perimeter user guide. |
AssetEnrichment
The enhanced metadata information for a resource.
| Fields | |
|---|---|
Union field
|
|
resource_owners |
The resource owners for a resource. Note that this field only contains the members that have "roles/owner" role in the resource's IAM Policy. |
AttachedResource
Attached resource representation, which is defined by the corresponding service provider. It represents an attached resource's payload.
| Fields | |
|---|---|
asset_type |
The type of this attached resource. Example: You can find the supported attached asset types of each resource in this table: |
versioned_resources[] |
Versioned resource representations of this attached resource. This is repeated because there could be multiple versions of the attached resource representations during version migration. |
BatchGetAssetsHistoryRequest
Batch get assets history request.
| Fields | |
|---|---|
parent |
Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). Authorization requires one or more of the following IAM permissions on the specified resource
|
asset_names[] |
A list of the full names of the assets. See: https://cloud.google.com/asset-inventory/docs/resource-name-format Example:
The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request. |
content_type |
Optional. The content type. |
read_time_window |
Optional. The time window for the asset history. Both start_time and end_time are optional and if set, it must be after the current time minus 35 days. If end_time is not set, it is default to current timestamp. If start_time is not set, the snapshot of the assets at end_time will be returned. The returned results contain all temporal assets whose time window overlap with read_time_window. |
relationship_types[] |
Optional. A list of relationship types to output, for example: |
BatchGetAssetsHistoryResponse
Batch get assets history response.
| Fields | |
|---|---|
assets[] |
A list of assets with valid time windows. |
BatchGetEffectiveIamPoliciesRequest
A request message for AssetService.BatchGetEffectiveIamPolicies.
| Fields | |
|---|---|
scope |
Required. Only IAM policies on or below the scope will be returned. This can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"). To know how to get organization ID, visit here . To know how to get folder or project ID, visit here . Authorization requires one or more of the following IAM permissions on the specified resource
|
names[] |
Required. The names refer to the full_resource_names of the asset types supported by search APIs. A maximum of 20 resources' effective policies can be retrieved in a batch. |
BatchGetEffectiveIamPoliciesResponse
A response message for AssetService.BatchGetEffectiveIamPolicies.
| Fields | |
|---|---|
policy_results[] |
The effective policies for a batch of resources. Note that the results order is the same as the order of |
EffectiveIamPolicy
The effective IAM policies on one resource.
| Fields | |
|---|---|
full_resource_name |
The full_resource_name for which the |
policies[] |
The effective policies for the These policies include the policy set on the These policies are hierarchically ordered by |
PolicyInfo
The IAM policy and its attached resource.
| Fields | |
|---|---|
attached_resource |
The full resource name the |
policy |
The IAM policy that's directly attached to the |
BigQueryDestination
A BigQuery destination for exporting assets to.
| Fields | |
|---|---|
dataset |
Required. The BigQuery dataset in format "projects/projectId/datasets/datasetId", to which the snapshot result should be exported. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error. Setting the |
table |
Required. The BigQuery table to which the snapshot result should be written. If this table does not exist, a new table with the given name will be created. |
force |
If the destination table already exists and this flag is |
partition_spec |
[partition_spec] determines whether to export to partitioned table(s) and how to partition the data. If [partition_spec] is unset or [partition_spec.partition_key] is unset or If [partition_spec] is specified. First, the snapshot results will be written to partitioned table(s) with two additional timestamp columns, readTime and requestTime, one of which will be the partition key. Secondly, in the case when any destination table already exists, it will first try to update existing table's schema as necessary by appending additional columns. Then, if [force] is |
separate_tables_per_asset_type |
If this flag is Field [table] will be concatenated with "_" and the asset type names (see https://cloud.google.com/asset-inventory/docs/supported-asset-types for supported asset types) to construct per-asset-type table names, in which all non-alphanumeric characters like "." and "/" will be substituted by "_". Example: if field [table] is "mytable" and snapshot results contain "storage.googleapis.com/Bucket" assets, the corresponding table name will be "mytable_storage_googleapis_com_Bucket". If any of these tables does not exist, a new table with the concatenated name will be created. When [content_type] in the ExportAssetsRequest is If error occurs when exporting to any table, the whole export call will return an error but the export results that already succeed will persist. Example: if exporting to table_type_A succeeds when exporting to table_type_B fails during one export call, the results in table_type_A will persist and there will not be partial results persisting in a table. |
ConditionEvaluation
The condition evaluation.
| Fields | |
|---|---|
evaluation_value |
The evaluation result. |
EvaluationValue
Value of this expression.
| Enums | |
|---|---|
EVALUATION_VALUE_UNSPECIFIED |
Reserved for future use. |
TRUE |
The evaluation result is true. |
FALSE |
The evaluation result is false. |
CONDITIONAL |
The evaluation result is conditional when the condition expression contains variables that are either missing input values or have not been supported by Policy Analyzer yet. |
ContentType
Asset content type.
| Enums | |
|---|---|
CONTENT_TYPE_UNSPECIFIED |
Unspecified content type. |
RESOURCE |
Resource metadata. |
IAM_POLICY |
The actual IAM policy set on a resource. |
ORG_POLICY |
The organization policy set on an asset. |
ACCESS_POLICY |
The Access Context Manager policy set on an asset. |
OS_INVENTORY |
The runtime OS Inventory information. |
RELATIONSHIP |
The related resources. |
CreateFeedRequest
Create asset feed request.
| Fields | |
|---|---|
parent |
Required. The name of the project/folder/organization where this feed should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"). |
feed_id |
Required. This is the client-assigned asset feed identifier and it needs to be unique under a specific parent project/folder/organization. |
feed |
Required. The feed details. The field |
CreateSavedQueryRequest
Request to create a saved query.
| Fields | |
|---|---|
parent |
Required. The name of the project/folder/organization where this saved_query should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"). |
saved_query |
Required. The saved_query details. The |
saved_query_id |
Required. The ID to use for the saved query, which must be unique in the specified parent. It will become the final component of the saved query's resource name. This value should be 4-63 characters, and valid characters are Notice that this field is required in the saved query creation, and the |
DeleteFeedRequest
| Fields | |
|---|---|
name |
Required. The name of the feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id |
DeleteSavedQueryRequest
Request to delete a saved query.
| Fields | |
|---|---|
name |
Required. The name of the saved query to delete. It must be in the format of:
|
EffectiveTagDetails
The effective tags and the ancestor resources from which they were inherited.
| Fields | |
|---|---|
effective_tags[] |
The effective tags inherited from the |
attached_resource |
The full resource name of the ancestor from which an [effective_tag][] is inherited, according to tag inheritance. |
ExportAssetsRequest
Export asset request.
| Fields | |
|---|---|
parent |
Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"), or a folder number (such as "folders/123"). Authorization requires one or more of the following IAM permissions on the specified resource
|
read_time |
Timestamp to take an asset snapshot. This can only be set to a timestamp between the current time and the current time minus 35 days (inclusive). If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results. |
asset_types[] |
A list of asset types to take a snapshot for. For example: "compute.googleapis.com/Disk". Regular expressions are also supported. For example:
See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned. If specified, only matching assets will be returned, otherwise, it will snapshot all asset types. See Introduction to Cloud Asset Inventory for all supported asset types. |
content_type |
Asset content type. If not specified, no content but the asset name will be returned. |
output_config |
Required. Output configuration indicating where the results will be output to. |
relationship_types[] |
A list of relationship types to export, for example: |
ExportAssetsResponse
The export asset response. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.
| Fields | |
|---|---|
read_time |
Time the snapshot was taken. |
output_config |
Output configuration indicating where the results were output to. |
output_result |
Output result indicating where the assets were exported to. For example, a set of actual Cloud Storage object URIs where the assets are exported to. The URIs can be different from what [output_config] has specified, as the service will split the output object into multiple ones once it exceeds a single Cloud Storage object limit. |
Feed
An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Pub/Sub topics.
| Fields | |
|---|---|
name |
Required. The format will be projects/{project_number}/feeds/{client-assigned_feed_identifier} or folders/{folder_number}/feeds/{client-assigned_feed_identifier} or organizations/{organization_number}/feeds/{client-assigned_feed_identifier} The client-assigned feed identifier must be unique within the parent project/folder/organization. |
asset_names[] |
A list of the full names of the assets to receive updates. You must specify either or both of asset_names and asset_types. Only asset updates matching specified asset_names or asset_types are exported to the feed. Example: |
asset_types[] |
A list of types of the assets to receive updates. You must specify either or both of asset_names and asset_types. Only asset updates matching specified asset_names or asset_types are exported to the feed. Example: For a list of all supported asset types, see Supported asset types. |
content_type |
Asset content type. If not specified, no content but the asset name and type will be returned. |
feed_output_config |
Required. Feed output configuration defining where the asset updates are published to. |
condition |
A condition which determines whether an asset update should be published. If specified, an asset will be returned only when the expression evaluates to true. When set, See our user guide for detailed instructions. |
relationship_types[] |
A list of relationship types to output, for example: |
FeedOutputConfig
Output configuration for asset feed destination.
| Fields | |
|---|---|
Union field destination. Asset feed destination. destination can be only one of the following: |
|
pubsub_destination |
Destination on Pub/Sub. |
GcsDestination
A Cloud Storage location.
| Fields | |
|---|---|
Union field object_uri. Required. object_uri can be only one of the following: |
|
uri |
The URI of the Cloud Storage object. It's the same URI that is used by gsutil. Example: "gs://bucket_name/object_name". See Viewing and Editing Object Metadata for more information. If the specified Cloud Storage object already exists and there is no hold, it will be overwritten with the exported result. |
uri_prefix |
The URI prefix of all generated Cloud Storage objects. Example: "gs://bucket_name/object_name_prefix". Each object URI is in format: "gs://bucket_name/object_name_prefix/ |
GcsOutputResult
A Cloud Storage output result.
| Fields | |
|---|---|
uris[] |
List of URIs of the Cloud Storage objects. Example: "gs://bucket_name/object_name". |
GetFeedRequest
Get asset feed request.
| Fields | |
|---|---|
name |
Required. The name of the Feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id |
GetSavedQueryRequest
Request to get a saved query.
| Fields | |
|---|---|
name |
Required. The name of the saved query and it must be in the format of:
|
IamPolicyAnalysisOutputConfig
Output configuration for export IAM policy analysis destination.
| Fields | |
|---|---|
Union field destination. IAM policy analysis export destination. destination can be only one of the following: |
|
gcs_destination |
Destination on Cloud Storage. |
bigquery_destination |
Destination on BigQuery. |
BigQueryDestination
A BigQuery destination.
| Fields | |
|---|---|
dataset |
Required. The BigQuery dataset in format "projects/projectId/datasets/datasetId", to which the analysis results should be exported. If this dataset does not exist, the export call will return an INVALID_ARGUMENT error. |
table_prefix |
Required. The prefix of the BigQuery tables to which the analysis results will be written. Tables will be created based on this table_prefix if not exist: * |
partition_key |
The partition key for BigQuery partitioned table. |
write_disposition |
Optional. Specifies the action that occurs if the destination table or partition already exists. The following values are supported:
The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Details are at https://cloud.google.com/bigquery/docs/loading-data-local#appending_to_or_overwriting_a_table_using_a_local_file. |
PartitionKey
This enum determines the partition key column for the bigquery tables. Partitioning can improve query performance and reduce query cost by filtering partitions. Refer to https://cloud.google.com/bigquery/docs/partitioned-tables for details.
| Enums | |
|---|---|
PARTITION_KEY_UNSPECIFIED |
Unspecified partition key. Tables won't be partitioned using this option. |
REQUEST_TIME |
The time when the request is received. If specified as partition key, the result table(s) is partitoned by the RequestTime column, an additional timestamp column representing when the request was received. |
GcsDestination
A Cloud Storage location.
| Fields | |
|---|---|
uri |
Required. The URI of the Cloud Storage object. It's the same URI that is used by gsutil. Example: "gs://bucket_name/object_name". See Viewing and Editing Object Metadata for more information. If the specified Cloud Storage object already exists and there is no hold, it will be overwritten with the analysis result. |
IamPolicyAnalysisQuery
IAM policy analysis query message.
| Fields | |
|---|---|
scope |
Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"). To know how to get organization ID, visit here . To know how to get folder or project ID, visit here . Authorization requires one or more of the following IAM permissions on the specified resource
|
resource_selector |
Optional. Specifies a resource for analysis. |
identity_selector |
Optional. Specifies an identity for analysis. |
access_selector |
Optional. Specifies roles or permissions for analysis. This is optional. |
options |
Optional. The query options. |
condition_context |
Optional. The hypothetical context for IAM conditions evaluation. |
AccessSelector
Specifies roles and/or permissions to analyze, to determine both the identities possessing them and the resources they control. If multiple values are specified, results will include roles or permissions matching any of them. The total number of roles and permissions should be equal or less than 10.
| Fields | |
|---|---|
roles[] |
Optional. The roles to appear in result. |
permissions[] |
Optional. The permissions to appear in result. |
ConditionContext
The IAM conditions context.
| Fields | |
|---|---|
Union field TimeContext. The IAM conditions time context. TimeContext can be only one of the following: |
|
access_time |
The hypothetical access timestamp to evaluate IAM conditions. Note that this value must not be earlier than the current time; otherwise, an INVALID_ARGUMENT error will be returned. |
IdentitySelector
Specifies an identity for which to determine resource access, based on roles assigned either directly to them or to the groups they belong to, directly or indirectly.
| Fields | |
|---|---|
identity |
Required. The identity appear in the form of principals in IAM policy binding. The examples of supported forms are: "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com". Notice that wildcard characters (such as * and ?) are not supported. You must give a specific identity. |
Options
Contains query options.
| Fields | |
|---|---|
expand_groups |
Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding. If If true, the default max expansion per group is 1000 for AssetService.AnalyzeIamPolicy][]. Default is false. |
expand_roles |
Optional. If true, the access section of result will expand any roles appearing in IAM policy bindings to include their permissions. If Default is false. |
expand_resources |
Optional. If true and For example, if the request analyzes for which resources user A has permission P, and the results include an IAM policy with P on a Google Cloud folder, the results will also include resources in that folder with permission P. If true and For example, if the request analyzes for which users have permission P on a Google Cloud project with this option enabled, the results will include all users who have permission P on that project or any lower resource. If true, the default max expansion per resource is 1000 for AssetService.AnalyzeIamPolicy][] and 100000 for AssetService.AnalyzeIamPolicyLongrunning][]. Default is false. |
output_resource_edges |
Optional. If true, the result will output the relevant parent/child relationships between resources. Default is false. |
output_group_edges |
Optional. If true, the result will output the relevant membership relationships between groups and other groups, and between groups and principals. Default is false. |
analyze_service_account_impersonation |
Optional. If true, the response will include access analysis from identities to resources via service account impersonation. This is a very expensive operation, because many derived queries will be executed. We highly recommend you use For example, if the request analyzes for which resources user A has permission P, and there's an IAM policy states user A has iam.serviceAccounts.getAccessToken permission to a service account SA, and there's another IAM policy states service account SA has permission P to a Google Cloud folder F, then user A potentially has access to the Google Cloud folder F. And those advanced analysis results will be included in Another example, if the request analyzes for who has permission P to a Google Cloud folder F, and there's an IAM policy states user A has iam.serviceAccounts.actAs permission to a service account SA, and there's another IAM policy states service account SA has permission P to the Google Cloud folder F, then user A potentially has access to the Google Cloud folder F. And those advanced analysis results will be included in Only the following permissions are considered in this analysis:
Default is false. |
ResourceSelector
Specifies the resource to analyze for access policies, which may be set directly on the resource, or on ancestors such as organizations, folders or projects.
| Fields | |
|---|---|
full_resource_name |
Required. The full resource name of a resource of supported resource types. |
IamPolicyAnalysisResult
IAM Policy analysis result, consisting of one IAM policy binding and derived access control lists.
| Fields | |
|---|---|
attached_resource_full_name |
The full resource name of the resource to which the |
iam_binding |
The IAM policy binding under analysis. |
access_control_lists[] |
The access control lists derived from the |
identity_list |
The identity list derived from members of the |
fully_explored |
Represents whether all analyses on the |
Access
An IAM role or permission under analysis.
| Fields | |
|---|---|
analysis_state |
The analysis state of this access. |
Union field
|
|
role |
The role. |
permission |
The permission. |
AccessControlList
An access control list, derived from the above IAM policy binding, which contains a set of resources and accesses. May include one item from each set to compose an access control entry.
NOTICE that there could be multiple access control lists for one IAM policy binding. The access control lists are created based on resource and access combinations.
For example, assume we have the following cases in one IAM policy binding: - Permission P1 and P2 apply to resource R1 and R2; - Permission P3 applies to resource R2 and R3;
This will result in the following access control lists: - AccessControlList 1: [R1, R2], [P1, P2] - AccessControlList 2: [R2, R3], [P3]
| Fields | |
|---|---|
resources[] |
The resources that match one of the following conditions: - The resource_selector, if it is specified in request; - Otherwise, resources reachable from the policy attached resource. |
accesses[] |
The accesses that match one of the following conditions: - The access_selector, if it is specified in request; - Otherwise, access specifiers reachable from the policy binding's role. |
resource_edges[] |
Resource edges of the graph starting from the policy attached resource to any descendant resources. The |
condition_evaluation |
Condition evaluation for this AccessControlList, if there is a condition defined in the above IAM policy binding. |
Edge
A directional edge.
| Fields | |
|---|---|
source_node |
The source node of the edge. For example, it could be a full resource name for a resource node or an email of an identity. |
target_node |
The target node of the edge. For example, it could be a full resource name for a resource node or an email of an identity. |
Identity
An identity under analysis.
| Fields | |
|---|---|
name |
The identity of members, formatted as appear in an IAM policy binding. For example, they might be formatted like the following:
|
analysis_state |
The analysis state of this identity. |
IdentityList
The identities and group edges.
| Fields | |
|---|---|
identities[] |
Only the identities that match one of the following conditions will be presented: - The identity_selector, if it is specified in request; - Otherwise, identities reachable from the policy binding's members. |
group_edges[] |
Group identity edges of the graph starting from the binding's group members to any node of the |
Resource
A Google Cloud resource under analysis.
| Fields | |
|---|---|
full_resource_name |
|
analysis_state |
The analysis state of this resource. |
IamPolicyAnalysisState
Represents the detailed state of an entity under analysis, such as a resource, an identity or an access.
| Fields | |
|---|---|
code |
The Google standard error code that best describes the state. For example: - OK means the analysis on this entity has been successfully finished; - PERMISSION_DENIED means an access denied error is encountered; - DEADLINE_EXCEEDED means the analysis on this entity hasn't been started in time; |
cause |
The human-readable description of the cause of failure. |
IamPolicySearchResult
A result of IAM Policy search, containing information of an IAM policy.
| Fields | |
|---|---|
resource |
The full resource name of the resource associated with this IAM policy. Example: To search against the
|
asset_type |
The type of the resource associated with this IAM policy. Example: To search against the
|
project |
The project that the associated Google Cloud resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, this field will be empty. To search against the
|
folders[] |
The folder(s) that the IAM policy belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the IAM policy belongs to one or more folders. To search against
|
organization |
The organization that the IAM policy belongs to, in the form of organizations/{ORGANIZATION_NUMBER}. This field is available when the IAM policy belongs to an organization. To search against
|
policy |
The IAM policy directly set on the given resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constrain on policies (e.g., an empty query), this contains all the bindings. To search against the
|
explanation |
Explanation about the IAM policy search result. It contains additional information to explain why the search result matches the query. |
Explanation
Explanation about the IAM policy search result.
| Fields | |
|---|---|
matched_permissions |
The map from roles to their included permissions that match the permission query (i.e., a query containing |
Permissions
IAM permissions
| Fields | |
|---|---|
permissions[] |
A list of permissions. A sample permission string: |
ListAssetsRequest
ListAssets request.
| Fields | |
|---|---|
parent |
Required. Name of the organization, folder, or project the assets belong to. Format: "organizations/[organization-number]" (such as "organizations/123"), "projects/[project-id]" (such as "projects/my-project-id"), "projects/[project-number]" (such as "projects/12345"), or "folders/[folder-number]" (such as "folders/12345"). Authorization requires one or more of the following IAM permissions on the specified resource
|
read_time |
Timestamp to take an asset snapshot. This can only be set to a timestamp between the current time and the current time minus 35 days (inclusive). If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results. |
asset_types[] |
A list of asset types to take a snapshot for. For example: "compute.googleapis.com/Disk". Regular expression is also supported. For example:
See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned. If specified, only matching assets will be returned, otherwise, it will snapshot all asset types. See Introduction to Cloud Asset Inventory for all supported asset types. |
content_type |
Asset content type. If not specified, no content but the asset name will be returned. |
page_size |
The maximum number of assets to be returned in a single response. Default is 100, minimum is 1, and maximum is 1000. |
page_token |
The |
relationship_types[] |
A list of relationship types to output, for example: |
ListAssetsResponse
ListAssets response.
| Fields | |
|---|---|
read_time |
Time the snapshot was taken. |
assets[] |
Assets. |
next_page_token |
Token to retrieve the next page of results. It expires 72 hours after the page token for the first page is generated. Set to empty if there are no remaining results. |
ListFeedsRequest
List asset feeds request.
| Fields | |
|---|---|
parent |
Required. The parent project/folder/organization whose feeds are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id"). |
ListFeedsResponse
| Fields | |
|---|---|
feeds[] |
A list of feeds. |
ListSavedQueriesRequest
Request to list saved queries.
| Fields | |
|---|---|
parent |
Required. The parent project/folder/organization whose savedQueries are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id"). |
filter |
Optional. The expression to filter resources. The expression is a list of zero or more restrictions combined via logical operators See https://google.aip.dev/160 for more information on the grammar. |
page_size |
Optional. The maximum number of saved queries to return per page. The service may return fewer than this value. If unspecified, at most 50 will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListSavedQueriesResponse
Response of listing saved queries.
| Fields | |
|---|---|
saved_queries[] |
A list of savedQueries. |
next_page_token |
A token, which can be sent as |
MoveAnalysis
A message to group the analysis information.
| Fields | |
|---|---|
display_name |
The user friendly display name of the analysis. E.g. IAM, organization policy etc. |
Union field
|
|
analysis |
Analysis result of moving the target resource. |
error |
Description of error encountered when performing the analysis. |
MoveAnalysisResult
An analysis result including blockers and warnings.
| Fields | |
|---|---|
blockers[] |
Blocking information that would prevent the target resource from moving to the specified destination at runtime. |
warnings[] |
Warning information indicating that moving the target resource to the specified destination might be unsafe. This can include important policy information and configuration changes, but will not block moves at runtime. |
MoveImpact
A message to group impacts of moving the target resource.
| Fields | |
|---|---|
detail |
User friendly impact detail in a free form message. |
OutputConfig
Output configuration for export assets destination.
| Fields | |
|---|---|
Union field destination. Asset export destination. destination can be only one of the following: |
|
gcs_destination |
Destination on Cloud Storage. |
bigquery_destination |
Destination on BigQuery. The output table stores the fields in asset Protobuf as columns in BigQuery. |
OutputResult
Output result of export assets.
| Fields | |
|---|---|
Union field result. Asset export result. result can be only one of the following: |
|
gcs_result |
Export result on Cloud Storage. |
PartitionSpec
Specifications of BigQuery partitioned table as export destination.
| Fields | |
|---|---|
partition_key |
The partition key for BigQuery partitioned table. |
PartitionKey
This enum is used to determine the partition key column when exporting assets to BigQuery partitioned table(s). Note that, if the partition key is a timestamp column, the actual partition is based on its date value (expressed in UTC. see details in https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables).
| Enums | |
|---|---|
PARTITION_KEY_UNSPECIFIED |
Unspecified partition key. If used, it means using non-partitioned table. |
READ_TIME |
The time when the snapshot is taken. If specified as partition key, the result table(s) is partitoned by the additional timestamp column, readTime. If [read_time] in ExportAssetsRequest is specified, the readTime column's value will be the same as it. Otherwise, its value will be the current time that is used to take the snapshot. |
REQUEST_TIME |
The time when the request is received and started to be processed. If specified as partition key, the result table(s) is partitoned by the requestTime column, an additional timestamp column representing when the request was received. |
PubsubDestination
A Pub/Sub destination.
| Fields | |
|---|---|
topic |
The name of the Pub/Sub topic to publish to. Example: |
QueryAssetsOutputConfig
Output configuration query assets.
| Fields | |
|---|---|
bigquery_destination |
BigQuery destination where the query results will be saved. |
BigQueryDestination
BigQuery destination.
| Fields | |
|---|---|
dataset |
Required. The BigQuery dataset where the query results will be saved. It has the format of "projects/{projectId}/datasets/{datasetId}". |
table |
Required. The BigQuery table where the query results will be saved. If this table does not exist, a new table with the given name will be created. |
write_disposition |
Specifies the action that occurs if the destination table or partition already exists. The following values are supported:
The default value is WRITE_EMPTY. |
QueryAssetsRequest
QueryAssets request.
| Fields | |
|---|---|
parent |
Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"), or a folder number (such as "folders/123"). Only assets belonging to the |
page_size |
Optional. The maximum number of rows to return in the results. Responses are limited to 10 MB and 1000 rows. By default, the maximum row count is 1000. When the byte or row count limit is reached, the rest of the query results will be paginated. The field will be ignored when [output_config] is specified. |
page_token |
Optional. A page token received from previous The field will be ignored when [output_config] is specified. |
timeout |
Optional. Specifies the maximum amount of time that the client is willing to wait for the query to complete. By default, this limit is 5 min for the first query, and 1 minute for the following queries. If the query is complete, the Like BigQuery jobs.query API The call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. The field will be ignored when [output_config] is specified. |
output_config |
Optional. Destination where the query results will be saved. When this field is specified, the query results won't be saved in the [QueryAssetsResponse.query_result]. Instead [QueryAssetsResponse.output_config] will be set. Meanwhile, [QueryAssetsResponse.job_reference] will be set and can be used to check the status of the query job when passed to a following [QueryAssets] API call. |
Union field
|
|
statement |
Optional. A SQL statement that's compatible with BigQuery SQL. |
job_reference |
Optional. Reference to the query job, which is from the |
Union field time. Specifies what time period or point in time to query asset metadata at. * unset - query asset metadata as it is right now * [read_time_window] - query asset metadata as it was at any point in time between [start_time] and [end_time]. * [read_time] - query asset metadata as it was at that point in time. If data for the timestamp/date range selected does not exist, it will simply return a valid response with no rows. time can be only one of the following: |
|
read_time_window |
Optional. [start_time] is required. [start_time] must be less than [end_time] Defaults [end_time] to now if [start_time] is set and [end_time] isn't. Maximum permitted time range is 7 days. |
read_time |
Optional. Queries cloud assets as they appeared at the specified point in time. |
QueryAssetsResponse
QueryAssets response.
| Fields | |
|---|---|
job_reference |
Reference to a query job. |
done |
The query response, which can be either an If |
Union field
|
|
error |
Error status. |
query_result |
Result of the query. |
output_config |
Output configuration, which indicates that instead of being returned in an API response on the fly, the query result will be saved in a specific output. |
QueryResult
Execution results of the query.
The result is formatted as rows represented by BigQuery compatible [schema]. When pagination is necessary, it will contains the page token to retrieve the results of following pages.
| Fields | |
|---|---|
rows[] |
Each row hold a query result in the format of |
schema |
Describes the format of the [rows]. |
next_page_token |
Token to retrieve the next page of the results. |
total_rows |
Total rows of the whole query results. |
RelatedAsset
An asset identifier in Google Cloud which contains its name, type and ancestors. An asset can be any resource in the Google Cloud resource hierarchy, a resource outside the Google Cloud resource hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy). See Supported asset types for more information.
| Fields | |
|---|---|
asset |
The full name of the asset. Example: See Resource names for more information. |
asset_type |
The type of the asset. Example: See Supported asset types for more information. |
ancestors[] |
The ancestors of an asset in Google Cloud resource hierarchy, represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. Example: |
relationship_type |
The unique identifier of the relationship type. Example: |
RelatedAssets
DEPRECATED. This message only presents for the purpose of backward-compatibility. The server will never populate this message in responses. The detailed related assets with the relationship_type.
| Fields | |
|---|---|
relationship_attributes |
The detailed relationship attributes. |
assets[] |
The peer resources of the relationship. |
RelatedResource
The detailed related resource.
| Fields | |
|---|---|
asset_type |
The type of the asset. Example: |
full_resource_name |
The full resource name of the related resource. Example: |
RelatedResources
The related resources of the primary resource.
| Fields | |
|---|---|
related_resources[] |
The detailed related resources of the primary resource. |
RelationshipAttributes
DEPRECATED. This message only presents for the purpose of backward-compatibility. The server will never populate this message in responses. The relationship attributes which include type, source_resource_type, target_resource_type and action.
| Fields | |
|---|---|
type |
The unique identifier of the relationship type. Example: |
source_resource_type |
The source asset type. Example: |
target_resource_type |
The target asset type. Example: |
action |
The detail of the relationship, e.g. |
Resource
A representation of a Google Cloud resource.
| Fields | |
|---|---|
version |
The API version. Example: |
discovery_document_uri |
The URL of the discovery document containing the resource's JSON schema. Example: This value is unspecified for resources that do not have an API based on a discovery document, such as Cloud Bigtable. |
discovery_name |
The JSON schema name listed in the discovery document. Example: This value is unspecified for resources that do not have an API based on a discovery document, such as Cloud Bigtable. |
resource_url |
The REST URL for accessing the resource. An HTTP This value is unspecified for resources without a REST API. |
parent |
The full name of the immediate parent of this resource. See Resource Names for more information. For Google Cloud assets, this value is the parent resource defined in the IAM policy hierarchy. Example: |
data |
The content of the resource, in which some sensitive fields are removed and may not be present. |
location |
The location of the resource in Google Cloud, such as its zone and region. For more information, see https://cloud.google.com/about/locations/. |
ResourceOwners
The resource owners information.
| Fields | |
|---|---|
resource_owners[] |
List of resource owners. |
ResourceSearchResult
A result of Resource Search, containing information of a cloud resource.
| Fields | |
|---|---|
name |
The full resource name of this resource. Example: To search against the
|
asset_type |
The type of this resource. Example: To search against the
|
project |
The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}. This field is available when the resource belongs to a project. To search against
|
folders[] |
The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the resource belongs to one or more folders. To search against
|
organization |
The organization that this resource belongs to, in the form of organizations/{ORGANIZATION_NUMBER}. This field is available when the resource belongs to an organization. To search against
|
display_name |
The display name of this resource. This field is available only when the resource's Protobuf contains it. To search against the
|
description |
One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes. This field is available only when the resource's Protobuf contains it. To search against the
|
location |
Location can be To search against the
|
labels |
User labels associated with this resource. See Labelling and grouping Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it. To search against the
|
network_tags[] |
Network tags associated with this resource. Like labels, network tags are a type of annotations used to group Google Cloud resources. See Labelling Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it. To search against the
|
kms_key |
The Cloud KMS CryptoKey name or CryptoKeyVersion name. This field only presents for the purpose of backward compatibility. Use the To search against the
|
kms_keys[] |
The Cloud KMS CryptoKey names or CryptoKeyVersion names. This field is available only when the resource's Protobuf contains it. To search against the
|
create_time |
The create timestamp of this resource, at which the resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it. To search against
|
update_time |
The last update timestamp of this resource, at which the resource was last modified or deleted. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it. To search against
|
state |
The state of this resource. Different resources types have different state definitions that are mapped from various fields of different resource types. This field is available only when the resource's Protobuf contains it. Example: If the resource is an instance provided by Compute Engine, its state will include PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. See To search against the
|
additional_attributes |
The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the Google Cloud service updates to a new incompatible API version. To search against the
|
parent_full_resource_name |
The full resource name of this resource's parent, if it has one. To search against the
|
versioned_resources[] |
Versioned resource representations of this resource. This is repeated because there could be multiple versions of resource representations during version migration. This |
attached_resources[] |
Attached resources of this resource. For example, an OSConfig Inventory is an attached resource of a Compute Instance. This field is repeated because a resource could have multiple attached resources. This |
relationships |
A map of related resources of this resource, keyed by the relationship type. A relationship type is in the format of {SourceType}_{ACTION}_{DestType}. Example: |
tag_keys[] |
This field is only present for the purpose of backward compatibility. Use the TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. To search against the
|
tag_values[] |
This field is only present for the purpose of backward compatibility. Use the TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. To search against the
|
tag_value_ids[] |
This field is only present for the purpose of backward compatibility. Use the TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}. To search against the
|
tags[] |
The tags directly attached to this resource. To search against the
|
effective_tags[] |
The effective tags on this resource. All of the tags that are both attached to and inherited by a resource are collectively called the effective tags. For more information, see tag inheritance. To search against the
|
enrichments[] |
Enrichments of the asset. Currently supported enrichment types with SearchAllResources API:
The corresponding read masks in order to get the enrichment:
The corresponding required permissions:
Example query to get resource owner enrichment: |
parent_asset_type |
The type of this resource's immediate parent, if there is one. To search against the
|
scc_security_marks |
The actual content of Security Command Center security marks associated with the asset. To search against SCC SecurityMarks field:
|
SavedQuery
A saved query which can be shared with others or used later.
| Fields | |
|---|---|
name |
The resource name of the saved query. The format must be:
|
description |
The description of this saved query. This value should be fewer than 255 characters. |
create_time |
Output only. The create time of this saved query. |
creator |
Output only. The account's email address who has created this saved query. |
last_update_time |
Output only. The last update time of this saved query. |
last_updater |
Output only. The account's email address who has updated this saved query most recently. |
labels |
Labels applied on the resource. This value should not contain more than 10 entries. The key and value of each entry must be non-empty and fewer than 64 characters. |
content |
The query content. |
QueryContent
The query content.
| Fields | |
|---|---|
Union field
|
|
iam_policy_analysis_query |
An IAM Policy Analysis query, which could be used in the |
SearchAllIamPoliciesRequest
Search all IAM policies request.
| Fields | |
|---|---|
scope |
Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the The allowed values are:
Authorization requires the following IAM permission on the specified resource
|
query |
Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the IAM policies within the specified Examples:
|
page_size |
Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero or a negative value, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as |
page_token |
Optional. If present, retrieve the next batch of results from the preceding call to this method. |
asset_types[] |
Optional. A list of asset types that the IAM policies are attached to. If empty, it will search the IAM policies that are attached to all the asset types supported by search APIs Regular expressions are also supported. For example:
See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned. |
order_by |
Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "assetType DESC, resource". Only singular primitive fields in the response are sortable: * resource * assetType * project All the other fields such as repeated fields (e.g., |
SearchAllIamPoliciesResponse
Search all IAM policies response.
| Fields | |
|---|---|
results[] |
A list of IAM policies that match the search query. Related information such as the associated resource is returned along with the policy. |
next_page_token |
Set if there are more results than those appearing in this response; to get the next set of results, call this method again, using this value as the |
SearchAllResourcesRequest
Search all resources request.
| Fields | |
|---|---|
scope |
Required. A scope can be a project, a folder, or an organization. The search is limited to the resources within the The allowed values are:
Authorization requires the following IAM permission on the specified resource
|
query |
Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the resources within the specified Examples:
|
asset_types[] |
Optional. A list of asset types that this request searches for. If empty, it will search all the asset types supported by search APIs. Regular expressions are also supported. For example:
See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned. |
page_size |
Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero or a negative value, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as |
page_token |
Optional. If present, then retrieve the next batch of results from the preceding call to this method. |
order_by |
Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only the following fields in the response are sortable:
|
read_mask |
Optional. A comma-separated list of fields that you want returned in the results. The following fields are returned by default if not specified:
Some fields of large size, such as |
SearchAllResourcesResponse
Search all resources response.
| Fields | |
|---|---|
results[] |
A list of Resources that match the search query. It contains the resource standard metadata information. |
next_page_token |
If there are more results than those appearing in this response, then |
TableFieldSchema
A field in TableSchema.
| Fields | |
|---|---|
field |
The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. |
type |
The field data type. Possible values include * STRING * BYTES * INTEGER * FLOAT * BOOLEAN * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY, * NUMERIC, * BIGNUMERIC, * RECORD (where RECORD indicates that the field contains a nested schema). |
mode |
The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
fields[] |
Describes the nested schema fields if the type property is set to RECORD. |
TableSchema
BigQuery Compatible table schema.
| Fields | |
|---|---|
fields[] |
Describes the fields in a table. |
Tag
The key and value for a tag.
| Fields | |
|---|---|
tag_key |
TagKey namespaced name, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. |
tag_key_id |
TagKey ID, in the format of tagKeys/{TAG_KEY_ID}. |
tag_value |
TagValue namespaced name, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. |
tag_value_id |
TagValue ID, in the format of tagValues/{TAG_VALUE_ID}. |
TemporalAsset
An asset in Google Cloud and its temporal metadata, including the time window when it was observed and its status during that window.
| Fields | |
|---|---|
window |
The time window when the asset data and state was observed. |
deleted |
Whether the asset has been deleted or not. |
asset |
An asset in Google Cloud. |
prior_asset_state |
State of prior_asset. |
prior_asset |
Prior copy of the asset. Populated if prior_asset_state is PRESENT. Currently this is only set for responses in Real-Time Feed. |
PriorAssetState
State of prior asset.
| Enums | |
|---|---|
PRIOR_ASSET_STATE_UNSPECIFIED |
prior_asset is not applicable for the current asset. |
PRESENT |
prior_asset is populated correctly. |
INVALID |
Failed to set prior_asset. |
DOES_NOT_EXIST |
Current asset is the first known state. |
DELETED |
prior_asset is a deletion. |
TimeWindow
A time window specified by its start_time and end_time.
| Fields | |
|---|---|
start_time |
Start time of the time window (exclusive). |
end_time |
End time of the time window (inclusive). If not specified, the current timestamp is used instead. |
UpdateFeedRequest
Update asset feed request.
| Fields | |
|---|---|
feed |
Required. The new values of feed details. It must match an existing feed and the field |
update_mask |
Required. Only updates the |
UpdateSavedQueryRequest
Request to update a saved query.
| Fields | |
|---|---|
saved_query |
Required. The saved query to update. The saved query's
|
update_mask |
Required. The list of fields to update. |
VersionedResource
Resource representation as defined by the corresponding service providing the resource for a given API version.
| Fields | |
|---|---|
version |
API version of the resource. Example: If the resource is an instance provided by Compute Engine v1 API as defined in |
resource |
JSON representation of the resource as defined by the corresponding service providing this resource. Example: If the resource is an instance provided by Compute Engine, this field will contain the JSON representation of the instance as defined by Compute Engine: You can find the resource definition for each supported resource type in this table: |