Package types (3.5.0)

Represents the metadata of the longrunning operation for the AnalyzeIamPolicyLongrunning rpc.

A request message for AssetService.AnalyzeIamPolicyLongrunning.

A response message for AssetService.AnalyzeIamPolicyLongrunning.

A request message for AssetService.AnalyzeIamPolicy.

A response message for AssetService.AnalyzeIamPolicy.

The request message for performing resource move analysis. .. attribute:: resource

Required. Name of the resource to perform the analysis against. Only GCP Project are supported as of today. Hence, this can only be Project ID (such as "projects/my-project-id") or a Project Number (such as "projects/12345").

:type: str

The response message for resource move analysis. .. attribute:: move_analysis

The list of analyses returned from performing the intended resource move analysis. The analysis is grouped by different Cloud services.

:type: Sequence[google.cloud.asset_v1.types.MoveAnalysis]

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), or a relationship (e.g. an INSTANCE_TO_INSTANCEGROUP relationship). See Supported asset types <https://cloud.google.com/asset-inventory/docs/supported-asset-types> for more information.

Attached resource representation, which is defined by the corresponding service provider. It represents an attached resource's payload.

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

:type: str

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

A list of assets with valid time windows.

:type: Sequence[google.cloud.asset_v1.types.TemporalAsset]

A BigQuery destination for exporting assets to. .. 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.

:type: str

The Condition evaluation. .. attribute:: evaluation_value

The evaluation result.

:type: google.cloud.asset_v1.types.ConditionEvaluation.EvaluationValue

Asset content type.

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

:type: str

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

:type: str

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

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.

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

Destination on Pub/Sub.

:type: google.cloud.asset_v1.types.PubsubDestination

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

If the specified Cloud Storage object already exists and there is no hold <https://cloud.google.com/storage/docs/object-holds>__, it will be overwritten with the exported result.

:type: str

A Cloud Storage output result. .. attribute:: uris

List of uris of the Cloud Storage objects. Example: "gs://bucket_name/object_name".

:type: Sequence[str]

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

:type: str

Output configuration for export IAM policy analysis destination.

IAM policy analysis query message.

.. attribute:: 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 <https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id>__.

To know how to get folder or project id, visit here <https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects>__.

:type: str

IAM Policy analysis result, consisting of one IAM policy binding and derived access control lists.

Represents the detailed state of an entity under analysis, such as a resource, an identity or an access.

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

ListAssets request. .. attribute:: parent

Required. Name of the organization or project the assets belong to. Format: "organizations/[organization-number]" (such as "organizations/123"), "projects/[project-id]" (such as "projects/my-project-id"), or "projects/[project-number]" (such as "projects/12345").

:type: str

ListAssets response. .. attribute:: read_time

Time the snapshot was taken.

:type: google.protobuf.timestamp_pb2.Timestamp

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

:type: str

A message to group the analysis information. .. attribute:: display_name

The user friendly display name of the analysis. E.g. IAM, Organization Policy etc.

:type: str

An analysis result including blockers and warnings. .. attribute:: blockers

Blocking information that would prevent the target resource from moving to the specified destination at runtime.

:type: Sequence[google.cloud.asset_v1.types.MoveImpact]

A message to group impacts of moving the target resource. .. attribute:: detail

User friendly impact detail in a free form message.

:type: str

Output configuration for export assets destination. .. attribute:: gcs_destination

Destination on Cloud Storage.

:type: google.cloud.asset_v1.types.GcsDestination

Output result of export assets. .. attribute:: gcs_result

Export result on Cloud Storage.

:type: google.cloud.asset_v1.types.GcsOutputResult

Specifications of BigQuery partitioned table as export destination.

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

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

:type: str

An asset identify in Google Cloud which contains its name, type and ancestors. 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 detailed related assets with the relationship_type. .. attribute:: relationship_attributes

The detailed relationship attributes.

:type: google.cloud.asset_v1.types.RelationshipAttributes

The detailed related resource. .. attribute:: asset_type

The type of the asset. Example: compute.googleapis.com/Instance

:type: str

The related resources of the primary resource. .. attribute:: related_resources

The detailed related resources of the primary resource.

:type: Sequence[google.cloud.asset_v1.types.RelatedResource]

The relationship attributes which include type, source_resource_type, target_resource_type and action.

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

The API version. Example: v1

:type: str

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

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 caller must be granted the `cloudasset.assets.searchAllIamPolicies https://cloud.google.com/asset-inventory/docs/access-control#required_permissions`__ permission on the desired scope.

The allowed values are:

• projects/{PROJECT_ID} (e.g., "projects/foo-bar")
• projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
• folders/{FOLDER_NUMBER} (e.g., "folders/1234567")

• organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

  :type: str

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.

:type: Sequence[google.cloud.asset_v1.types.IamPolicySearchResult]

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 caller must be granted the `cloudasset.assets.searchAllResources https://cloud.google.com/asset-inventory/docs/access-control#required_permissions`__ permission on the desired scope.

The allowed values are:

• projects/{PROJECT_ID} (e.g., "projects/foo-bar")
• projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
• folders/{FOLDER_NUMBER} (e.g., "folders/1234567")

• organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

  :type: str

Search all resources response. .. attribute:: results

A list of Resources that match the search query. It contains the resource standard metadata information.

:type: Sequence[google.cloud.asset_v1.types.ResourceSearchResult]

An asset in Google Cloud and its temporal metadata, including the time window when it was observed and its status during that window.

A time window specified by its start_time and end_time. .. attribute:: start_time

Start time of the time window (exclusive).

:type: google.protobuf.timestamp_pb2.Timestamp

Update asset feed request. .. attribute:: feed

Required. The new values of feed details. It must match an existing feed and the field name must be in the format of: projects/project_number/feeds/feed_id or folders/folder_number/feeds/feed_id or organizations/organization_number/feeds/feed_id.

:type: google.cloud.asset_v1.types.Feed

Resource representation as defined by the corresponding service providing the resource for a given API version.