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

Successful response

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 was created.
description	string	Optional. An optional field to provide a description of this resource.
destinationsActiveCount	integer (int32)	Output only. The number of Destinations in use under the MulticloudDataTransferConfig resource.
destinationsCount	integer (int32)	Output only. The number of Destinations configured under the MulticloudDataTransferConfig resource.
etag	string	The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
labels	object	Optional. User-defined labels.
services	object	Optional. This map services to either their current or planned states. Service names are keys, and the associated values describe the service's state. If a state change is expected, the value will be the list of ADDING or DELETING states depending on the actions taken. Example: "services": { "big-query": { "states": [ { "state": "ADDING", "effective_time": "2024-12-12T08:00:00Z" }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }
uid	string	Output only. The Google-generated UUID for the MulticloudDataTransferConfig. This value is unique across all MulticloudDataTransferConfig resources. If a MulticloudDataTransferConfig is deleted and another with the same name is created, the new MulticloudDataTransferConfig is assigned a different uid.
updateTime	string (google-datetime)	Output only. Time when the MulticloudDataTransferConfig was updated.

list

Successful response

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 was created.
description	string	Optional. An optional field to provide a description of this resource.
destinationsActiveCount	integer (int32)	Output only. The number of Destinations in use under the MulticloudDataTransferConfig resource.
destinationsCount	integer (int32)	Output only. The number of Destinations configured under the MulticloudDataTransferConfig resource.
etag	string	The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
labels	object	Optional. User-defined labels.
services	object	Optional. This map services to either their current or planned states. Service names are keys, and the associated values describe the service's state. If a state change is expected, the value will be the list of ADDING or DELETING states depending on the actions taken. Example: "services": { "big-query": { "states": [ { "state": "ADDING", "effective_time": "2024-12-12T08:00:00Z" }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }
uid	string	Output only. The Google-generated UUID for the MulticloudDataTransferConfig. This value is unique across all MulticloudDataTransferConfig resources. If a MulticloudDataTransferConfig is deleted and another with the same name is created, the new MulticloudDataTransferConfig is assigned a different uid.
updateTime	string (google-datetime)	Output only. Time when the MulticloudDataTransferConfig 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 details of a single MulticloudDataTransferConfig.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy, returnPartialSuccess	Lists MulticloudDataTransferConfigs in a given project and location.
create	insert	projectsId, locationsId	multicloudDataTransferConfigId, requestId	Creates a MulticloudDataTransferConfig in a given project and location.
patch	update	projectsId, locationsId, multicloudDataTransferConfigsId	updateMask, requestId	Updates a MulticloudDataTransferConfig in a given project and location.
delete	delete	projectsId, locationsId, multicloudDataTransferConfigsId	requestId, etag	Deletes a single MulticloudDataTransferConfig.

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 details of a single MulticloudDataTransferConfig.

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 MulticloudDataTransferConfigs in a given 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 pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

INSERT examples

create

Creates a MulticloudDataTransferConfig in a given project and location.

INSERT INTO google.networkconnectivity.multicloud_data_transfer_configs (
data__name,
data__labels,
data__etag,
data__description,
data__services,
projectsId,
locationsId,
multicloudDataTransferConfigId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ etag }}',
'{{ description }}',
'{{ services }}',
'{{ 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: string
      description: Required parameter for the multicloud_data_transfer_configs resource.
    - name: locationsId
      value: string
      description: Required parameter for the multicloud_data_transfer_configs resource.
    - name: name
      value: string
      description: >
        Identifier. The name of the MulticloudDataTransferConfig resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels.
        
    - name: etag
      value: string
      description: >
        The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
        
    - name: description
      value: string
      description: >
        Optional. An optional field to provide a description of this resource.
        
    - name: services
      value: object
      description: >
        Optional. This map services to either their current or planned states. Service names are keys, and the associated values describe the service's state. If a state change is expected, the value will be the list of ADDING or DELETING states depending on the actions taken. Example: "services": { "big-query": { "states": [ { "state": "ADDING", "effective_time": "2024-12-12T08:00:00Z" }, ] }, "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } }
        
    - name: multicloudDataTransferConfigId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates a MulticloudDataTransferConfig in a given project and location.

UPDATE google.networkconnectivity.multicloud_data_transfer_configs
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
data__description = '{{ description }}',
data__services = '{{ services }}'
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 single MulticloudDataTransferConfig.

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 }}';