REST Resource: projects.locations.mirroringDeploymentGroups

Resource: MirroringDeploymentGroup

A deployment group aggregates many zonal mirroring backends (deployments) into a single global mirroring service. Consumers can connect this service using an endpoint group.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "network": string,
  "connectedEndpointGroups": [
    {
      object (ConnectedEndpointGroup)
    }
  ],
  "nestedDeployments": [
    {
      object (Deployment)
    }
  ],
  "state": enum (State),
  "reconciling": boolean,
  "description": string
}
Fields
name

string

Immutable. Identifier. The resource name of this deployment group, for example: projects/123456789/locations/global/mirroringDeploymentGroups/my-dg. 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" }.
network

string

Required. Immutable. The network that will be used for all child deployments, for example: projects/{project}/global/networks/{network}. See https://google.aip.dev/124.
connectedEndpointGroups[]

object (ConnectedEndpointGroup)

Output only. The list of endpoint groups that are connected to this resource.
nestedDeployments[]

object (Deployment)

Output only. The list of Mirroring Deployments that belong to this group.
state

enum (State)

Output only. The current state of the deployment 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 deployment to the group) See https://google.aip.dev/128.
description

string

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

ConnectedEndpointGroup

An endpoint group connected to this deployment group.

JSON representation 
{
  "name": string
}
Fields
name

string

Output only. The connected endpoint group's resource name, for example: projects/123456789/locations/global/mirroringEndpointGroups/my-eg. See https://google.aip.dev/124.

Deployment

A deployment belonging to this deployment group.

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

string

Output only. The name of the Mirroring Deployment, in the format: projects/{project}/locations/{location}/mirroringDeployments/{mirroringDeployment}.
state

enum (State)

Output only. Most recent known state of the deployment.

State

The current state of the deployment group.

Enums
STATE_UNSPECIFIED State not set (this is not a valid state).
ACTIVE The deployment group is ready.
CREATING The deployment group is being created.
DELETING The deployment group is being deleted.

Methods

create

 Creates a deployment group in a given project and location.

delete

 Deletes a deployment group.

get

 Gets a specific deployment group.

list

 Lists deployment groups in a given project and location.

patch

 Updates a deployment group.