Class NetworkEndpointGroup (0.11.0) 

NetworkEndpointGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
annotations MutableMapping[str, str]
Optional. Metadata defined as annotations on the network endpoint group.
app_engine google.cloud.compute_v1beta.types.NetworkEndpointGroupAppEngine
Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. This field is a member of oneof_ _app_engine.
cloud_function google.cloud.compute_v1beta.types.NetworkEndpointGroupCloudFunction
Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. This field is a member of oneof_ _cloud_function.
cloud_run google.cloud.compute_v1beta.types.NetworkEndpointGroupCloudRun
Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. This field is a member of oneof_ _cloud_run.
creation_timestamp str
Output only. [Output Only] Creation timestamp inRFC3339 text format. This field is a member of oneof_ _creation_timestamp.
default_port int
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. This field is a member of oneof_ _default_port.
description str
An optional description of this resource. Provide this property when you create the resource. This field is a member of oneof_ _description.
id int
Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of oneof_ _id.
kind str
Output only. [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group. This field is a member of oneof_ _kind.
load_balancer google.cloud.compute_v1beta.types.NetworkEndpointGroupLbNetworkEndpointGroup
This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated. This field is a member of oneof_ _load_balancer.
name str
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. This field is a member of oneof_ _name.
network str
The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. This field is a member of oneof_ _network.
network_endpoint_type str
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. This field is a member of oneof_ _network_endpoint_type.
psc_data google.cloud.compute_v1beta.types.NetworkEndpointGroupPscData
Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. This field is a member of oneof_ _psc_data.
psc_target_service str
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. This field is a member of oneof_ _psc_target_service.
region str
Output only. [Output Only] The URL of theregion where the network endpoint group is located. This field is a member of oneof_ _region.
self_link str
Output only. [Output Only] Server-defined URL for the resource. This field is a member of oneof_ _self_link.
serverless_deployment google.cloud.compute_v1beta.types.NetworkEndpointGroupServerlessDeployment
Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine, cloudFunction orserverlessDeployment may be set. This field is a member of oneof_ _serverless_deployment.
size int
Output only. [Output only] Number of network endpoints in the network endpoint group. This field is a member of oneof_ _size.
subnetwork str
Optional URL of the subnetwork to which all network endpoints in the NEG belong. This field is a member of oneof_ _subnetwork.
zone str
Output only. [Output Only] The URL of thezone where the network endpoint group is located. This field is a member of oneof_ _zone.

Classes

AnnotationsEntry

AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

NetworkEndpointType

NetworkEndpointType(value)

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.