intercept_endpoint_groups

Creates, updates, deletes, gets or lists an intercept_endpoint_groups resource.

Overview

Name	intercept_endpoint_groups
Type	Resource
Id	google.networksecurity.intercept_endpoint_groups

Fields

The following fields are returned by SELECT queries:

projects_locations_intercept_endpoint_groups_get

Name	Datatype	Description
name	string	Immutable. Identifier. The resource name of this endpoint group, for example: projects/123456789/locations/global/interceptEndpointGroups/my-eg. See https://google.aip.dev/122 for more details.
associations	array	Output only. List of associations to this endpoint group.
connectedDeploymentGroup	object	Output only. Details about the connected deployment group to this endpoint group. (id: InterceptEndpointGroupConnectedDeploymentGroup)
createTime	string (google-datetime)	Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
description	string	Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group.
interceptDeploymentGroup	string	Required. Immutable. The deployment group that this endpoint group is connected to, for example: projects/123456789/locations/global/interceptDeploymentGroups/my-dg. See https://google.aip.dev/124.
labels	object	Optional. Labels are key/value pairs that help to organize and filter resources.
reconciling	boolean	Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128.
state	string	Output only. The current state of the endpoint group. See https://google.aip.dev/216. (STATE_UNSPECIFIED, ACTIVE, CLOSED, CREATING, DELETING, OUT_OF_SYNC, DELETE_FAILED)
updateTime	string (google-datetime)	Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

projects_locations_intercept_endpoint_groups_list

Name	Datatype	Description
name	string	Immutable. Identifier. The resource name of this endpoint group, for example: projects/123456789/locations/global/interceptEndpointGroups/my-eg. See https://google.aip.dev/122 for more details.
associations	array	Output only. List of associations to this endpoint group.
connectedDeploymentGroup	object	Output only. Details about the connected deployment group to this endpoint group. (id: InterceptEndpointGroupConnectedDeploymentGroup)
createTime	string (google-datetime)	Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
description	string	Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group.
interceptDeploymentGroup	string	Required. Immutable. The deployment group that this endpoint group is connected to, for example: projects/123456789/locations/global/interceptDeploymentGroups/my-dg. See https://google.aip.dev/124.
labels	object	Optional. Labels are key/value pairs that help to organize and filter resources.
reconciling	boolean	Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128.
state	string	Output only. The current state of the endpoint group. See https://google.aip.dev/216. (STATE_UNSPECIFIED, ACTIVE, CLOSED, CREATING, DELETING, OUT_OF_SYNC, DELETE_FAILED)
updateTime	string (google-datetime)	Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_intercept_endpoint_groups_get	select	projectsId, locationsId, interceptEndpointGroupsId		Gets a specific endpoint group. See https://google.aip.dev/131.
projects_locations_intercept_endpoint_groups_list	select	projectsId, locationsId	pageToken, orderBy, filter, pageSize	Lists endpoint groups in a given project and location. See https://google.aip.dev/132.
projects_locations_intercept_endpoint_groups_create	insert	projectsId, locationsId	requestId, interceptEndpointGroupId	Creates an endpoint group in a given project and location. See https://google.aip.dev/133.
projects_locations_intercept_endpoint_groups_patch	update	projectsId, locationsId, interceptEndpointGroupsId	requestId, updateMask	Updates an endpoint group. See https://google.aip.dev/134.
projects_locations_intercept_endpoint_groups_delete	delete	projectsId, locationsId, interceptEndpointGroupsId	requestId	Deletes an endpoint group. See https://google.aip.dev/135.

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
interceptEndpointGroupsId	string
locationsId	string
projectsId	string
filter	string
interceptEndpointGroupId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_intercept_endpoint_groups_get

Gets a specific endpoint group. See https://google.aip.dev/131.

SELECT
name,
associations,
connectedDeploymentGroup,
createTime,
description,
interceptDeploymentGroup,
labels,
reconciling,
state,
updateTime
FROM google.networksecurity.intercept_endpoint_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND interceptEndpointGroupsId = '{{ interceptEndpointGroupsId }}' -- required
;

projects_locations_intercept_endpoint_groups_list

Lists endpoint groups in a given project and location. See https://google.aip.dev/132.

SELECT
name,
associations,
connectedDeploymentGroup,
createTime,
description,
interceptDeploymentGroup,
labels,
reconciling,
state,
updateTime
FROM google.networksecurity.intercept_endpoint_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

projects_locations_intercept_endpoint_groups_create

Creates an endpoint group in a given project and location. See https://google.aip.dev/133.

INSERT INTO google.networksecurity.intercept_endpoint_groups (
data__name,
data__description,
data__labels,
data__interceptDeploymentGroup,
projectsId,
locationsId,
requestId,
interceptEndpointGroupId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ interceptDeploymentGroup }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ requestId }}',
'{{ interceptEndpointGroupId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: intercept_endpoint_groups
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the intercept_endpoint_groups resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the intercept_endpoint_groups resource.
  - name: name
    value: "{{ name }}"
    description: |
      Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels are key/value pairs that help to organize and filter resources.
  - name: interceptDeploymentGroup
    value: "{{ interceptDeploymentGroup }}"
    description: |
      Required. Immutable. The deployment group that this endpoint group is connected to, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/124.
  - name: requestId
    value: "{{ requestId }}"
  - name: interceptEndpointGroupId
    value: "{{ interceptEndpointGroupId }}"

UPDATE examples

projects_locations_intercept_endpoint_groups_patch

Updates an endpoint group. See https://google.aip.dev/134.

UPDATE google.networksecurity.intercept_endpoint_groups
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__interceptDeploymentGroup = '{{ interceptDeploymentGroup }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND interceptEndpointGroupsId = '{{ interceptEndpointGroupsId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_intercept_endpoint_groups_delete

Deletes an endpoint group. See https://google.aip.dev/135.

DELETE FROM google.networksecurity.intercept_endpoint_groups
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND interceptEndpointGroupsId = '{{ interceptEndpointGroupsId }}' --required
AND requestId = '{{ requestId }}'
;