Class NetworkEndpoint (1.65.0)

public final class NetworkEndpoint extends GeneratedMessageV3 implements NetworkEndpointOrBuilder

The network endpoint.

Protobuf type google.cloud.compute.v1.NetworkEndpoint

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_DESTINATION_PORT_FIELD_NUMBER

public static final int CLIENT_DESTINATION_PORT_FIELD_NUMBER
Field Value
Type Description
int

FQDN_FIELD_NUMBER

public static final int FQDN_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

IPV6_ADDRESS_FIELD_NUMBER

public static final int IPV6_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int

IP_ADDRESS_FIELD_NUMBER

public static final int IP_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static NetworkEndpoint getDefaultInstance()
Returns
Type Description
NetworkEndpoint

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static NetworkEndpoint.Builder newBuilder()
Returns
Type Description
NetworkEndpoint.Builder

newBuilder(NetworkEndpoint prototype)

public static NetworkEndpoint.Builder newBuilder(NetworkEndpoint prototype)
Parameter
Name Description
prototype NetworkEndpoint
Returns
Type Description
NetworkEndpoint.Builder

parseDelimitedFrom(InputStream input)

public static NetworkEndpoint parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static NetworkEndpoint parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static NetworkEndpoint parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static NetworkEndpoint parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static NetworkEndpoint parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static NetworkEndpoint parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NetworkEndpoint
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<NetworkEndpoint> parser()
Returns
Type Description
Parser<NetworkEndpoint>

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Metadata defined as annotations on the network endpoint.

map<string, string> annotations = 112032548;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Metadata defined as annotations on the network endpoint.

map<string, string> annotations = 112032548;

Returns
Type Description
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Metadata defined as annotations on the network endpoint.

map<string, string> annotations = 112032548;

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Metadata defined as annotations on the network endpoint.

map<string, string> annotations = 112032548;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Metadata defined as annotations on the network endpoint.

map<string, string> annotations = 112032548;

Parameter
Name Description
key String
Returns
Type Description
String

getClientDestinationPort()

public int getClientDestinationPort()

Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.

optional int32 client_destination_port = 123765766;

Returns
Type Description
int

The clientDestinationPort.

getDefaultInstanceForType()

public NetworkEndpoint getDefaultInstanceForType()
Returns
Type Description
NetworkEndpoint

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.

optional string fqdn = 3150485;

Returns
Type Description
String

The fqdn.

getFqdnBytes()

public ByteString getFqdnBytes()

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

optional string fqdn = 3150485;

Returns
Type Description
ByteString

The bytes for fqdn.

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.

optional string instance = 18257045;

Returns
Type Description
String

The instance.

getInstanceBytes()

public ByteString getInstanceBytes()

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.

optional string instance = 18257045;

Returns
Type Description
ByteString

The bytes for instance.

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.

optional string ip_address = 406272220;

Returns
Type Description
String

The ipAddress.

getIpAddressBytes()

public ByteString getIpAddressBytes()

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.

optional string ip_address = 406272220;

Returns
Type Description
ByteString

The bytes for ipAddress.

getIpv6Address()

public String getIpv6Address()

Optional IPv6 address of network endpoint.

optional string ipv6_address = 341563804;

Returns
Type Description
String

The ipv6Address.

getIpv6AddressBytes()

public ByteString getIpv6AddressBytes()

Optional IPv6 address of network endpoint.

optional string ipv6_address = 341563804;

Returns
Type Description
ByteString

The bytes for ipv6Address.

getParserForType()

public Parser<NetworkEndpoint> getParserForType()
Returns
Type Description
Parser<NetworkEndpoint>
Overrides

getPort()

public int 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.

optional int32 port = 3446913;

Returns
Type Description
int

The port.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasClientDestinationPort()

public boolean hasClientDestinationPort()

Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.

optional int32 client_destination_port = 123765766;

Returns
Type Description
boolean

Whether the clientDestinationPort field is set.

hasFqdn()

public boolean hasFqdn()

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

optional string fqdn = 3150485;

Returns
Type Description
boolean

Whether the fqdn field is set.

hasInstance()

public boolean hasInstance()

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.

optional string instance = 18257045;

Returns
Type Description
boolean

Whether the instance field is set.

hasIpAddress()

public boolean hasIpAddress()

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.

optional string ip_address = 406272220;

Returns
Type Description
boolean

Whether the ipAddress field is set.

hasIpv6Address()

public boolean hasIpv6Address()

Optional IPv6 address of network endpoint.

optional string ipv6_address = 341563804;

Returns
Type Description
boolean

Whether the ipv6Address field is set.

hasPort()

public boolean hasPort()

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.

optional int32 port = 3446913;

Returns
Type Description
boolean

Whether the port field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public NetworkEndpoint.Builder newBuilderForType()
Returns
Type Description
NetworkEndpoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NetworkEndpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
NetworkEndpoint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public NetworkEndpoint.Builder toBuilder()
Returns
Type Description
NetworkEndpoint.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException