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
list

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`	Output only. The timeline of the expected `Destination` states or the current rest state. If a state change is expected, the value is `ADDING`, `DELETING` or `SUSPENDING`, depending on the action specified. Example: "state_timeline": { "states": [ { // The time when the `Destination` resource will be activated. "effectiveTime": "2024-12-01T08:00:00Z", "state": "ADDING" }, { // The time when the `Destination` resource will be suspended. "effectiveTime": "2024-12-01T20:00:00Z", "state": "SUSPENDING" } ] } (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.

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`	Output only. The timeline of the expected `Destination` states or the current rest state. If a state change is expected, the value is `ADDING`, `DELETING` or `SUSPENDING`, depending on the action specified. Example: "state_timeline": { "states": [ { // The time when the `Destination` resource will be activated. "effectiveTime": "2024-12-01T08:00:00Z", "state": "ADDING" }, { // The time when the `Destination` resource will be suspended. "effectiveTime": "2024-12-01T20:00:00Z", "state": "SUSPENDING" } ] } (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.

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`	`filter`, `orderBy`, `pageSize`, `pageToken`, `returnPartialSuccess`	Lists the `Destination` resources in a specified project and location.
`create`	`insert`	`projectsId`, `locationsId`, `multicloudDataTransferConfigsId`	`destinationId`, `requestId`	Creates a `Destination` resource in a specified project and location.
`patch`	`update`	`projectsId`, `locationsId`, `multicloudDataTransferConfigsId`, `destinationsId`	`requestId`, `updateMask`	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
list

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
;

Lists the Destination resources in a specified project and location.

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

`INSERT` examples

create
Manifest

Creates a Destination resource in a specified project and location.

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

# 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: endpoints
    description: |
      Required. Unordered list. The list of `DestinationEndpoint` resources configured for the IP prefix.
    value:
      - asn: "{{ asn }}"
        csp: "{{ csp }}"
        state: "{{ state }}"
        updateTime: "{{ updateTime }}"
  - 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: labels
    value: "{{ labels }}"
    description: |
      Optional. User-defined labels.
  - 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: destinationId
    value: "{{ destinationId }}"
  - name: requestId
    value: "{{ requestId }}"

`UPDATE` examples

patch

Updates a Destination resource in a specified project and location.

UPDATE google.networkconnectivity.destinations
SET 
data__description = '{{ description }}',
data__endpoints = '{{ endpoints }}',
data__etag = '{{ etag }}',
data__ipPrefix = '{{ ipPrefix }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND multicloudDataTransferConfigsId = '{{ multicloudDataTransferConfigsId }}' --required
AND destinationsId = '{{ destinationsId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
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 }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​