package google.cloud.asset.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Asset service definition.

• rpc ExportAssets (ExportAssetsRequest, longrunning.Operation)

  asset_service.proto:46

  Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API allowing you to keep track of the export.

  message ExportAssetsRequest

  asset_service.proto:72

  Export asset request.

  • string parent = 1

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

  • optional protobuf.Timestamp read_time = 2

    Timestamp to take an asset snapshot. This can only be set to a timestamp between 2018-10-02 UTC (inclusive) and the current time. 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.

  • repeated string asset_types = 3

    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.

  • ContentType content_type = 4

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

  • optional OutputConfig output_config = 5

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

• rpc BatchGetAssetsHistory (BatchGetAssetsHistoryRequest, BatchGetAssetsHistoryResponse)

  asset_service.proto:64

  Batch gets the update history of assets that overlap a time window. For RESOURCE content, this API outputs history with asset in both non-delete or deleted status. 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. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.

  message BatchGetAssetsHistoryRequest

  asset_service.proto:120

  Batch get assets history request.

  • string parent = 1

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

  • repeated string asset_names = 2

    A list of the full names of the assets. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) and [Resource Name Format](https://cloud.google.com/asset-inventory/docs/resource-name-format) for more info. 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.

  • ContentType content_type = 3

    Optional. The content type.

  • optional TimeWindow read_time_window = 4

    Optional. The time window for the asset history. Both start_time and end_time are optional and if set, it must be after 2018-10-02 UTC. 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.

  message BatchGetAssetsHistoryResponse

  asset_service.proto:156

  Batch get assets history response.

  • repeated TemporalAsset assets = 1

    A list of assets with valid time windows.

Cloud asset. This includes all Google Cloud Platform resources, Cloud IAM policies, and other non-GCP assets.

Used in: TemporalAsset

• string name = 1

  The full name of the asset. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information.

• string asset_type = 2

  Type of the asset. Example: "compute.googleapis.com/Disk".

• optional Resource resource = 3

  Representation of the resource.

• optional iam.v1.Policy iam_policy = 4

  Representation of the actual Cloud IAM policy set on a cloud resource. For each resource, there must be at most one Cloud IAM policy set on it.

A BigQuery destination.

Used in: OutputConfig

• string dataset = 1

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

• string table = 2

  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.

• bool force = 3

  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 not set and the destination table already exists, the export call returns an error.

Asset content type.

Used in: BatchGetAssetsHistoryRequest, ExportAssetsRequest

• CONTENT_TYPE_UNSPECIFIED = 0

  Unspecified content type.

• RESOURCE = 1

  Resource metadata.

• IAM_POLICY = 2

  The actual IAM policy set on a resource.

• ORG_POLICY = 4

  The Cloud Organization Policy set on an asset.

• ACCESS_POLICY = 5

  The Cloud Access context mananger Policy set on an asset.

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.

• optional protobuf.Timestamp read_time = 1

  Time the snapshot was taken.

• optional OutputConfig output_config = 2

  Output configuration indicating where the results were output to. All results are in JSON format.

A Cloud Storage location.

Used in: OutputConfig

• oneof object_uri

  Required.

  • string uri = 1

    The uri of the Cloud Storage object. It's the same uri that is used by gsutil. For example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information.

  • string uri_prefix = 2

    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/<asset type>/<shard number> and only contains assets for that type. <shard number> starts from 0. For example: "gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/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.

Output configuration for export assets destination.

Used in: ExportAssetsRequest, ExportAssetsResponse

• oneof destination

  Asset export destination.

  • GcsDestination gcs_destination = 1

    Destination on Cloud Storage.

  • BigQueryDestination bigquery_destination = 2

    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.

Representation of a cloud resource.

Used in: Asset

• string version = 1

  The API version. Example: "v1".

• string discovery_document_uri = 2

  The URL of the discovery document containing the resource's JSON schema. For example: `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`. It will be left unspecified for resources without a discovery-based API, such as Cloud Bigtable.

• string discovery_name = 3

  The JSON schema name listed in the discovery document. Example: "Project". It will be left unspecified for resources (such as Cloud Bigtable) without a discovery-based API.

• string resource_url = 4

  The REST URL for accessing the resource. An HTTP GET operation using this URL returns the resource itself. Example: `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`. It will be left unspecified for resources without a REST API.

• string parent = 5

  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 GCP assets, it is the parent resource defined in the [Cloud IAM policy hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). For example: `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`. For third-party assets, it is up to the users to define.

• optional protobuf.Struct data = 6

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

Temporal asset. In addition to the asset, the temporal asset includes the status of the asset and valid from and to time of it.

Used in: BatchGetAssetsHistoryResponse

• optional TimeWindow window = 1

  The time window when the asset data and state was observed.

• bool deleted = 2

  If the asset is deleted or not.

• optional Asset asset = 3

  Asset.

A time window of (start_time, end_time].

Used in: BatchGetAssetsHistoryRequest, TemporalAsset

• optional protobuf.Timestamp start_time = 1

  Start time of the time window (exclusive).

• optional protobuf.Timestamp end_time = 2

  End time of the time window (inclusive). Current timestamp if not specified.