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
aggregated_list

Successful response

Name	Datatype	Description
`id`	`string (uint64)`	[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 with RFC1035. 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?)
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.
`kind`	`string`	[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices (default: compute#networkEdgeSecurityService)
`region`	`string`	[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] Server-defined URL for the resource.
`selfLinkWithId`	`string`	[Output Only] Server-defined URL for this resource with the resource id.

Successful response

Name	Datatype	Description
`id`	`string (uint64)`	[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 with RFC1035. 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?)
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.
`kind`	`string`	[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices (default: compute#networkEdgeSecurityService)
`region`	`string`	[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] Server-defined URL for the resource.
`selfLinkWithId`	`string`	[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`	`filter`, `includeAllScopes`, `maxResults`, `orderBy`, `pageToken`, `returnPartialSuccess`, `serviceProjectNumber`	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`	`paths`, `requestId`, `updateMask`	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
aggregated_list

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;

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

`INSERT` examples

insert
Manifest

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

INSERT INTO google.compute.network_edge_security_services (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__selfLink,
data__selfLinkWithId,
data__region,
data__fingerprint,
data__securityPolicy,
project,
region,
requestId,
validateOnly
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ selfLink }}',
'{{ selfLinkWithId }}',
'{{ region }}',
'{{ fingerprint }}',
'{{ securityPolicy }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: network_edge_security_services
  props:
    - name: project
      value: string
      description: Required parameter for the network_edge_security_services resource.
    - name: region
      value: string
      description: Required parameter for the network_edge_security_services resource.
    - name: kind
      value: string
      description: >
        [Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices
        
      default: compute#networkEdgeSecurityService
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. 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: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: selfLinkWithId
      value: string
      description: >
        [Output Only] Server-defined URL for this resource with the resource id.
        
    - name: region
      value: string
      description: >
        [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.
        
    - name: fingerprint
      value: string
      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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.
        
    - name: securityPolicy
      value: string
      description: >
        The resource URL for the network edge security service associated with this network edge security service.
        
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean

`UPDATE` examples

patch

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

UPDATE google.compute.network_edge_security_services
SET 
data__kind = '{{ kind }}',
data__id = '{{ id }}',
data__creationTimestamp = '{{ creationTimestamp }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__selfLink = '{{ selfLink }}',
data__selfLinkWithId = '{{ selfLinkWithId }}',
data__region = '{{ region }}',
data__fingerprint = '{{ fingerprint }}',
data__securityPolicy = '{{ securityPolicy }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND networkEdgeSecurityService = '{{ networkEdgeSecurityService }}' --required
AND paths = '{{ paths}}'
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
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 }}';

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​