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 for different use cases, see Network endpoint groups overview.
Generated from protobuf message google.cloud.compute.v1.NetworkEndpointGroup
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ annotations | array|Google\Protobuf\Internal\MapFieldOptional. Metadata defined as annotations on the network endpoint group. |
↳ app_engine | NetworkEndpointGroupAppEngineOptional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. |
↳ cloud_function | NetworkEndpointGroupCloudFunctionOptional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. |
↳ cloud_run | NetworkEndpointGroupCloudRunOptional. 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 | intThe 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. |
↳ description | stringAn 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 | stringName 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 | stringThe URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. |
↳ network_endpoint_type | stringType 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, GCE_VM_IP_PORTMAP. Check the NetworkEndpointType enum for the list of possible values. |
↳ psc_data | NetworkEndpointGroupPscDataOptional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. |
↳ psc_target_service | stringThe 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 is PRIVATE_SERVICE_CONNECT. |
↳ 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 | stringOptional 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
Optional. Metadata defined as annotations on the network endpoint group.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setAnnotations
Optional. Metadata defined as annotations on the network endpoint group.
| Parameter | |
|---|---|
| Name | Description |
var | array|Google\Protobuf\Internal\MapField |
| Returns | |
|---|---|
| Type | Description |
$this | |
getAppEngine
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
| Returns | |
|---|---|
| Type | Description |
NetworkEndpointGroupAppEngine|null | |
hasAppEngine
clearAppEngine
setAppEngine
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
| Parameter | |
|---|---|
| Name | Description |
var | NetworkEndpointGroupAppEngine |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCloudFunction
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
| Returns | |
|---|---|
| Type | Description |
NetworkEndpointGroupCloudFunction|null | |
hasCloudFunction
clearCloudFunction
setCloudFunction
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
| Parameter | |
|---|---|
| Name | Description |
var | NetworkEndpointGroupCloudFunction |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCloudRun
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
| Returns | |
|---|---|
| Type | Description |
NetworkEndpointGroupCloudRun|null | |
hasCloudRun
clearCloudRun
setCloudRun
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
| Parameter | |
|---|---|
| Name | Description |
var | 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. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.
| Returns | |
|---|---|
| Type | Description |
int | |
hasDefaultPort
clearDefaultPort
setDefaultPort
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.
| 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, GCE_VM_IP_PORTMAP.
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, GCE_VM_IP_PORTMAP.
Check the NetworkEndpointType enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPscData
Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.
| Returns | |
|---|---|
| Type | Description |
NetworkEndpointGroupPscData|null | |
hasPscData
clearPscData
setPscData
Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.
| Parameter | |
|---|---|
| Name | Description |
var | 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. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.
| 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. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.
| 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 | |