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

Successful response

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 was created.
description	string	Optional. An optional field to provide a description of this resource.
endpoints	array	Required. Unordered list. The list of Endpoints configured for the IP Prefix.
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.
ipPrefix	string	Required. Immutable. Remote IP Prefix in the remote CSP, where the customer's workload is located
labels	object	Optional. User-defined labels.
stateTimeline	object	The timeline of pending states for a resource. (id: StateTimeline)
uid	string	Output only. The Google-generated UUID for the destination. This value is unique across all destination resources. If a destination is deleted and another with the same name is created, the new destination is assigned a different uid.
updateTime	string (google-datetime)	Output only. Time when the Destination was updated.

list

Successful response

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 was created.
description	string	Optional. An optional field to provide a description of this resource.
endpoints	array	Required. Unordered list. The list of Endpoints configured for the IP Prefix.
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.
ipPrefix	string	Required. Immutable. Remote IP Prefix in the remote CSP, where the customer's workload is located
labels	object	Optional. User-defined labels.
stateTimeline	object	The timeline of pending states for a resource. (id: StateTimeline)
uid	string	Output only. The Google-generated UUID for the destination. This value is unique across all destination resources. If a destination is deleted and another with the same name is created, the new destination is assigned a different uid.
updateTime	string (google-datetime)	Output only. Time when the Destination 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 details of a single Destination.
list	select	projectsId, locationsId, multicloudDataTransferConfigsId	pageSize, pageToken, filter, orderBy, returnPartialSuccess	Lists Destinations in a given project and location.
create	insert	projectsId, locationsId, multicloudDataTransferConfigsId	destinationId, requestId	Creates a Destination in a given project and location.
patch	update	projectsId, locationsId, multicloudDataTransferConfigsId, destinationsId	updateMask, requestId	Updates a Destination in a given project and location.
delete	delete	projectsId, locationsId, multicloudDataTransferConfigsId, destinationsId	requestId, etag	Deletes a single Destination.

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

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

INSERT examples

create

Creates a Destination in a given project and location.

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

Manifest

# Description fields are for documentation purposes
- name: destinations
  props:
    - name: projectsId
      value: string
      description: Required parameter for the destinations resource.
    - name: locationsId
      value: string
      description: Required parameter for the destinations resource.
    - name: multicloudDataTransferConfigsId
      value: string
      description: Required parameter for the destinations resource.
    - name: name
      value: string
      description: >
        Identifier. The name of the Destination resource. Format: `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}`.
        
    - 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: ipPrefix
      value: string
      description: >
        Required. Immutable. Remote IP Prefix in the remote CSP, where the customer's workload is located
        
    - name: endpoints
      value: array
      description: >
        Required. Unordered list. The list of Endpoints configured for the IP Prefix.
        
    - name: destinationId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates a Destination in a given project and location.

UPDATE google.networkconnectivity.destinations
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
data__description = '{{ description }}',
data__ipPrefix = '{{ ipPrefix }}',
data__endpoints = '{{ endpoints }}'
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 single Destination.

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