notification_endpoints

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

Overview

Name	notification_endpoints
Type	Resource
Id	google.compute.notification_endpoints

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	Output only. [Output Only] A unique identifier for this 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 this resource. Provide this property when you create the resource.
grpcSettings	object	Settings of the gRPC notification endpoint including the endpoint URL and the retry duration. (id: NotificationEndpointGrpcSettings)
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints. (default: compute#notificationEndpoint)
region	string	Output only. [Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
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.
items	array	A list of NotificationEndpoint resources.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints. (default: compute#notificationEndpointList)
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.
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, region, notificationEndpoint		Returns the specified NotificationEndpoint resource in the given region.
list	select	project, region	orderBy, filter, maxResults, pageToken, returnPartialSuccess	Lists the NotificationEndpoints for a project in the given region.
insert	insert	project, region	requestId	Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.
delete	delete	project, region, notificationEndpoint	requestId	Deletes the specified NotificationEndpoint in the given region

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
notificationEndpoint	string
project	string
region	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified NotificationEndpoint resource in the given region.

SELECT
id,
name,
creationTimestamp,
description,
grpcSettings,
kind,
region,
selfLink
FROM google.compute.notification_endpoints
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND notificationEndpoint = '{{ notificationEndpoint }}' -- required
;

list

Lists the NotificationEndpoints for a project in the given region.

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

INSERT examples

insert

Create a NotificationEndpoint in the specified project in the given region
using the parameters that are included in the request.

INSERT INTO google.compute.notification_endpoints (
data__name,
data__grpcSettings,
data__description,
project,
region,
requestId
)
SELECT 
'{{ name }}',
'{{ grpcSettings }}',
'{{ description }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
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: notification_endpoints
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the notification_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the notification_endpoints resource.
  - 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: grpcSettings
    description: |
      Settings of the gRPC notification endpoint including the endpoint URL and
      the retry duration.
    value:
      authority: "{{ authority }}"
      endpoint: "{{ endpoint }}"
      retryDurationSec: {{ retryDurationSec }}
      payloadName: "{{ payloadName }}"
      resendInterval:
        nanos: {{ nanos }}
        seconds: "{{ seconds }}"
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

Deletes the specified NotificationEndpoint in the given region

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