|
| 1 | +# Copyright 2025 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 | +--- |
| 15 | +name: 'MulticloudDataTransferConfig' |
| 16 | +description: | |
| 17 | + 'Manage Multicloud Data Transfer Configs' |
| 18 | +references: |
| 19 | + guides: |
| 20 | + 'QUICKSTART_TITLE': 'https://docs.cloud.google.com/data-transfer-essentials/docs/create-resources' |
| 21 | + api: 'https://docs.cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest/v1/projects.locations.multicloudDataTransferConfigs' |
| 22 | + |
| 23 | +base_url: 'projects/{{project}}/locations/{{location}}/multicloudDataTransferConfigs' |
| 24 | +self_link: 'projects/{{project}}/locations/{{location}}/multicloudDataTransferConfigs/{{name}}' |
| 25 | + |
| 26 | +immutable: false |
| 27 | + |
| 28 | +create_url: 'projects/{{project}}/locations/{{location}}/multicloudDataTransferConfigs?multicloudDataTransferConfigId={{name}}' |
| 29 | + |
| 30 | +update_verb: 'PATCH' |
| 31 | +update_mask: true |
| 32 | + |
| 33 | +autogen_async: true |
| 34 | +async: |
| 35 | + operation: |
| 36 | + base_url: '{{op_id}}' |
| 37 | + |
| 38 | +examples: |
| 39 | + - name: "network_connectivity_multicloud_data_transfer_config_basic" |
| 40 | + primary_resource_id: "example" |
| 41 | + vars: |
| 42 | + config_name: "basic_config" |
| 43 | + |
| 44 | +parameters: |
| 45 | + - name: 'location' |
| 46 | + type: String |
| 47 | + required: true |
| 48 | + immutable: true |
| 49 | + url_param_only: true |
| 50 | + description: | |
| 51 | + The location of the multicloud data transfer config. |
| 52 | + - name: 'name' |
| 53 | + type: String |
| 54 | + required: true |
| 55 | + immutable: true |
| 56 | + url_param_only: true |
| 57 | + description: | |
| 58 | + The name of the MulticloudDataTransferConfig resource. |
| 59 | +
|
| 60 | +properties: |
| 61 | + - name: 'createTime' |
| 62 | + type: Time |
| 63 | + output: true |
| 64 | + description: | |
| 65 | + Time when the MulticloudDataTransferConfig resource was created. |
| 66 | + - name: 'updateTime' |
| 67 | + type: Time |
| 68 | + output: true |
| 69 | + description: | |
| 70 | + Time when the MulticloudDataTransferConfig resource was updated. |
| 71 | + - name: 'labels' |
| 72 | + type: KeyValueLabels |
| 73 | + description: | |
| 74 | + User-defined labels. |
| 75 | + - name: 'etag' |
| 76 | + type: Fingerprint |
| 77 | + description: | |
| 78 | + The etag is computed by the server, and might be sent with update and |
| 79 | + delete requests so that the client has an up-to-date value before |
| 80 | + proceeding. |
| 81 | + - name: 'description' |
| 82 | + type: String |
| 83 | + description: | |
| 84 | + A description of this resource. |
| 85 | + - name: 'destinationsCount' |
| 86 | + type: Integer |
| 87 | + output: true |
| 88 | + description: | |
| 89 | + The number of Destination resources configured for the |
| 90 | + MulticloudDataTransferConfig resource. |
| 91 | + - name: 'destinationsActiveCount' |
| 92 | + type: Integer |
| 93 | + output: true |
| 94 | + description: | |
| 95 | + The number of Destination resources in use with the |
| 96 | + MulticloudDataTransferConfig resource. |
| 97 | + - name: 'services' |
| 98 | + type: Array |
| 99 | + description: | |
| 100 | + Maps services to their current or planned states. Service names are keys, |
| 101 | + and the associated values describe the state of the service. |
| 102 | + custom_flatten: 'templates/terraform/custom_flatten/network_connectivity_mcdt_services_state_timeline_flatten.go.tmpl' |
| 103 | + custom_expand: 'templates/terraform/custom_expand/network_connectivity_mcdt_services_state_timeline_expand.go.tmpl' |
| 104 | + item_type: |
| 105 | + type: NestedObject |
| 106 | + properties: |
| 107 | + - name: 'service_name' |
| 108 | + type: String |
| 109 | + description: | |
| 110 | + The name of the service, like "big-query" or "cloud-storage". |
| 111 | + This corresponds to the map key in the API. |
| 112 | + required: true |
| 113 | + - name: 'states' |
| 114 | + type: Array |
| 115 | + description: 'The state and activation time details for the service.' |
| 116 | + output: true |
| 117 | + item_type: |
| 118 | + type: NestedObject |
| 119 | + properties: |
| 120 | + - name: 'state' |
| 121 | + type: String |
| 122 | + description: 'The state of the resource.' |
| 123 | + output: true |
| 124 | + - name: 'effective_time' |
| 125 | + type: String |
| 126 | + description: 'The time when the state becomes effective' |
| 127 | + output: true |
| 128 | + - name: 'uid' |
| 129 | + type: String |
| 130 | + output: true |
| 131 | + description: | |
| 132 | + The Google-generated unique ID for the MulticloudDataTransferConfig |
| 133 | + resource. This value is unique across all MulticloudDataTransferConfig |
| 134 | + resources. If a resource is deleted and another with the same name is |
| 135 | + created, the new resource is assigned a different and unique ID. |
0 commit comments