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.
data
array
Optional. Data for populating the Message object.
↳ annotations
array| Google\Protobuf\Internal\MapField
Optional. Metadata defined as annotations on the network endpoint group.
↳ app_engine
NetworkEndpointGroupAppEngine
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
↳ cloud_function
NetworkEndpointGroupCloudFunction
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
↳ cloud_run
NetworkEndpointGroupCloudRun
Optional. 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. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.
↳ 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, GCE_VM_IP_PORTMAP. Check the NetworkEndpointType enum for the list of possible values.
↳ psc_data
NetworkEndpointGroupPscData
Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.
↳ 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. 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
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
Optional. Metadata defined as annotations on the network endpoint group.
setAnnotations
Optional. Metadata defined as annotations on the network endpoint group.
$this
getAppEngine
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
hasAppEngine
clearAppEngine
setAppEngine
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
$this
getCloudFunction
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
hasCloudFunction
clearCloudFunction
setCloudFunction
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
$this
getCloudRun
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
hasCloudRun
clearCloudRun
setCloudRun
Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
var
string
$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.
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.
var
int
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
var
string
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
var
int|string
$this
getKind
[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
string
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
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.
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.
var
string
$this
getNetwork
The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified.
string
hasNetwork
clearNetwork
setNetwork
The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified.
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, GCE_VM_IP_PORTMAP.
Check the NetworkEndpointType enum for the list of possible values.
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.
var
string
$this
getPscData
Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.
hasPscData
clearPscData
setPscData
Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.
$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.
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.
var
string
$this
getRegion
[Output Only] The URL of the region where the network endpoint group is located.
string
hasRegion
clearRegion
setRegion
[Output Only] The URL of the region where the network endpoint group is located.
var
string
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
var
string
$this
getSize
[Output only] Number of network endpoints in the network endpoint group.
int
hasSize
clearSize
setSize
[Output only] Number of network endpoints in the network endpoint group.
var
int
$this
getSubnetwork
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
string
hasSubnetwork
clearSubnetwork
setSubnetwork
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
var
string
$this
getZone
[Output Only] The URL of the zone where the network endpoint group is located.
string
hasZone
clearZone
setZone
[Output Only] The URL of the zone where the network endpoint group is located.
var
string
$this
