com.google.api.services.compute.model

Class NetworkEndpoint

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.NetworkEndpoint

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class NetworkEndpoint
extends com.google.api.client.json.GenericJson

The network endpoint.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
NetworkEndpoint()

Method Summary

Modifier and Type	Method and Description
NetworkEndpoint	clone()
Map<String,String>	getAnnotations() Metadata defined as annotations on the network endpoint.
String	getFqdn() Optional fully qualified domain name of network endpoint.
String	getInstance() The name or a URL of VM instance of this network endpoint.
String	getIpAddress() Optional IPv4 address of network endpoint.
Integer	getPort() Optional port number of network endpoint.
NetworkEndpoint	set(String fieldName, Object value)
NetworkEndpoint	setAnnotations(Map<String,String> annotations) Metadata defined as annotations on the network endpoint.
NetworkEndpoint	setFqdn(String fqdn) Optional fully qualified domain name of network endpoint.
NetworkEndpoint	setInstance(String instance) The name or a URL of VM instance of this network endpoint.
NetworkEndpoint	setIpAddress(String ipAddress) Optional IPv4 address of network endpoint.
NetworkEndpoint	setPort(Integer port) Optional port number of network endpoint.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

NetworkEndpoint

public NetworkEndpoint()

Method Detail

getAnnotations

public Map<String,String> getAnnotations()

Metadata defined as annotations on the network endpoint.

Returns:

value or null for none

setAnnotations

public NetworkEndpoint setAnnotations(Map<String,String> annotations)

Metadata defined as annotations on the network endpoint.

Parameters:

annotations - annotations or null for none

getFqdn

public String 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:

value or null for none

setFqdn

public NetworkEndpoint setFqdn(String fqdn)

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

Parameters:

fqdn - fqdn or null for none

getInstance

public String getInstance()

The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.

Returns:

value or null for none

setInstance

public NetworkEndpoint setInstance(String instance)

The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.

Parameters:

instance - instance or null for none

getIpAddress

public String 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. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.

Returns:

value or null for none

setIpAddress

public NetworkEndpoint setIpAddress(String ipAddress)

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. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.

Parameters:

ipAddress - ipAddress or null for none

getPort

public Integer getPort()

Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP.

Returns:

value or null for none

setPort

public NetworkEndpoint setPort(Integer port)

Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP.

Parameters:

port - port or null for none

set

public NetworkEndpoint set(String fieldName,
                           Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public NetworkEndpoint clone()

Overrides:

clone in class com.google.api.client.json.GenericJson