destinations

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

Overview

Name	destinations
Type	Resource
Id	google.networkconnectivity.destinations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The name of the Destination resource. Format: projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}.
createTime	string (google-datetime)	Output only. Time when the Destination resource was created.
description	string	Optional. A description of this resource.
endpoints	array	Required. Unordered list. The list of DestinationEndpoint resources configured for the IP prefix.
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.
ipPrefix	string	Required. Immutable. The IP prefix that represents your workload on another CSP.
labels	object	Optional. User-defined labels.
stateTimeline	object	The timeline of the pending states for a resource. (id: StateTimeline)
uid	string	Output only. The Google-generated unique ID for the Destination resource. This value is unique across all Destination 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 Destination resource was updated.

list

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, multicloudDataTransferConfigsId, destinationsId		Gets the details of a Destination resource.
list	select	projectsId, locationsId, multicloudDataTransferConfigsId	pageToken, filter, returnPartialSuccess, pageSize, orderBy	Lists the Destination resources in a specified project and location.
create	insert	projectsId, locationsId, multicloudDataTransferConfigsId	requestId, destinationId	Creates a Destination resource in a specified project and location.
patch	update	projectsId, locationsId, multicloudDataTransferConfigsId, destinationsId	updateMask, requestId	Updates a Destination resource in a specified project and location.
delete	delete	projectsId, locationsId, multicloudDataTransferConfigsId, destinationsId	etag, requestId	Deletes a Destination 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
destinationsId	string
locationsId	string
multicloudDataTransferConfigsId	string
projectsId	string
destinationId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
returnPartialSuccess	boolean
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the details of a Destination resource.

SELECT
name,
createTime,
description,
endpoints,
etag,
ipPrefix,
labels,
stateTimeline,
uid,
updateTime
FROM google.networkconnectivity.destinations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND multicloudDataTransferConfigsId = '{{ multicloudDataTransferConfigsId }}' -- required
AND destinationsId = '{{ destinationsId }}' -- required
;

list

Lists the Destination resources in a specified project and location.

SELECT
*
FROM google.networkconnectivity.destinations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND multicloudDataTransferConfigsId = '{{ multicloudDataTransferConfigsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a Destination resource in a specified project and location.

INSERT INTO google.networkconnectivity.destinations (
data__description,
data__name,
data__etag,
data__ipPrefix,
data__endpoints,
data__labels,
projectsId,
locationsId,
multicloudDataTransferConfigsId,
requestId,
destinationId
)
SELECT 
'{{ description }}',
'{{ name }}',
'{{ etag }}',
'{{ ipPrefix }}',
'{{ endpoints }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ multicloudDataTransferConfigsId }}',
'{{ requestId }}',
'{{ destinationId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: destinations
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the destinations resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the destinations resource.
  - name: multicloudDataTransferConfigsId
    value: "{{ multicloudDataTransferConfigsId }}"
    description: Required parameter for the destinations resource.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. A description of this resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The name of the `Destination` resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}`.
  - 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: ipPrefix
    value: "{{ ipPrefix }}"
    description: |
      Required. Immutable. The IP prefix that represents your workload on another CSP.
  - name: endpoints
    description: |
      Required. Unordered list. The list of `DestinationEndpoint` resources configured for the IP prefix.
    value:
      - asn: "{{ asn }}"
        state: "{{ state }}"
        csp: "{{ csp }}"
        updateTime: "{{ updateTime }}"
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. User-defined labels.
  - name: requestId
    value: "{{ requestId }}"
  - name: destinationId
    value: "{{ destinationId }}"

UPDATE examples

patch

Updates a Destination resource in a specified project and location.

UPDATE google.networkconnectivity.destinations
SET 
data__description = '{{ description }}',
data__name = '{{ name }}',
data__etag = '{{ etag }}',
data__ipPrefix = '{{ ipPrefix }}',
data__endpoints = '{{ endpoints }}',
data__labels = '{{ labels }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND multicloudDataTransferConfigsId = '{{ multicloudDataTransferConfigsId }}' --required
AND destinationsId = '{{ destinationsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a Destination resource.

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