Class NetworkEndpoint (1.21.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
TypeDescription
int

FQDN_FIELD_NUMBER

public static final int FQDN_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
TypeDescription
int

IP_ADDRESS_FIELD_NUMBER

public static final int IP_ADDRESS_FIELD_NUMBER
Field Value
TypeDescription
int

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static NetworkEndpoint getDefaultInstance()
Returns
TypeDescription
NetworkEndpoint

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static NetworkEndpoint.Builder newBuilder()
Returns
TypeDescription
NetworkEndpoint.Builder

newBuilder(NetworkEndpoint prototype)

public static NetworkEndpoint.Builder newBuilder(NetworkEndpoint prototype)
Parameter
NameDescription
prototypeNetworkEndpoint
Returns
TypeDescription
NetworkEndpoint.Builder

parseDelimitedFrom(InputStream input)

public static NetworkEndpoint parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static NetworkEndpoint parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static NetworkEndpoint parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static NetworkEndpoint parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static NetworkEndpoint parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static NetworkEndpoint parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static NetworkEndpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NetworkEndpoint
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<NetworkEndpoint> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Metadata defined as annotations on the network endpoint.

map<string, string> annotations = 112032548;

Returns
TypeDescription
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Metadata defined as annotations on the network endpoint.

map<string, string> annotations = 112032548;

Returns
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Metadata defined as annotations on the network endpoint.

map<string, string> annotations = 112032548;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getDefaultInstanceForType()

public NetworkEndpoint getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for fqdn.

getInstance()

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

optional string instance = 18257045;

Returns
TypeDescription
String

The instance.

getInstanceBytes()

public ByteString getInstanceBytes()

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.

optional string instance = 18257045;

Returns
TypeDescription
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.

optional string ip_address = 406272220;

Returns
TypeDescription
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.

optional string ip_address = 406272220;

Returns
TypeDescription
ByteString

The bytes for ipAddress.

getParserForType()

public Parser<NetworkEndpoint> getParserForType()
Returns
TypeDescription
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.

optional int32 port = 3446913;

Returns
TypeDescription
int

The port.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
boolean

Whether the fqdn field is set.

hasInstance()

public boolean hasInstance()

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.

optional string instance = 18257045;

Returns
TypeDescription
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.

optional string ip_address = 406272220;

Returns
TypeDescription
boolean

Whether the ipAddress 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.

optional int32 port = 3446913;

Returns
TypeDescription
boolean

Whether the port field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public NetworkEndpoint.Builder newBuilderForType()
Returns
TypeDescription
NetworkEndpoint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NetworkEndpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
NetworkEndpoint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public NetworkEndpoint.Builder toBuilder()
Returns
TypeDescription
NetworkEndpoint.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException