|
| 1 | +# Copyright 2024 Google Inc. |
| 2 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 3 | +# you may not use this file except in compliance with the License. |
| 4 | +# You may obtain a copy of the License at |
| 5 | +# |
| 6 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 7 | +# |
| 8 | +# Unless required by applicable law or agreed to in writing, software |
| 9 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 10 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 11 | +# See the License for the specific language governing permissions and |
| 12 | +# limitations under the License. |
| 13 | + |
| 14 | +# Warning: This is a temporary file, and should not be edited directly |
| 15 | +--- |
| 16 | +name: 'ReportConfig' |
| 17 | +description: | |
| 18 | + Represents an inventory report configuration. |
| 19 | +references: |
| 20 | + guides: |
| 21 | + 'Official Documentation': 'https://cloud.google.com/storage/docs/insights/using-storage-insights' |
| 22 | + api: 'https://cloud.google.com/storage/docs/json_api/v1/reportConfig' |
| 23 | +docs: |
| 24 | +base_url: 'projects/{{project}}/locations/{{location}}/reportConfigs' |
| 25 | +self_link: 'projects/{{project}}/locations/{{location}}/reportConfigs/{{name}}' |
| 26 | +create_url: 'projects/{{project}}/locations/{{location}}/reportConfigs' |
| 27 | +update_verb: 'PATCH' |
| 28 | +update_mask: true |
| 29 | +timeouts: |
| 30 | + insert_minutes: 20 |
| 31 | + update_minutes: 20 |
| 32 | + delete_minutes: 20 |
| 33 | +custom_code: |
| 34 | +examples: |
| 35 | + - name: 'storage_insights_report_config' |
| 36 | + primary_resource_id: 'config' |
| 37 | + vars: |
| 38 | + bucket_name: 'my-bucket' |
| 39 | +parameters: |
| 40 | + - name: 'location' |
| 41 | + type: String |
| 42 | + description: | |
| 43 | + The location of the ReportConfig. The source and destination buckets specified in the ReportConfig |
| 44 | + must be in the same location. |
| 45 | + url_param_only: true |
| 46 | + required: true |
| 47 | + immutable: true |
| 48 | +properties: |
| 49 | + - name: 'name' |
| 50 | + type: String |
| 51 | + description: | |
| 52 | + The UUID of the inventory report configuration. |
| 53 | + output: true |
| 54 | + custom_flatten: 'templates/terraform/custom_flatten/go/name_from_self_link.tmpl' |
| 55 | + - name: 'frequencyOptions' |
| 56 | + type: NestedObject |
| 57 | + description: | |
| 58 | + Options for configuring how inventory reports are generated. |
| 59 | + properties: |
| 60 | + - name: 'frequency' |
| 61 | + type: Enum |
| 62 | + description: | |
| 63 | + The frequency in which inventory reports are generated. Values are DAILY or WEEKLY. |
| 64 | + required: true |
| 65 | + enum_values: |
| 66 | + - 'DAILY' |
| 67 | + - 'WEEKLY' |
| 68 | + - name: 'startDate' |
| 69 | + type: NestedObject |
| 70 | + description: | |
| 71 | + The date to start generating inventory reports. For example, {"day": 15, "month": 8, "year": 2022}. |
| 72 | + required: true |
| 73 | + properties: |
| 74 | + - name: 'day' |
| 75 | + type: Integer |
| 76 | + description: 'The day of the month to start generating inventory reports.' |
| 77 | + required: true |
| 78 | + - name: 'month' |
| 79 | + type: Integer |
| 80 | + description: 'The month to start generating inventory reports.' |
| 81 | + required: true |
| 82 | + - name: 'year' |
| 83 | + type: Integer |
| 84 | + description: 'The year to start generating inventory reports' |
| 85 | + required: true |
| 86 | + - name: 'endDate' |
| 87 | + type: NestedObject |
| 88 | + description: | |
| 89 | + The date to stop generating inventory reports. For example, {"day": 15, "month": 9, "year": 2022}. |
| 90 | + required: true |
| 91 | + properties: |
| 92 | + - name: 'day' |
| 93 | + type: Integer |
| 94 | + description: 'The day of the month to stop generating inventory reports.' |
| 95 | + required: true |
| 96 | + - name: 'month' |
| 97 | + type: Integer |
| 98 | + description: 'The month to stop generating inventory reports.' |
| 99 | + required: true |
| 100 | + - name: 'year' |
| 101 | + type: Integer |
| 102 | + description: 'The year to stop generating inventory reports' |
| 103 | + required: true |
| 104 | + - name: 'csvOptions' |
| 105 | + type: NestedObject |
| 106 | + description: | |
| 107 | + Options for configuring the format of the inventory report CSV file. |
| 108 | + required: true |
| 109 | + properties: |
| 110 | + - name: 'recordSeparator' |
| 111 | + type: String |
| 112 | + description: | |
| 113 | + The character used to separate the records in the inventory report CSV file. |
| 114 | + - name: 'delimiter' |
| 115 | + type: String |
| 116 | + description: | |
| 117 | + The delimiter used to separate the fields in the inventory report CSV file. |
| 118 | + - name: 'headerRequired' |
| 119 | + type: Boolean |
| 120 | + description: | |
| 121 | + The boolean that indicates whether or not headers are included in the inventory report CSV file. |
| 122 | + - name: 'objectMetadataReportOptions' |
| 123 | + type: NestedObject |
| 124 | + description: | |
| 125 | + Options for including metadata in an inventory report. |
| 126 | + update_mask_fields: |
| 127 | + - 'objectMetadataReportOptions.metadataFields' |
| 128 | + - 'objectMetadataReportOptions.storageDestinationOptions.bucket' |
| 129 | + - 'objectMetadataReportOptions.storageDestinationOptions.destinationPath' |
| 130 | + properties: |
| 131 | + - name: 'metadataFields' |
| 132 | + type: Array |
| 133 | + description: | |
| 134 | + The metadata fields included in an inventory report. |
| 135 | + required: true |
| 136 | + item_type: |
| 137 | + type: String |
| 138 | + - name: 'storageFilters' |
| 139 | + type: NestedObject |
| 140 | + properties: |
| 141 | + - name: 'bucket' |
| 142 | + type: String |
| 143 | + description: | |
| 144 | + The filter to use when specifying which bucket to generate inventory reports for. |
| 145 | + immutable: true |
| 146 | + - name: 'storageDestinationOptions' |
| 147 | + type: NestedObject |
| 148 | + description: | |
| 149 | + Options for where the inventory reports are stored. |
| 150 | + required: true |
| 151 | + properties: |
| 152 | + - name: 'bucket' |
| 153 | + type: String |
| 154 | + description: | |
| 155 | + The destination bucket that stores the generated inventory reports. |
| 156 | + required: true |
| 157 | + - name: 'destinationPath' |
| 158 | + type: String |
| 159 | + description: | |
| 160 | + The path within the destination bucket to store generated inventory reports. |
| 161 | + - name: 'displayName' |
| 162 | + type: String |
| 163 | + description: | |
| 164 | + The editable display name of the inventory report configuration. Has a limit of 256 characters. Can be empty. |
0 commit comments