mirroring_endpoint_groups

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

Overview

Name	`mirroring_endpoint_groups`
Type	Resource
Id	`google.networksecurity.mirroring_endpoint_groups`

Fields

The following fields are returned by SELECT queries:

projects_locations_mirroring_endpoint_groups_get
projects_locations_mirroring_endpoint_groups_list

Successful response

Name	Datatype	Description
`name`	`string`	Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.
`associations`	`array`	Output only. List of associations to this endpoint group.
`connectedDeploymentGroups`	`array`	Output only. List of details about the connected deployment groups to this endpoint group.
`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.
`labels`	`object`	Optional. Labels are key/value pairs that help to organize and filter resources.
`mirroringDeploymentGroup`	`string`	Immutable. The deployment group that this DIRECT endpoint group is connected to, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124.
`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.
`updateTime`	`string (google-datetime)`	Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

Successful response

Name	Datatype	Description
`name`	`string`	Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.
`associations`	`array`	Output only. List of associations to this endpoint group.
`connectedDeploymentGroups`	`array`	Output only. List of details about the connected deployment groups to this endpoint group.
`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.
`labels`	`object`	Optional. Labels are key/value pairs that help to organize and filter resources.
`mirroringDeploymentGroup`	`string`	Immutable. The deployment group that this DIRECT endpoint group is connected to, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124.
`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.
`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_mirroring_endpoint_groups_get`	`select`	`projectsId`, `locationsId`, `mirroringEndpointGroupsId`		Gets a specific endpoint group. See https://google.aip.dev/131.
`projects_locations_mirroring_endpoint_groups_list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `filter`, `orderBy`	Lists endpoint groups in a given project and location. See https://google.aip.dev/132.
`projects_locations_mirroring_endpoint_groups_create`	`insert`	`projectsId`, `locationsId`	`mirroringEndpointGroupId`, `requestId`	Creates an endpoint group in a given project and location. See https://google.aip.dev/133.
`projects_locations_mirroring_endpoint_groups_patch`	`update`	`projectsId`, `locationsId`, `mirroringEndpointGroupsId`	`updateMask`, `requestId`	Updates an endpoint group. See https://google.aip.dev/134.
`projects_locations_mirroring_endpoint_groups_delete`	`delete`	`projectsId`, `locationsId`, `mirroringEndpointGroupsId`	`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
`locationsId`	`string`
`mirroringEndpointGroupsId`	`string`
`projectsId`	`string`
`filter`	`string`
`mirroringEndpointGroupId`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`requestId`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

projects_locations_mirroring_endpoint_groups_get
projects_locations_mirroring_endpoint_groups_list

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

SELECT
name,
associations,
connectedDeploymentGroups,
createTime,
description,
labels,
mirroringDeploymentGroup,
reconciling,
state,
updateTime
FROM google.networksecurity.mirroring_endpoint_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND mirroringEndpointGroupsId = '{{ mirroringEndpointGroupsId }}' -- required;

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

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

`INSERT` examples

projects_locations_mirroring_endpoint_groups_create
Manifest

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

INSERT INTO google.networksecurity.mirroring_endpoint_groups (
data__name,
data__labels,
data__mirroringDeploymentGroup,
data__description,
projectsId,
locationsId,
mirroringEndpointGroupId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ mirroringDeploymentGroup }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ mirroringEndpointGroupId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: mirroring_endpoint_groups
  props:
    - name: projectsId
      value: string
      description: Required parameter for the mirroring_endpoint_groups resource.
    - name: locationsId
      value: string
      description: Required parameter for the mirroring_endpoint_groups resource.
    - name: name
      value: string
      description: >
        Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.
        
    - name: labels
      value: object
      description: >
        Optional. Labels are key/value pairs that help to organize and filter resources.
        
    - name: mirroringDeploymentGroup
      value: string
      description: >
        Immutable. The deployment group that this DIRECT endpoint group is connected to, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124.
        
    - name: description
      value: string
      description: >
        Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group.
        
    - name: mirroringEndpointGroupId
      value: string
    - name: requestId
      value: string

`UPDATE` examples

projects_locations_mirroring_endpoint_groups_patch

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

UPDATE google.networksecurity.mirroring_endpoint_groups
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__mirroringDeploymentGroup = '{{ mirroringDeploymentGroup }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND mirroringEndpointGroupsId = '{{ mirroringEndpointGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

projects_locations_mirroring_endpoint_groups_delete

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

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​