cross_site_networks

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

Overview

Name	cross_site_networks
Type	Resource
Id	google.compute.cross_site_networks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.
name	string	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
description	string	An optional description of the cross-site network.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#crossSiteNetwork for cross-site networks. (default: compute#crossSiteNetwork)
selfLink	string	Output only. [Output Only] Server-defined URL for the resource.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
etag	string
items	array	A list of CrossSiteNetwork resources.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#crossSiteNetwork for cross-site networks. (default: compute#crossSiteNetwork)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	[Output Only] Server-defined URL for this resource.
unreachables	array	Output only. [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, crossSiteNetwork		Returns the specified cross-site network in the given scope.
list	select	project	orderBy, filter, maxResults, pageToken, returnPartialSuccess	Lists the cross-site networks for a project in the given scope.
insert	insert	project	requestId, validateOnly	Creates a cross-site network in the specified project in the given scope using the parameters that are included in the request.
patch	update	project, crossSiteNetwork	requestId, updateMask, validateOnly	Updates the specified cross-site network with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
delete	delete	project, crossSiteNetwork	requestId	Deletes the specified cross-site network in the given scope.

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
crossSiteNetwork	string
project	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Returns the specified cross-site network in the given scope.

SELECT
id,
name,
creationTimestamp,
description,
kind,
selfLink
FROM google.compute.cross_site_networks
WHERE project = '{{ project }}' -- required
AND crossSiteNetwork = '{{ crossSiteNetwork }}' -- required
;

list

Lists the cross-site networks for a project in the given scope.

SELECT
id,
etag,
items,
kind,
nextPageToken,
selfLink,
unreachables,
warning
FROM google.compute.cross_site_networks
WHERE project = '{{ project }}' -- required
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

INSERT examples

insert

Creates a cross-site network in the specified project in the given scope
using the parameters that are included in the request.

INSERT INTO google.compute.cross_site_networks (
data__description,
data__name,
project,
requestId,
validateOnly
)
SELECT 
'{{ description }}',
'{{ name }}',
'{{ project }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: cross_site_networks
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the cross_site_networks resource.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of the cross-site network.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      Specifically, the name must be 1-63 characters long and match the regular
      expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      character must be a lowercase letter, and all following characters must
      be a dash, lowercase letter, or digit, except the last character, which
      cannot be a dash.
  - name: requestId
    value: "{{ requestId }}"
  - name: validateOnly
    value: {{ validateOnly }}

UPDATE examples

patch

Updates the specified cross-site network with the data included in
the request. This method supportsPATCH
semantics and uses theJSON merge
patch format and processing rules.

UPDATE google.compute.cross_site_networks
SET 
data__description = '{{ description }}',
data__name = '{{ name }}'
WHERE 
project = '{{ project }}' --required
AND crossSiteNetwork = '{{ crossSiteNetwork }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples

delete

Deletes the specified cross-site network in the given scope.

DELETE FROM google.compute.cross_site_networks
WHERE project = '{{ project }}' --required
AND crossSiteNetwork = '{{ crossSiteNetwork }}' --required
AND requestId = '{{ requestId }}'
;