REST Resource: projects.locations.mirroringEndpointGroups

Resource: MirroringEndpointGroup

An endpoint group is a consumer frontend for a deployment group (backend). In order to configure mirroring for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A mirroring rule that references the security profile (group).

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "mirroringDeploymentGroup": string,
  "state": enum (State),
  "reconciling": boolean,
  "associations": [
    {
      object (AssociationDetails)
    }
  ],
  "description": string
}
Fields
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.
createTime

string (Timestamp format)

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Labels are key/value pairs that help to organize and filter resources.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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.
state

enum (State)

Output only. The current state of the endpoint group. See https://google.aip.dev/216.
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.
associations[]

object (AssociationDetails)

Output only. List of associations to this endpoint group.
description

string

Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group.

State

The current state of the endpoint group.

Enums
STATE_UNSPECIFIED State not set (this is not a valid state).
ACTIVE The endpoint group is ready and in sync with the target deployment group.
CLOSED The deployment group backing this endpoint group has been force-deleted. This endpoint group cannot be used and mirroring is effectively disabled.
CREATING The endpoint group is being created.
DELETING The endpoint group is being deleted.
OUT_OF_SYNC The endpoint group is out of sync with the backing deployment group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically. See the associations field for details per network and location.
DELETE_FAILED An attempt to delete the endpoint group has failed. This is a terminal state and the endpoint group is not expected to recover. The only permitted operation is to retry deleting the endpoint group.

AssociationDetails

The endpoint group's view of a connected association.

JSON representation 
{
  "name": string,
  "network": string,
  "state": enum (State)
}
Fields
name

string

Output only. The connected association's resource name, for example: projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-ega. See https://google.aip.dev/124.
network

string

Output only. The associated network, for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124.
state

enum (State)

Output only. Most recent known state of the association.

Methods

create

 Creates an endpoint group in a given project and location.

delete

 Deletes an endpoint group.

get

 Gets a specific endpoint group.

list

 Lists endpoint groups in a given project and location.

patch

 Updates an endpoint group.