Module types (1.1.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.

Asset

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 Cloud IAM policy.

The type of the asset. For example: compute.googleapis.com/Disk See Supported asset types <https://cloud.google.com/asset-inventory/docs/supported-asset-types>__ for more information.

A representation of the Cloud IAM policy set on a Google Cloud resource. There can be a maximum of one Cloud IAM policy set on any given resource. In addition, Cloud 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 <https://cloud.google.com/iam/docs/policies#inheritance>__ for more information.

A representation of an access policy <https://cloud.google.com/access-context-manager/docs/overview#access-policies>__.

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. .. attribute:: 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").

Optional. The content type.

BatchGetAssetsHistoryResponse

Batch get assets history response. .. attribute:: assets

A list of assets with valid time windows.

BigQueryDestination

A BigQuery destination. .. attribute:: 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.

If the destination table already exists and this flag is TRUE, the table will be overwritten by the contents of assets snapshot. If the flag is FALSE or unset and the destination table already exists, the export call returns an INVALID_ARGUMEMT error.

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. .. attribute:: 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").

Required. The feed details. The field name must be empty and it will be generated in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id

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. .. attribute:: 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”).

A list of asset types of which to take a snapshot for. For example: “compute.googleapis.com/Disk”. If specified, only matching assets will be returned. See Introduction to Cloud Asset Inventory <https://cloud.google.com/asset- inventory/docs/overview>__ for all supported asset types.

Required. Output configuration indicating where the results will be output to. All results will be in newline delimited JSON format.

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. .. attribute:: read_time

Time the snapshot was taken.

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. .. attribute:: 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.

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 and asset_types are exported to the feed. For example: "compute.googleapis.com/Disk" See this topic <https://cloud.google.com/asset-inventory/docs/supported- asset-types>__ for a list of all supported asset types.

Required. Feed output configuration defining where the asset updates are published to.

FeedOutputConfig

Output configuration for asset feed destination. .. attribute:: destination

Asset feed destination.

FieldMask

API documentation for asset_v1.types.FieldMask class.

GcsDestination

A Cloud Storage location. .. attribute:: object_uri

Required.

The uri prefix of all generated Cloud Storage objects. For example: “gs://bucket_name/object_name_prefix”. Each object uri is in format: “gs://bucket_name/object_name_prefix// and only contains assets for that type. starts from 0. For example :”gs://bucket_name/object_name_prefix/compute.googleapis.com/D isk/0" is the first shard of output objects containing all compute.googleapis.com/Disk assets. An INVALID_ARGUMENT error will be returned if file with the same name “gs://bucket_name/object_name_prefix” already exists.

GetFeedRequest

Get asset feed request. .. attribute:: 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

GetOperationRequest

API documentation for asset_v1.types.GetOperationRequest class.

IamPolicySearchResult

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

The full resource name of the resource associated with this IAM policy. Example: //compute.googleapis.com/projects/my_pr oject_123/zones/zone1/instances/instance1. See Cloud Asset Inventory Resource Name Format <https://cloud.google.com/asset-inventory/docs/resource-name- format>__ for more information. To search against the resource: - use a field query. Example: resource : "organizations/123"

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 policy bindings: - use a field query, as following: - query by the policy contained members. Example: policy : "amy@gmail.com" - query by the policy contained roles. Example: policy : "roles/compute.admin" - query by the policy contained roles’ implied permissions. Example: policy.role.permissions : "compute.instances.create"

ListFeedsRequest

List asset feeds request. .. attribute:: 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

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. .. attribute:: destination

Asset export destination.

Destination on BigQuery. The output table stores the fields in asset proto as columns in BigQuery. The resource/iam_policy field is converted to a record with each field to a column, except metadata to a single JSON string.

Policy

API documentation for asset_v1.types.Policy class.

PolicyDelta

API documentation for asset_v1.types.PolicyDelta class.

PubsubDestination

A Pub/Sub destination. .. attribute:: topic

The name of the Pub/Sub topic to publish to. For example: projects/PROJECT_ID/topics/TOPIC_ID.

Resource

A representation of a Google Cloud resource. .. attribute:: version

The API version. For example: v1

The JSON schema name listed in the discovery document. For example: Project This value is unspecified for resources that do not have an API based on a discovery document, such as Cloud Bigtable.

The full name of the immediate parent of this resource. See Resource Names <https://cloud.google.com/apis/design/resource _names#full_resource_name> for more information. For Google Cloud assets, this value is the parent resource defined in the Cloud IAM policy hierarchy <https://cloud.google.com/i am/docs/overview#policy_hierarchy>. For example: //cloudr esourcemanager.googleapis.com/projects/my_project_123 For third-party assets, this field may be set differently.

The location of the resource in Google Cloud, such as its zone and region. For more information, see https://cloud.google.com/about/locations/.

ResourceSearchResult

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

The full resource name of this resource. Example: //compute. googleapis.com/projects/my_project_123/zones/zone1/instances/i nstance1. See Cloud Asset Inventory Resource Name Format <https://cloud.google.com/asset-inventory/docs/resource-name- format>__ for more information. To search against the name: - use a field query. Example: name : "instance1" - use a free text query. Example: "instance1"

The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}. To search against the project:

specify the scope field as this project in your search request.

One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes. To search against the description: - use a field query. Example: description : "*important instance*" - use a free text query. Example: "*important instance*"

Labels associated with this resource. See Labelling and grouping GCP resources <https://cloud.google.com/blog/products/gcp/labelling-and- grouping-your-google-cloud-platform-resources>__ for more information. To search against the labels: - use a field query, as following: - query on any label’s key or value. Example: labels : "prod" - query by a given label. Example: labels.env : "prod" - query by a given label’sexistence. Example: labels.env : * - use a free text query. Example: "prod"

The additional attributes of this resource. The attributes may vary from one resource type to another. Examples: projectId for Project, dnsName for DNS ManagedZone. To search against the additional_attributes: - use a free text query to match the attributes values. Example: to search additional_attributes = { dnsName: "foobar" }, you can issue a query "foobar".

SearchAllIamPoliciesRequest

Search all IAM policies request. .. attribute:: scope

Required. A scope can be a project, a folder or an organization. The search is limited to the IAM policies within the scope. The allowed values are: - projects/{PROJECT_ID} - projects/{PROJECT_NUMBER} - folders/{FOLDER_NUMBER} - organizations/{ORGANIZATION_NUMBER}

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.

SearchAllIamPoliciesResponse

Search all IAM policies response. .. attribute:: results

A list of IamPolicy that match the search query. Related information such as the associated resource is returned along with the policy.

SearchAllResourcesRequest

Search all resources request. .. attribute:: scope

Required. A scope can be a project, a folder or an organization. The search is limited to the resources within the scope. The allowed values are: - projects/{PROJECT_ID} - projects/{PROJECT_NUMBER} - folders/{FOLDER_NUMBER} - organizations/{ORGANIZATION_NUMBER}

Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types <https://cloud.google.com/asset-inventory/docs/supported- asset-types#searchable_asset_types>__.

Optional. If present, then 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.