Module types (1.2.0)

API documentation for asset_v1.types module.

Classes

AccessLevel

API documentation for asset_v1.types.AccessLevel class.

AccessPolicy

API documentation for asset_v1.types.AccessPolicy class.

Any

API documentation for asset_v1.types.Any class.

An asset in Google Cloud. An asset can be any resource in the Google Cloud resource hierarchy <https://cloud.google.com/resource- manager/docs/cloud-platform-resource-hierarchy>, a resource outside the Google Cloud resource hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy). See Supported asset types <https://cloud.google.com/asset- inventory/docs/supported-asset-types> for more information.

The full name of the asset. Example: //compute.googleapis.co m/projects/my_project_123/zones/zone1/instances/instance1 See Resource names <https://cloud.google.com/apis/design/reso urce_names#full_resource_name>__ for more information.

A representation of the resource.

A representation of an organization policy <https://cloud.google.com/resource-manager/docs/organization- policy/overview#organization_policy>__. There can be more than one organization policy with different constraints set on a given resource.

Please also refer to the access policy user guide <https://cloud.google.com/access-context- manager/docs/overview#access-policies>__.

Please also refer to the service perimeter user guide <https://cloud.google.com/vpc-service- controls/docs/overview>__.

AuditConfig

API documentation for asset_v1.types.AuditConfig class.

AuditConfigDelta

API documentation for asset_v1.types.AuditConfigDelta class.

AuditLogConfig

API documentation for asset_v1.types.AuditLogConfig class.

BasicLevel

API documentation for asset_v1.types.BasicLevel class.

BatchGetAssetsHistoryRequest

Batch get assets history request.

A list of the full names of the assets. See: https://cloud.google.com/asset-inventory/docs/resource-name- format Example: //compute.googleapis.com/projects/my_projec t_123/zones/zone1/instances/instance1. 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.

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.

BatchGetAssetsHistoryResponse

Batch get assets history response.

BigQueryDestination

A BigQuery destination for exporting assets to.

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.

Binding

API documentation for asset_v1.types.Binding class.

BindingDelta

API documentation for asset_v1.types.BindingDelta class.

CancelOperationRequest

API documentation for asset_v1.types.CancelOperationRequest class.

Condition

API documentation for asset_v1.types.Condition class.

CreateFeedRequest

Create asset feed request.

Required. This is the client-assigned asset feed identifier and it needs to be unique under a specific parent project/folder/organization.

CustomLevel

API documentation for asset_v1.types.CustomLevel class.

DeleteFeedRequest

DeleteOperationRequest

API documentation for asset_v1.types.DeleteOperationRequest class.

DevicePolicy

API documentation for asset_v1.types.DevicePolicy class.

Empty

API documentation for asset_v1.types.Empty class.

ExportAssetsRequest

Export asset request.

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 content type. If not specified, no content but the asset name will be returned.

ExportAssetsResponse

The export asset response. This message is returned by the [google.lon grunning.Operations.GetOperation][google.longrunning.Operations.GetOpe ration] method in the returned [google.longrunning.Operation.response] [google.longrunning.Operation.response] field.

Output configuration indicating where the results were output to.

Expr

API documentation for asset_v1.types.Expr class.

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.

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: //compute.goo gleapis.com/projects/my_project_123/zones/zone1/instances/inst ance1. See Resource Names <https://cloud.google.com/apis/de sign/resource_names#full_resource_name>__ for more info.

Asset content type. If not specified, no content but the asset name and type will be returned.

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, expression field in the Expr must be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with expression (“temporal_asset.deleted == true”) will only publish Asset deletions. Other fields in Expr are optional.

FeedOutputConfig

Output configuration for asset feed destination.

Destination on Pub/Sub.

FieldMask

API documentation for asset_v1.types.FieldMask class.

GcsDestination

A Cloud Storage location.

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 <https://cloud.google.com/storage/docs/viewing-editing- metadata>__ for more information.

GetFeedRequest

Get asset feed request.

GetOperationRequest

API documentation for asset_v1.types.GetOperationRequest class.

IamPolicySearchResult

A result of IAM Policy search, containing information of an IAM policy.

The project that the associated GCP 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, the project field will be empty. To search against the project: - specify the scope field as this project in your search request.

Explanation about the IAM policy search result. It contains additional information to explain why the search result matches the query.

ListFeedsRequest

List asset feeds request.

ListFeedsResponse

ListOperationsRequest

API documentation for asset_v1.types.ListOperationsRequest class.

