Compute Engine v1 API - Class NetworkEndpointGroup (3.25.0)

public sealed class NetworkEndpointGroup : IMessage<NetworkEndpointGroup>, IEquatable<NetworkEndpointGroup>, IDeepCloneable<NetworkEndpointGroup>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class 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, seeNetwork endpoint groups overview.

Note: Use the following APIs to manage network endpoint groups:

- To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity NEGs): zonal API - To manage NEGs with regional scope (such as regional internet NEGs, serverless NEGs, Private Service Connect NEGs): regional API - To manage NEGs with global scope (such as global internet NEGs):global API

Inheritance

object > NetworkEndpointGroup

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

NetworkEndpointGroup()

public NetworkEndpointGroup()

NetworkEndpointGroup(NetworkEndpointGroup)

public NetworkEndpointGroup(NetworkEndpointGroup other)
Parameter
Name Description
other NetworkEndpointGroup

Properties

Annotations

public MapField<string, string> Annotations { get; }

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

Property Value
Type Description
MapFieldstringstring

AppEngine

public NetworkEndpointGroupAppEngine AppEngine { get; set; }

Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.

Property Value
Type Description
NetworkEndpointGroupAppEngine

CloudFunction

public NetworkEndpointGroupCloudFunction CloudFunction { get; set; }

Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.

Property Value
Type Description
NetworkEndpointGroupCloudFunction

CloudRun

public NetworkEndpointGroupCloudRun CloudRun { get; set; }

Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.

Property Value
Type Description
NetworkEndpointGroupCloudRun

CreationTimestamp

public string CreationTimestamp { get; set; }

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Property Value
Type Description
string

DefaultPort

public int DefaultPort { get; set; }

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.

Property Value
Type Description
int

Description

public string Description { get; set; }

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

Property Value
Type Description
string

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
Type Description
bool

HasDefaultPort

public bool HasDefaultPort { get; }

Gets whether the "default_port" field is set

Property Value
Type Description
bool

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type Description
bool

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
Type Description
bool

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type Description
bool

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type Description
bool

HasNetwork

public bool HasNetwork { get; }

Gets whether the "network" field is set

Property Value
Type Description
bool

HasNetworkEndpointType

public bool HasNetworkEndpointType { get; }

Gets whether the "network_endpoint_type" field is set

Property Value
Type Description
bool

HasPscTargetService

public bool HasPscTargetService { get; }

Gets whether the "psc_target_service" field is set

Property Value
Type Description
bool

HasRegion

public bool HasRegion { get; }

Gets whether the "region" field is set

Property Value
Type Description
bool
public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
Type Description
bool

HasSize

public bool HasSize { get; }

Gets whether the "size" field is set

Property Value
Type Description
bool

HasSubnetwork

public bool HasSubnetwork { get; }

Gets whether the "subnetwork" field is set

Property Value
Type Description
bool

HasZone

public bool HasZone { get; }

Gets whether the "zone" field is set

Property Value
Type Description
bool

Id

public ulong Id { get; set; }

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

Property Value
Type Description
ulong

Kind

public string Kind { get; set; }

Output only. [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group.

Property Value
Type Description
string

Name

public string Name { get; set; }

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

Property Value
Type Description
string

Network

public string Network { get; set; }

The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified.

Property Value
Type Description
string

NetworkEndpointType

public string NetworkEndpointType { get; set; }

Type of network endpoints in this network endpoint group. Can be one ofGCE_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. Check the NetworkEndpointType enum for the list of possible values.

Property Value
Type Description
string

PscData

public NetworkEndpointGroupPscData PscData { get; set; }

Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.

Property Value
Type Description
NetworkEndpointGroupPscData

PscTargetService

public string PscTargetService { get; set; }

The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com.

Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.

Property Value
Type Description
string

Region

public string Region { get; set; }

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

Property Value
Type Description
string
public string SelfLink { get; set; }

Output only. [Output Only] Server-defined URL for the resource.

Property Value
Type Description
string

Size

public int Size { get; set; }

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

Property Value
Type Description
int

Subnetwork

public string Subnetwork { get; set; }

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

Property Value
Type Description
string

Zone

public string Zone { get; set; }

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

Property Value
Type Description
string