endpoints

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

Overview

Name	endpoints
Type	Resource
Id	google.ids.endpoints

Fields

Name	Datatype	Description
name	string	Output only. The name of the endpoint.
description	string	User-provided description of the endpoint
createTime	string	Output only. The create time timestamp.
endpointForwardingRule	string	Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule.
endpointIp	string	Output only. The IP address of the IDS Endpoint's ILB.
labels	object	The labels of the endpoint.
network	string	Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
satisfiesPzi	boolean	Output only. [Output Only] Reserved for future use.
satisfiesPzs	boolean	Output only. [Output Only] Reserved for future use.
severity	string	Required. Lowest threat severity that this endpoint will alert on.
state	string	Output only. Current state of the endpoint.
threatExceptions	array	List of threat IDs to be excepted from generating alerts.
trafficLogs	boolean	Whether the endpoint should report traffic logs in addition to threat logs.
updateTime	string	Output only. The update time timestamp.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	endpointsId, locationsId, projectsId	Gets details of a single Endpoint.
list	SELECT	locationsId, projectsId	Lists Endpoints in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new Endpoint in a given project and location.
delete	DELETE	endpointsId, locationsId, projectsId	Deletes a single Endpoint.
patch	UPDATE	endpointsId, locationsId, projectsId	Updates the parameters of a single Endpoint.

SELECT examples

Lists Endpoints in a given project and location.

SELECT
name,
description,
createTime,
endpointForwardingRule,
endpointIp,
labels,
network,
satisfiesPzi,
satisfiesPzs,
severity,
state,
threatExceptions,
trafficLogs,
updateTime
FROM google.ids.endpoints
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new endpoints resource.

All Properties

/*+ create */
INSERT INTO google.ids.endpoints (
locationsId,
projectsId,
labels,
network,
description,
severity,
threatExceptions,
trafficLogs
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ labels }}',
'{{ network }}',
'{{ description }}',
'{{ severity }}',
'{{ threatExceptions }}',
{{ trafficLogs }}
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: network
      value: string
    - name: endpointForwardingRule
      value: string
    - name: endpointIp
      value: string
    - name: description
      value: string
    - name: severity
      value: string
    - name: threatExceptions
      value:
        - string
    - name: state
      value: string
    - name: trafficLogs
      value: boolean
    - name: satisfiesPzs
      value: boolean
    - name: satisfiesPzi
      value: boolean

UPDATE example

Updates a endpoints resource.

/*+ update */
UPDATE google.ids.endpoints
SET 
labels = '{{ labels }}',
network = '{{ network }}',
description = '{{ description }}',
severity = '{{ severity }}',
threatExceptions = '{{ threatExceptions }}',
trafficLogs = true|false
WHERE 
endpointsId = '{{ endpointsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified endpoints resource.

/*+ delete */
DELETE FROM google.ids.endpoints
WHERE endpointsId = '{{ endpointsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';