Compute V1 Client - Class NetworkEndpointGroup (1.18.0)

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 \ V1

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. 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`	`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`