REST Resource: networkEndpointGroups

Resource: NetworkEndpointGroup

Represents a collection of network endpoints.

A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "selfLink": string,
  "name": string,
  "description": string,
  "networkEndpointType": enum (NetworkEndpointType),
  "size": integer,
  "region": string,
  "zone": string,
  "network": string,
  "subnetwork": string,
  "defaultPort": integer,
  "annotations": {
    string: string,
    ...
  },
  "cloudRun": {
    object (CloudRun)
  },
  "appEngine": {
    object (AppEngine)
  },
  "cloudFunction": {
    object (CloudFunction)
  },
  "pscTargetService": string,
  "pscData": {
    object (PscData)
  }
}
Fields
kind

string

[Output Only] Type of the resource. Always

compute#networkEndpointGroup

for network endpoint group.
id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description

string

An optional description of this resource. Provide this property when you create the resource.
networkEndpointType

enum (NetworkEndpointType)

Type of network endpoints in this network endpoint group. Can be one of

GCE_VM_IP

,

GCE_VM_IP_PORT

,

NON_GCP_PRIVATE_IP_PORT

,

INTERNET_FQDN_PORT

,

INTERNET_IP_PORT

,

SERVERLESS

,

PRIVATE_SERVICE_CONNECT

,

GCE_VM_IP_PORTMAP

.
size

integer

[Output only] Number of network endpoints in the network endpoint group.
region

string

[Output Only] The URL of the region where the network endpoint group is located.
zone

string

[Output Only] The URL of the zone where the network endpoint group is located.
network

string

The URL of the network to which all network endpoints in the NEG belong. Uses

default

project network if unspecified.
subnetwork

string

Optional URL of the subnetwork to which all network endpoints in the NEG belong.
defaultPort

integer

The default port used if the port number is not specified in the network endpoint.

Optional. If the network endpoint type is either

GCE_VM_IP

,

SERVERLESS

or

PRIVATE_SERVICE_CONNECT

, this field must not be specified.
annotations

map (key: string, value: string)

Optional. Metadata defined as annotations on the network endpoint group.
cloudRun

object (CloudRun)

Optional. Only valid when

networkEndpointType

is

SERVERLESS. Only one of cloudRun

,

appEngine

or

cloudFunction

may be set.
appEngine

object (AppEngine)

Optional. Only valid when

networkEndpointType

is

SERVERLESS

. Only one of

cloudRun

,

appEngine

or

cloudFunction

may be set.
cloudFunction

object (CloudFunction)

Optional. Only valid when

networkEndpointType

is

SERVERLESS

. Only one of

cloudRun

,

appEngine

or

cloudFunction

may be set.
pscTargetService

string

The target service url used to set up private service connection to a Trusted Cloud API or a PSC Producer Service Attachment. An example value is:

asia-northeast3-cloudkms.googleapis.com

.

Optional. Only valid when

networkEndpointType

is

PRIVATE_SERVICE_CONNECT

.
pscData

object (PscData)

Optional. Only valid when

networkEndpointType

is

PRIVATE_SERVICE_CONNECT

.

Methods

aggregatedList

 Retrieves the list of network endpoint groups and sorts them by zone.

attachNetworkEndpoints

 Attach a list of network endpoints to the specified network endpoint group.

delete

 Deletes the specified network endpoint group.

detachNetworkEndpoints

 Detach a list of network endpoints from the specified network endpoint group.

get

 Returns the specified network endpoint group.

insert

 Creates a network endpoint group in the specified project using the parameters that are included in the request.

list

 Retrieves the list of network endpoint groups that are located in the specified project and zone.

listNetworkEndpoints

 Lists the network endpoints in the specified network endpoint group.

testIamPermissions

 The method compute.v1.NetworkEndpointGroupsService.TestPermissions is not available in Trusted Cloud by S3NS.