Reference documentation and code samples for the Compute V1 Client 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, 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.
Generated from protobuf message google.cloud.compute.v1.NetworkEndpointGroup
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ annotations
array|Google\Protobuf\Internal\MapField
Metadata defined as annotations on the network endpoint group.
↳ app_engine
Google\Cloud\Compute\V1\NetworkEndpointGroupAppEngine
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
↳ cloud_function
Google\Cloud\Compute\V1\NetworkEndpointGroupCloudFunction
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
↳ cloud_run
Google\Cloud\Compute\V1\NetworkEndpointGroupCloudRun
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
↳ creation_timestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
↳ default_port
int
The default port used if the port number is not specified in the network endpoint.
↳ description
string
An optional description of this resource. Provide this property when you create the resource.
↳ id
int|string
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ kind
string
[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
↳ 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.
↳ network
string
The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
↳ network_endpoint_type
string
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.
↳ psc_target_service
string
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"
↳ region
string
[Output Only] The URL of the region where the network endpoint group is located.
↳ self_link
string
[Output Only] Server-defined URL for the resource.
↳ size
int
[Output only] Number of network endpoints in the network endpoint group.
↳ subnetwork
string
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
↳ zone
string
[Output Only] The URL of the zone where the network endpoint group is located.
getAnnotations
Metadata defined as annotations on the network endpoint group.
Generated from protobuf field map<string, string> annotations = 112032548;
Google\Protobuf\Internal\MapField
setAnnotations
Metadata defined as annotations on the network endpoint group.
Generated from protobuf field map<string, string> annotations = 112032548;
var
array|Google\Protobuf\Internal\MapField
$this
getAppEngine
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
Generated from protobuf field optional .google.cloud.compute.v1.NetworkEndpointGroupAppEngine app_engine = 340788768;
hasAppEngine
clearAppEngine
setAppEngine
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
Generated from protobuf field optional .google.cloud.compute.v1.NetworkEndpointGroupAppEngine app_engine = 340788768;
$this
getCloudFunction
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
Generated from protobuf field optional .google.cloud.compute.v1.NetworkEndpointGroupCloudFunction cloud_function = 519893666;
hasCloudFunction
clearCloudFunction
setCloudFunction
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
Generated from protobuf field optional .google.cloud.compute.v1.NetworkEndpointGroupCloudFunction cloud_function = 519893666;
$this
getCloudRun
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
Generated from protobuf field optional .google.cloud.compute.v1.NetworkEndpointGroupCloudRun cloud_run = 111060353;
hasCloudRun
clearCloudRun
setCloudRun
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
Generated from protobuf field optional .google.cloud.compute.v1.NetworkEndpointGroupCloudRun cloud_run = 111060353;
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
var
string
$this
getDefaultPort
The default port used if the port number is not specified in the network endpoint.
Generated from protobuf field optional int32 default_port = 423377855;
int
hasDefaultPort
clearDefaultPort
setDefaultPort
The default port used if the port number is not specified in the network endpoint.
Generated from protobuf field optional int32 default_port = 423377855;
var
int
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
Generated from protobuf field optional string description = 422937596;
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
Generated from protobuf field optional string description = 422937596;
var
string
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Generated from protobuf field optional uint64 id = 3355;
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Generated from protobuf field optional uint64 id = 3355;
var
int|string
$this
getKind
[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
Generated from protobuf field optional string kind = 3292052;
string
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
Generated from protobuf field optional string kind = 3292052;
var
string
$this
getName
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.
Generated from protobuf field optional string name = 3373707;
string
hasName
clearName
setName
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.
Generated from protobuf field optional string name = 3373707;
var
string
$this
getNetwork
The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
Generated from protobuf field optional string network = 232872494;
string
hasNetwork
clearNetwork
setNetwork
The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
Generated from protobuf field optional string network = 232872494;
var
string
$this
getNetworkEndpointType
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.
Generated from protobuf field optional string network_endpoint_type = 118301523;
string
hasNetworkEndpointType
clearNetworkEndpointType
setNetworkEndpointType
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.
Generated from protobuf field optional string network_endpoint_type = 118301523;
var
string
$this
getPscData
Generated from protobuf field optional .google.cloud.compute.v1.NetworkEndpointGroupPscData psc_data = 71937481;
hasPscData
clearPscData
setPscData
Generated from protobuf field optional .google.cloud.compute.v1.NetworkEndpointGroupPscData psc_data = 71937481;
$this
getPscTargetService
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"
Generated from protobuf field optional string psc_target_service = 269132134;
string
hasPscTargetService
clearPscTargetService
setPscTargetService
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"
Generated from protobuf field optional string psc_target_service = 269132134;
var
string
$this
getRegion
[Output Only] The URL of the region where the network endpoint group is located.
Generated from protobuf field optional string region = 138946292;
string
hasRegion
clearRegion
setRegion
[Output Only] The URL of the region where the network endpoint group is located.
Generated from protobuf field optional string region = 138946292;
var
string
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
var
string
$this
getSize
[Output only] Number of network endpoints in the network endpoint group.
Generated from protobuf field optional int32 size = 3530753;
int
hasSize
clearSize
setSize
[Output only] Number of network endpoints in the network endpoint group.
Generated from protobuf field optional int32 size = 3530753;
var
int
$this
getSubnetwork
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
Generated from protobuf field optional string subnetwork = 307827694;
string
hasSubnetwork
clearSubnetwork
setSubnetwork
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
Generated from protobuf field optional string subnetwork = 307827694;
var
string
$this
getZone
[Output Only] The URL of the zone where the network endpoint group is located.
Generated from protobuf field optional string zone = 3744684;
string
hasZone
clearZone
setZone
[Output Only] The URL of the zone where the network endpoint group is located.
Generated from protobuf field optional string zone = 3744684;
var
string
$this
