mirroring_endpoint_group_associations

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

Overview

Name	mirroring_endpoint_group_associations
Type	Resource
Id	google.networksecurity.mirroring_endpoint_group_associations

Fields

The following fields are returned by SELECT queries:

projects_locations_mirroring_endpoint_group_associations_get

Name	Datatype	Description
name	string	Immutable. Identifier. The resource name of this endpoint group association, for example: projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association. See https://google.aip.dev/122 for more details.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
labels	object	Optional. Labels are key/value pairs that help to organize and filter resources.
locations	array	Output only. The list of locations where the association is configured. This information is retrieved from the linked endpoint group.
locationsDetails	array	Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself.
mirroringEndpointGroup	string	Immutable. The endpoint group that this association is connected to, for example: projects/123456789/locations/global/mirroringEndpointGroups/my-eg. See https://google.aip.dev/124.
network	string	Immutable. The VPC network that is associated. for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124.
networkCookie	integer (uint32)	Output only. Identifier used by the data-path. See the NSI GENEVE format for more details: https://docs.cloud.google.com/network-security-integration/docs/understand-geneve#network_id
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 part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128.
state	string	Output only. Current state of the endpoint group association. (STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, CLOSED, 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_mirroring_endpoint_group_associations_list

Name	Datatype	Description
name	string	Immutable. Identifier. The resource name of this endpoint group association, for example: projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association. See https://google.aip.dev/122 for more details.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
labels	object	Optional. Labels are key/value pairs that help to organize and filter resources.
locations	array	Output only. The list of locations where the association is configured. This information is retrieved from the linked endpoint group.
locationsDetails	array	Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself.
mirroringEndpointGroup	string	Immutable. The endpoint group that this association is connected to, for example: projects/123456789/locations/global/mirroringEndpointGroups/my-eg. See https://google.aip.dev/124.
network	string	Immutable. The VPC network that is associated. for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124.
networkCookie	integer (uint32)	Output only. Identifier used by the data-path. See the NSI GENEVE format for more details: https://docs.cloud.google.com/network-security-integration/docs/understand-geneve#network_id
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 part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128.
state	string	Output only. Current state of the endpoint group association. (STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, CLOSED, 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_mirroring_endpoint_group_associations_get	select	projectsId, locationsId, mirroringEndpointGroupAssociationsId		Gets a specific association. See https://google.aip.dev/131.
projects_locations_mirroring_endpoint_group_associations_list	select	projectsId, locationsId	pageToken, orderBy, filter, pageSize	Lists associations in a given project and location. See https://google.aip.dev/132.
projects_locations_mirroring_endpoint_group_associations_create	insert	projectsId, locationsId	mirroringEndpointGroupAssociationId, requestId	Creates an association in a given project and location. See https://google.aip.dev/133.
projects_locations_mirroring_endpoint_group_associations_patch	update	projectsId, locationsId, mirroringEndpointGroupAssociationsId	requestId, updateMask	Updates an association. See https://google.aip.dev/134.
projects_locations_mirroring_endpoint_group_associations_delete	delete	projectsId, locationsId, mirroringEndpointGroupAssociationsId	requestId	Deletes an association. 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
mirroringEndpointGroupAssociationsId	string
projectsId	string
filter	string
mirroringEndpointGroupAssociationId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_mirroring_endpoint_group_associations_get

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

SELECT
name,
createTime,
labels,
locations,
locationsDetails,
mirroringEndpointGroup,
network,
networkCookie,
reconciling,
state,
updateTime
FROM google.networksecurity.mirroring_endpoint_group_associations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND mirroringEndpointGroupAssociationsId = '{{ mirroringEndpointGroupAssociationsId }}' -- required
;

projects_locations_mirroring_endpoint_group_associations_list

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

SELECT
name,
createTime,
labels,
locations,
locationsDetails,
mirroringEndpointGroup,
network,
networkCookie,
reconciling,
state,
updateTime
FROM google.networksecurity.mirroring_endpoint_group_associations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

projects_locations_mirroring_endpoint_group_associations_create

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

INSERT INTO google.networksecurity.mirroring_endpoint_group_associations (
data__network,
data__labels,
data__mirroringEndpointGroup,
data__name,
projectsId,
locationsId,
mirroringEndpointGroupAssociationId,
requestId
)
SELECT 
'{{ network }}',
'{{ labels }}',
'{{ mirroringEndpointGroup }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ mirroringEndpointGroupAssociationId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: mirroring_endpoint_group_associations
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the mirroring_endpoint_group_associations resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the mirroring_endpoint_group_associations resource.
  - name: network
    value: "{{ network }}"
    description: |
      Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels are key/value pairs that help to organize and filter resources.
  - name: mirroringEndpointGroup
    value: "{{ mirroringEndpointGroup }}"
    description: |
      Immutable. The endpoint group that this association is connected to, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/124.
  - name: name
    value: "{{ name }}"
    description: |
      Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details.
  - name: mirroringEndpointGroupAssociationId
    value: "{{ mirroringEndpointGroupAssociationId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

projects_locations_mirroring_endpoint_group_associations_patch

Updates an association. See https://google.aip.dev/134.

UPDATE google.networksecurity.mirroring_endpoint_group_associations
SET 
data__network = '{{ network }}',
data__labels = '{{ labels }}',
data__mirroringEndpointGroup = '{{ mirroringEndpointGroup }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND mirroringEndpointGroupAssociationsId = '{{ mirroringEndpointGroupAssociationsId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_mirroring_endpoint_group_associations_delete

Deletes an association. See https://google.aip.dev/135.

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