Compute V1 Client - Class NetworkEndpoint (1.8.3)

Reference documentation and code samples for the Compute V1 Client class NetworkEndpoint.

The network endpoint.

Generated from protobuf message google.cloud.compute.v1.NetworkEndpoint

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ annotations array|Google\Protobuf\Internal\MapField

Metadata defined as annotations on the network endpoint.

↳ fqdn string

Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.

↳ instance string

The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035.

↳ ip_address string

Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.

↳ port int

Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.

getAnnotations

Metadata defined as annotations on the network endpoint.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setAnnotations

Metadata defined as annotations on the network endpoint.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getFqdn

Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.

Returns
TypeDescription
string

hasFqdn

clearFqdn

setFqdn

Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInstance

The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035.

Returns
TypeDescription
string

hasInstance

clearInstance

setInstance

The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIpAddress

Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.

Returns
TypeDescription
string

hasIpAddress

clearIpAddress

setIpAddress

Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPort

Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.

Returns
TypeDescription
int

hasPort

clearPort

setPort

Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.

Parameter
NameDescription
var int
Returns
TypeDescription
$this