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.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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_data |
Google\Cloud\Compute\V1\NetworkEndpointGroupPscData
|
↳ 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setAnnotations
Metadata defined as annotations on the network endpoint group.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAppEngine
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\NetworkEndpointGroupAppEngine|null | |
hasAppEngine
clearAppEngine
setAppEngine
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\NetworkEndpointGroupAppEngine
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCloudFunction
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\NetworkEndpointGroupCloudFunction|null | |
hasCloudFunction
clearCloudFunction
setCloudFunction
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\NetworkEndpointGroupCloudFunction
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCloudRun
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\NetworkEndpointGroupCloudRun|null | |
hasCloudRun
clearCloudRun
setCloudRun
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\NetworkEndpointGroupCloudRun
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDefaultPort
The default port used if the port number is not specified in the network endpoint.
| Returns | |
|---|---|
| Type | Description |
int | |
hasDefaultPort
clearDefaultPort
setDefaultPort
The default port used if the port number is not specified in the network endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
An optional description of this resource. Provide this property when you create the resource.
| Returns | |
|---|---|
| Type | Description |
string | |
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetwork
The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
| Returns | |
|---|---|
| Type | Description |
string | |
hasNetwork
clearNetwork
setNetwork
The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPscData
Generated from protobuf field optional .google.cloud.compute.v1.NetworkEndpointGroupPscData psc_data = 71937481;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\NetworkEndpointGroupPscData|null | |
hasPscData
clearPscData
setPscData
Generated from protobuf field optional .google.cloud.compute.v1.NetworkEndpointGroupPscData psc_data = 71937481;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\NetworkEndpointGroupPscData
|
| Returns | |
|---|---|
| Type | Description |
$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"
| Returns | |
|---|---|
| Type | Description |
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"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRegion
[Output Only] The URL of the region where the network endpoint group is located.
| Returns | |
|---|---|
| Type | Description |
string | |
hasRegion
clearRegion
setRegion
[Output Only] The URL of the region where the network endpoint group is located.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSelfLink
[Output Only] Server-defined URL for the resource.
| Returns | |
|---|---|
| Type | Description |
string | |
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSize
[Output only] Number of network endpoints in the network endpoint group.
| Returns | |
|---|---|
| Type | Description |
int | |
hasSize
clearSize
setSize
[Output only] Number of network endpoints in the network endpoint group.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSubnetwork
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
| Returns | |
|---|---|
| Type | Description |
string | |
hasSubnetwork
clearSubnetwork
setSubnetwork
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getZone
[Output Only] The URL of the zone where the network endpoint group is located.
| Returns | |
|---|---|
| Type | Description |
string | |
hasZone
clearZone
setZone
[Output Only] The URL of the zone where the network endpoint group is located.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |