-
Notifications
You must be signed in to change notification settings - Fork 605
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Small change for documentation (#3676)
* docs: Small change for documentation PiperOrigin-RevId: 490109215 Source-Link: googleapis/googleapis@0cbcc59 Source-Link: googleapis/googleapis-gen@6c019fa Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFzc2V0Ly5Pd2xCb3QueWFtbCIsImgiOiI2YzAxOWZhMTU3NTRiYmVkZmIwZGNmY2JjZGM5N2E4NWQzOGNmMTlkIn0= * docs: Small change for documentation PiperOrigin-RevId: 490314741 Source-Link: googleapis/googleapis@9247e23 Source-Link: googleapis/googleapis-gen@40eb7b3 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFzc2V0Ly5Pd2xCb3QueWFtbCIsImgiOiI0MGViN2IzMzUzOTU1OGRiNTAyYzhiZDgzZjIwNjJiOTg2ZjhhOWM1In0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: sofisl <[email protected]>
- Loading branch information
3 people
authored
Nov 30, 2022
1 parent
2bdc13c
commit 8137af2
Showing
16 changed files
with
8,045 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
313 changes: 313 additions & 0 deletions
313
packages/google-cloud-asset/protos/google/cloud/asset/v1p7beta1/asset_service.proto
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,313 @@ | ||
| // Copyright 2021 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| syntax = "proto3"; | ||
|
|
||
| package google.cloud.asset.v1p7beta1; | ||
|
|
||
| import "google/api/annotations.proto"; | ||
| import "google/api/client.proto"; | ||
| import "google/api/field_behavior.proto"; | ||
| import "google/api/resource.proto"; | ||
| import "google/cloud/asset/v1p7beta1/assets.proto"; | ||
| import "google/longrunning/operations.proto"; | ||
| import "google/protobuf/timestamp.proto"; | ||
|
|
||
| option csharp_namespace = "Google.Cloud.Asset.V1P7Beta1"; | ||
| option go_package = "google.golang.org/genproto/googleapis/cloud/asset/v1p7beta1;asset"; | ||
| option java_multiple_files = true; | ||
| option java_outer_classname = "AssetServiceProto"; | ||
| option java_package = "com.google.cloud.asset.v1p7beta1"; | ||
| option php_namespace = "Google\\Cloud\\Asset\\V1p7beta1"; | ||
|
|
||
| // Asset service definition. | ||
| service AssetService { | ||
| option (google.api.default_host) = "cloudasset.googleapis.com"; | ||
| option (google.api.oauth_scopes) = | ||
| "https://www.googleapis.com/auth/cloud-platform"; | ||
|
|
||
| // 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 | ||
| // [google.cloud.asset.v1p7beta1.Asset][google.cloud.asset.v1p7beta1.Asset] in | ||
| // the JSON format; for BigQuery table destinations, the output table stores | ||
| // the fields in asset proto as columns. This API implements the | ||
| // [google.longrunning.Operation][google.longrunning.Operation] API , which | ||
| // allows you to keep track of the export. We recommend intervals of at least | ||
| // 2 seconds with exponential retry to poll the export operation result. For | ||
| // regular-size resource parent, the export operation usually finishes within | ||
| // 5 minutes. | ||
| rpc ExportAssets(ExportAssetsRequest) returns (google.longrunning.Operation) { | ||
| option (google.api.http) = { | ||
| post: "/v1p7beta1/{parent=*/*}:exportAssets" | ||
| body: "*" | ||
| }; | ||
| option (google.longrunning.operation_info) = { | ||
| response_type: "google.cloud.asset.v1p7beta1.ExportAssetsResponse" | ||
| metadata_type: "google.cloud.asset.v1p7beta1.ExportAssetsRequest" | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| // Export asset request. | ||
| message ExportAssetsRequest { | ||
| // 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"). | ||
| string parent = 1 [ | ||
| (google.api.field_behavior) = REQUIRED, | ||
| (google.api.resource_reference) = { | ||
| child_type: "cloudasset.googleapis.com/Asset" | ||
| } | ||
| ]; | ||
|
|
||
| // 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. | ||
| google.protobuf.Timestamp read_time = 2; | ||
|
|
||
| // A list of asset types to take a snapshot for. For example: | ||
| // "compute.googleapis.com/Disk". | ||
| // | ||
| // Regular expressions are also supported. For example: | ||
| // | ||
| // * "compute.googleapis.com.*" snapshots resources whose asset type starts | ||
| // with "compute.googleapis.com". | ||
| // * ".*Instance" snapshots resources whose asset type ends with "Instance". | ||
| // * ".*Instance.*" snapshots resources whose asset type contains "Instance". | ||
| // | ||
| // See [RE2](https://github.com/google/re2/wiki/Syntax) 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](https://cloud.google.com/asset-inventory/docs/overview) | ||
| // for all supported asset types. | ||
| repeated string asset_types = 3; | ||
|
|
||
| // Asset content type. If not specified, no content but the asset name will be | ||
| // returned. | ||
| ContentType content_type = 4; | ||
|
|
||
| // Required. Output configuration indicating where the results will be output | ||
| // to. | ||
| OutputConfig output_config = 5 [(google.api.field_behavior) = REQUIRED]; | ||
|
|
||
| // A list of relationship types to export, for example: | ||
| // `INSTANCE_TO_INSTANCEGROUP`. This field should only be specified if | ||
| // content_type=RELATIONSHIP. If specified, it will snapshot [asset_types]' | ||
| // specified relationships, or give errors if any relationship_types' | ||
| // supported types are not in [asset_types]. If not specified, it will | ||
| // snapshot all [asset_types]' supported relationships. An unspecified | ||
| // [asset_types] field means all supported asset_types. See [Introduction to | ||
| // Cloud Asset | ||
| // Inventory](https://cloud.google.com/asset-inventory/docs/overview) for all | ||
| // supported asset types and relationship types. | ||
| repeated string relationship_types = 6; | ||
| } | ||
|
|
||
| // 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. | ||
| message ExportAssetsResponse { | ||
| // Time the snapshot was taken. | ||
| google.protobuf.Timestamp read_time = 1; | ||
|
|
||
| // Output configuration indicating where the results were output to. | ||
| OutputConfig output_config = 2; | ||
|
|
||
| // Output result indicating where the assets were exported to. For example, a | ||
| // set of actual Google 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 Google Cloud Storage object limit. | ||
| OutputResult output_result = 3; | ||
| } | ||
|
|
||
| // Output configuration for export assets destination. | ||
| message OutputConfig { | ||
| // Asset export destination. | ||
| oneof destination { | ||
| // Destination on Cloud Storage. | ||
| GcsDestination gcs_destination = 1; | ||
|
|
||
| // Destination on BigQuery. The output table stores the fields in asset | ||
| // proto as columns in BigQuery. | ||
| BigQueryDestination bigquery_destination = 2; | ||
| } | ||
| } | ||
|
|
||
| // Output result of export assets. | ||
| message OutputResult { | ||
| // Asset export result. | ||
| oneof result { | ||
| // Export result on Cloud Storage. | ||
| GcsOutputResult gcs_result = 1; | ||
| } | ||
| } | ||
|
|
||
| // A Cloud Storage output result. | ||
| message GcsOutputResult { | ||
| // List of uris of the Cloud Storage objects. Example: | ||
| // "gs://bucket_name/object_name". | ||
| repeated string uris = 1; | ||
| } | ||
|
|
||
| // A Cloud Storage location. | ||
| message GcsDestination { | ||
| // Required. | ||
| oneof object_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. | ||
| string uri = 1; | ||
|
|
||
| // 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/{ASSET_TYPE}/{SHARD_NUMBER} and only | ||
| // contains assets for that type. <shard number> starts from 0. 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. | ||
| string uri_prefix = 2; | ||
| } | ||
| } | ||
|
|
||
| // A BigQuery destination for exporting assets to. | ||
| message BigQueryDestination { | ||
| // 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. | ||
| string dataset = 1 [(google.api.field_behavior) = REQUIRED]; | ||
|
|
||
| // 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. | ||
| string table = 2 [(google.api.field_behavior) = REQUIRED]; | ||
|
|
||
| // 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. | ||
| bool force = 3; | ||
|
|
||
| // [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 | ||
| // `PARTITION_KEY_UNSPECIFIED`, the snapshot results will be exported to | ||
| // non-partitioned table(s). [force] will decide whether to overwrite existing | ||
| // table(s). | ||
| // | ||
| // 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 `TRUE`, the corresponding partition will be | ||
| // overwritten by the snapshot results (data in different partitions will | ||
| // remain intact); if [force] is unset or `FALSE`, it will append the data. An | ||
| // error will be returned if the schema update or data appension fails. | ||
| PartitionSpec partition_spec = 4; | ||
|
|
||
| // If this flag is `TRUE`, the snapshot results will be written to one or | ||
| // multiple tables, each of which contains results of one asset type. The | ||
| // [force] and [partition_spec] fields will apply to each of them. | ||
| // | ||
| // 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 `RESOURCE`, the schema of | ||
| // each table will include RECORD-type columns mapped to the nested fields in | ||
| // the Asset.resource.data field of that asset type (up to the 15 nested level | ||
| // BigQuery supports | ||
| // (https://cloud.google.com/bigquery/docs/nested-repeated#limitations)). The | ||
| // fields in >15 nested levels will be stored in JSON format string as a child | ||
| // column of its parent RECORD column. | ||
| // | ||
| // 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. | ||
| bool separate_tables_per_asset_type = 5; | ||
| } | ||
|
|
||
| // Specifications of BigQuery partitioned table as export destination. | ||
| message PartitionSpec { | ||
| // 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). | ||
| enum PartitionKey { | ||
| // Unspecified partition key. If used, it means using non-partitioned table. | ||
| PARTITION_KEY_UNSPECIFIED = 0; | ||
|
|
||
| // 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. | ||
| READ_TIME = 1; | ||
|
|
||
| // 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. | ||
| REQUEST_TIME = 2; | ||
| } | ||
|
|
||
| // The partition key for BigQuery partitioned table. | ||
| PartitionKey partition_key = 1; | ||
| } | ||
|
|
||
| // Asset content type. | ||
| enum ContentType { | ||
| // Unspecified content type. | ||
| CONTENT_TYPE_UNSPECIFIED = 0; | ||
|
|
||
| // Resource metadata. | ||
| RESOURCE = 1; | ||
|
|
||
| // The actual IAM policy set on a resource. | ||
| IAM_POLICY = 2; | ||
|
|
||
| // The Cloud Organization Policy set on an asset. | ||
| ORG_POLICY = 4; | ||
|
|
||
| // The Cloud Access context manager Policy set on an asset. | ||
| ACCESS_POLICY = 5; | ||
|
|
||
| // The related resources. | ||
| RELATIONSHIP = 7; | ||
| } |
Oops, something went wrong.