network_edge_security_services

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

Overview

Name	network_edge_security_services
Type	Resource
Id	google.compute.network_edge_security_services

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. This identifier is defined by the server.
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 this resource. Provide this property when you create the resource.
fingerprint	string (byte)	Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.
kind	string	Output only. [Output only] Type of the resource. Alwayscompute#networkEdgeSecurityService for NetworkEdgeSecurityServices (default: compute#networkEdgeSecurityService)
region	string	Output only. [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
securityPolicy	string	The resource URL for the network edge security service associated with this network edge security service.
selfLink	string	Output only. [Output Only] Server-defined URL for the resource.
selfLinkWithId	string	Output only. [Output Only] Server-defined URL for this resource with the resource id.

aggregated_list

Name	Datatype	Description
id	string (uint64)	Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
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 this resource. Provide this property when you create the resource.
fingerprint	string (byte)	Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.
kind	string	Output only. [Output only] Type of the resource. Alwayscompute#networkEdgeSecurityService for NetworkEdgeSecurityServices (default: compute#networkEdgeSecurityService)
region	string	Output only. [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
securityPolicy	string	The resource URL for the network edge security service associated with this network edge security service.
selfLink	string	Output only. [Output Only] Server-defined URL for the resource.
selfLinkWithId	string	Output only. [Output Only] Server-defined URL for this resource with the resource id.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region, networkEdgeSecurityService		Gets a specified NetworkEdgeSecurityService.
aggregated_list	select	project	includeAllScopes, orderBy, filter, serviceProjectNumber, maxResults, pageToken, returnPartialSuccess	Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
insert	insert	project, region	requestId, validateOnly	Creates a new service in the specified project using the data included in the request.
patch	update	project, region, networkEdgeSecurityService	updateMask, requestId, paths	Patches the specified policy with the data included in the request.
delete	delete	project, region, networkEdgeSecurityService	requestId	Deletes the specified service.

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
networkEdgeSecurityService	string
project	string
region	string
filter	string
includeAllScopes	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string
paths	string
requestId	string
returnPartialSuccess	boolean
serviceProjectNumber	string (int64)
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Gets a specified NetworkEdgeSecurityService.

SELECT
id,
name,
creationTimestamp,
description,
fingerprint,
kind,
region,
securityPolicy,
selfLink,
selfLinkWithId
FROM google.compute.network_edge_security_services
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND networkEdgeSecurityService = '{{ networkEdgeSecurityService }}' -- required
;

aggregated_list

Retrieves the list of all NetworkEdgeSecurityService resources available to
the specified project.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.

SELECT
id,
name,
creationTimestamp,
description,
fingerprint,
kind,
region,
securityPolicy,
selfLink,
selfLinkWithId
FROM google.compute.network_edge_security_services
WHERE project = '{{ project }}' -- required
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

INSERT examples

insert

Creates a new service in the specified project using the data included in
the request.

INSERT INTO google.compute.network_edge_security_services (
data__fingerprint,
data__name,
data__securityPolicy,
data__description,
project,
region,
requestId,
validateOnly
)
SELECT 
'{{ fingerprint }}',
'{{ name }}',
'{{ securityPolicy }}',
'{{ description }}',
'{{ project }}',
'{{ region }}',
'{{ 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: network_edge_security_services
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the network_edge_security_services resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the network_edge_security_services resource.
  - name: fingerprint
    value: "{{ fingerprint }}"
    description: |
      Fingerprint of this resource. A hash of the contents stored in this object.
      This field is used in optimistic locking. This field will be ignored when
      inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be
      provided in order to update the NetworkEdgeSecurityService,
      otherwise the request will fail with error412 conditionNotMet.
      To see the latest fingerprint, make a get() request to
      retrieve a NetworkEdgeSecurityService.
  - 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: securityPolicy
    value: "{{ securityPolicy }}"
    description: |
      The resource URL for the network edge security service associated with this
      network edge security service.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: requestId
    value: "{{ requestId }}"
  - name: validateOnly
    value: {{ validateOnly }}

UPDATE examples

patch

Patches the specified policy with the data included in the request.

UPDATE google.compute.network_edge_security_services
SET 
data__fingerprint = '{{ fingerprint }}',
data__name = '{{ name }}',
data__securityPolicy = '{{ securityPolicy }}',
data__description = '{{ description }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND networkEdgeSecurityService = '{{ networkEdgeSecurityService }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
AND paths = '{{ paths}}'
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 service.

DELETE FROM google.compute.network_edge_security_services
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND networkEdgeSecurityService = '{{ networkEdgeSecurityService }}' --required
AND requestId = '{{ requestId }}'
;