ListOperationsResponse

API documentation for asset_v1.types.ListOperationsResponse class.

ListValue

API documentation for asset_v1.types.ListValue class.

Operation

API documentation for asset_v1.types.Operation class.

OperationInfo

API documentation for asset_v1.types.OperationInfo class.

OsConstraint

API documentation for asset_v1.types.OsConstraint class.

OutputConfig

Output configuration for export assets destination.

Destination on Cloud Storage.

Policy

API documentation for asset_v1.types.Policy class.

PolicyDelta

API documentation for asset_v1.types.PolicyDelta class.

PubsubDestination

A Pub/Sub destination.

Resource

A representation of a Google Cloud resource.

The URL of the discovery document containing the resource’s JSON schema. Example: https://www.googleapis.com/discovery/v 1/apis/compute/v1/rest This value is unspecified for resources that do not have an API based on a discovery document, such as Cloud Bigtable.

The REST URL for accessing the resource. An HTTP GET request using this URL returns the resource itself. Example: https://cloudresourcemanager.googleapis.com/v1/projects/my- project-123 This value is unspecified for resources without a REST API.

The content of the resource, in which some sensitive fields are removed and may not be present.

ResourceSearchResult

A result of Resource Search, containing information of a cloud resoure.

The type of this resource. Example: compute.googleapis.com/Disk. To search against the asset_type: - specify the asset_type field in your search request.

The display name of this resource. To search against the display_name: - use a field query. Example: displayName : "My Instance" - use a free text query. Example: "My Instance"

Location can be global, regional like us-east1, or zonal like us-west1-b. To search against the location: - use a field query. Example: location : "us-west*" - use a free text query. Example: "us-west*"

Network tags associated with this resource. Like labels, network tags are a type of annotations used to group GCP resources. See Labelling GCP resources <https://cloud.google.com/blog/products/gcp/labelling-and- grouping-your-google-cloud-platform-resources>__ for more information. To search against the network_tags: - use a field query. Example: networkTags : "internal" - use a free text query. Example: "internal"

SearchAllIamPoliciesRequest

Search all IAM policies request.

Optional. The query statement. An empty query can be specified to search all the IAM policies within the given scope. Examples: - policy : "amy@gmail.com" to find Cloud IAM policy bindings that specify user “amy@gmail.com”. - policy : "roles/compute.admin" to find Cloud IAM policy bindings that specify the Compute Admin role. - policy.role.permissions : "storage.buckets.update" to find Cloud IAM policy bindings that specify a role containing “storage.buckets.update” permission. - resource : "organizations/123" to find Cloud IAM policy bindings that are set on “organizations/123”. - (resource : ("organizations/123" OR "folders/1234") AND policy : "amy") to find Cloud IAM policy bindings that are set on “organizations/123” or “folders/1234”, and also specify user “amy”. See how to construct a query <https://cloud.google.com/asset-inventory/docs/searching-iam- policies#how_to_construct_a_query>__ for more details.

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

SearchAllIamPoliciesResponse

Search all IAM policies response.

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 page_token.

SearchAllResourcesRequest

Search all resources request.

Optional. The query statement. An empty query can be specified to search all the resources of certain asset_types within the given scope. Examples: - name : "Important" to find Cloud resources whose name contains “Important” as a word. - displayName : "Impor*" to find Cloud resources whose display name contains “Impor” as a word prefix. - description : "*por*" to find Cloud resources whose description contains “por” as a substring. - location : "us-west*" to find Cloud resources whose location is prefixed with “us-west”. - labels : "prod" to find Cloud resources whose labels contain “prod” as a key or value. - labels.env : "prod" to find Cloud resources which have a label “env” and its value is “prod”. - labels.env : * to find Cloud resources which have a label “env”. - "Important" to find Cloud resources which contain “Important” as a word in any of the searchable fields. - "Impor*" to find Cloud resources which contain “Impor” as a word prefix in any of the searchable fields. - "*por*" to find Cloud resources which contain “por” as a substring in any of the searchable fields. - ("Important" AND location : ("us-west1" OR "global")) to find Cloud resources which contain “Important” as a word in any of the searchable fields and are also located in the “us-west1” region or the “global” location. See how to construct a query <https://cloud.google.com/asset- inventory/docs/searching- resources#how_to_construct_a_query>__ for more details.

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, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

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”. See supported resource metadata fields <https://cloud.google.com/asset-inventory/docs/searching- resources#query_on_resource_metadata_fields>__ for more details.

State of prior_asset.