multicloud_data_transfer_configs

Creates, updates, deletes, gets or lists a multicloud_data_transfer_configs resource.

Overview

Name	multicloud_data_transfer_configs
Type	Resource
Id	google.networkconnectivity.multicloud_data_transfer_configs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The name of the MulticloudDataTransferConfig resource. Format: projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}.
createTime	string (google-datetime)	Output only. Time when the MulticloudDataTransferConfig resource was created.
description	string	Optional. A description of this resource.
destinationsActiveCount	integer (int32)	Output only. The number of Destination resources in use with the MulticloudDataTransferConfig resource.
destinationsCount	integer (int32)	Output only. The number of Destination resources configured for the MulticloudDataTransferConfig resource.
etag	string	The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.
labels	object	Optional. User-defined labels.
services	object	Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either ADDING or DELETING, depending on the actions taken. Sample output: "services": { "big-query": { "states": [ { "effectiveTime": "2024-12-12T08:00:00Z" "state": "ADDING", }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }
uid	string	Output only. The Google-generated unique ID for the MulticloudDataTransferConfig resource. This value is unique across all MulticloudDataTransferConfig resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.
updateTime	string (google-datetime)	Output only. Time when the MulticloudDataTransferConfig resource was updated.

list

Name	Datatype	Description
name	string	Identifier. The name of the MulticloudDataTransferConfig resource. Format: projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}.
createTime	string (google-datetime)	Output only. Time when the MulticloudDataTransferConfig resource was created.
description	string	Optional. A description of this resource.
destinationsActiveCount	integer (int32)	Output only. The number of Destination resources in use with the MulticloudDataTransferConfig resource.
destinationsCount	integer (int32)	Output only. The number of Destination resources configured for the MulticloudDataTransferConfig resource.
etag	string	The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.
labels	object	Optional. User-defined labels.
services	object	Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either ADDING or DELETING, depending on the actions taken. Sample output: "services": { "big-query": { "states": [ { "effectiveTime": "2024-12-12T08:00:00Z" "state": "ADDING", }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }
uid	string	Output only. The Google-generated unique ID for the MulticloudDataTransferConfig resource. This value is unique across all MulticloudDataTransferConfig resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.
updateTime	string (google-datetime)	Output only. Time when the MulticloudDataTransferConfig resource was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, multicloudDataTransferConfigsId		Gets the details of a MulticloudDataTransferConfig resource.
list	select	projectsId, locationsId	filter, returnPartialSuccess, pageToken, pageSize, orderBy	Lists the MulticloudDataTransferConfig resources in a specified project and location.
create	insert	projectsId, locationsId	multicloudDataTransferConfigId, requestId	Creates a MulticloudDataTransferConfig resource in a specified project and location.
patch	update	projectsId, locationsId, multicloudDataTransferConfigsId	updateMask, requestId	Updates a MulticloudDataTransferConfig resource in a specified project and location.
delete	delete	projectsId, locationsId, multicloudDataTransferConfigsId	requestId, etag	Deletes a MulticloudDataTransferConfig resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
multicloudDataTransferConfigsId	string
projectsId	string
etag	string
filter	string
multicloudDataTransferConfigId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
returnPartialSuccess	boolean
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the details of a MulticloudDataTransferConfig resource.

SELECT
name,
createTime,
description,
destinationsActiveCount,
destinationsCount,
etag,
labels,
services,
uid,
updateTime
FROM google.networkconnectivity.multicloud_data_transfer_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND multicloudDataTransferConfigsId = '{{ multicloudDataTransferConfigsId }}' -- required
;

list

Lists the MulticloudDataTransferConfig resources in a specified project and location.

SELECT
name,
createTime,
description,
destinationsActiveCount,
destinationsCount,
etag,
labels,
services,
uid,
updateTime
FROM google.networkconnectivity.multicloud_data_transfer_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a MulticloudDataTransferConfig resource in a specified project and location.

INSERT INTO google.networkconnectivity.multicloud_data_transfer_configs (
data__name,
data__description,
data__labels,
data__services,
data__etag,
projectsId,
locationsId,
multicloudDataTransferConfigId,
requestId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ services }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ multicloudDataTransferConfigId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: multicloud_data_transfer_configs
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the multicloud_data_transfer_configs resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the multicloud_data_transfer_configs resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The name of the `MulticloudDataTransferConfig` resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. A description of this resource.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. User-defined labels.
  - name: services
    value: "{{ services }}"
    description: |
      Optional. Maps services to their current or planned states. Service names are keys, and the associated values describe the state of the service. If a state change is expected, the value is either `ADDING` or `DELETING`, depending on the actions taken. Sample output: "services": { "big-query": { "states": [ { "effectiveTime": "2024-12-12T08:00:00Z" "state": "ADDING", }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }
  - name: etag
    value: "{{ etag }}"
    description: |
      The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.
  - name: multicloudDataTransferConfigId
    value: "{{ multicloudDataTransferConfigId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates a MulticloudDataTransferConfig resource in a specified project and location.

UPDATE google.networkconnectivity.multicloud_data_transfer_configs
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__services = '{{ services }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND multicloudDataTransferConfigsId = '{{ multicloudDataTransferConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a MulticloudDataTransferConfig resource.

DELETE FROM google.networkconnectivity.multicloud_data_transfer_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND multicloudDataTransferConfigsId = '{{ multicloudDataTransferConfigsId }}' --required
AND requestId = '{{ requestId }}'
AND etag = '{{ etag }}'
;