Class NetworkEndpointGroup (1.13.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, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless NEGs.

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

Attributes

NameDescription
annotations MutableMapping[str, str]
Metadata defined as annotations on the network endpoint group.
app_engine google.cloud.compute_v1.types.NetworkEndpointGroupAppEngine
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. This field is a member of oneof_ _app_engine.
cloud_function google.cloud.compute_v1.types.NetworkEndpointGroupCloudFunction
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. This field is a member of oneof_ _cloud_function.
cloud_run google.cloud.compute_v1.types.NetworkEndpointGroupCloudRun
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. This field is a member of oneof_ _cloud_run.
creation_timestamp str
[Output Only] Creation timestamp in RFC3339 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. 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] 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] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. This field is a member of oneof_ _kind.
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 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. 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 of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. 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_v1.types.NetworkEndpointGroupPscData
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". This field is a member of oneof_ _psc_target_service.
region str
[Output Only] The URL of the region where the network endpoint group is located. This field is a member of oneof_ _region.
self_link str
[Output Only] Server-defined URL for the resource. This field is a member of oneof_ _self_link.
size int
[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] The URL of the zone 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
NameDescription
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 of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT.

Values: UNDEFINED_NETWORK_ENDPOINT_TYPE (0): A value indicating that the enum field is not set. GCE_VM_IP (401880793): The network endpoint is represented by an IP address. GCE_VM_IP_PORT (501838375): The network endpoint is represented by IP address and port pair. INTERNET_FQDN_PORT (404154477): The network endpoint is represented by fully qualified domain name and port. INTERNET_IP_PORT (477719963): The network endpoint is represented by an internet IP address and port. NON_GCP_PRIVATE_IP_PORT (336447968): The network endpoint is represented by an IP address and port. The endpoint belongs to a VM or pod running in a customer's on-premises. PRIVATE_SERVICE_CONNECT (48134724): The network endpoint is either public Google APIs or services exposed by other GCP Project with a Service Attachment. The connection is set up by private service connect SERVERLESS (270492508): The network endpoint is handled by specified serverless infrastructure.