Class NetworkEndpoint.Builder (1.52.0)

public static final class NetworkEndpoint.Builder extends GeneratedMessageV3.Builder<NetworkEndpoint.Builder> implements NetworkEndpointOrBuilder

The network endpoint.

Protobuf type google.cloud.compute.v1.NetworkEndpoint

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public NetworkEndpoint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
NetworkEndpoint.Builder
Overrides

build()

public NetworkEndpoint build()
Returns
Type Description
NetworkEndpoint

buildPartial()

public NetworkEndpoint buildPartial()
Returns
Type Description
NetworkEndpoint

clear()

public NetworkEndpoint.Builder clear()
Returns
Type Description
NetworkEndpoint.Builder
Overrides

clearAnnotations()

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

clearField(Descriptors.FieldDescriptor field)

public NetworkEndpoint.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
NetworkEndpoint.Builder
Overrides

clearFqdn()

public NetworkEndpoint.Builder clearFqdn()

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
NetworkEndpoint.Builder

This builder for chaining.

clearInstance()

public NetworkEndpoint.Builder clearInstance()

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
NetworkEndpoint.Builder

This builder for chaining.

clearIpAddress()

public NetworkEndpoint.Builder clearIpAddress()

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
NetworkEndpoint.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public NetworkEndpoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
NetworkEndpoint.Builder
Overrides

clearPort()

public NetworkEndpoint.Builder clearPort()

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
NetworkEndpoint.Builder

This builder for chaining.

clone()

public NetworkEndpoint.Builder clone()
Returns
Type Description
NetworkEndpoint.Builder
Overrides

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

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

getDefaultInstanceForType()

public NetworkEndpoint getDefaultInstanceForType()
Returns
Type Description
NetworkEndpoint

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getMutableAnnotations() (deprecated)

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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.

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.

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(NetworkEndpoint other)

public NetworkEndpoint.Builder mergeFrom(NetworkEndpoint other)
Parameter
Name Description
other NetworkEndpoint
Returns
Type Description
NetworkEndpoint.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public NetworkEndpoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NetworkEndpoint.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public NetworkEndpoint.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
NetworkEndpoint.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NetworkEndpoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
NetworkEndpoint.Builder
Overrides

putAllAnnotations(Map<String,String> values)

public NetworkEndpoint.Builder putAllAnnotations(Map<String,String> values)

Metadata defined as annotations on the network endpoint.

map<string, string> annotations = 112032548;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
NetworkEndpoint.Builder

putAnnotations(String key, String value)

public NetworkEndpoint.Builder putAnnotations(String key, String value)

Metadata defined as annotations on the network endpoint.

map<string, string> annotations = 112032548;

Parameters
Name Description
key String
value String
Returns
Type Description
NetworkEndpoint.Builder

removeAnnotations(String key)

public NetworkEndpoint.Builder removeAnnotations(String key)

Metadata defined as annotations on the network endpoint.

map<string, string> annotations = 112032548;

Parameter
Name Description
key String
Returns
Type Description
NetworkEndpoint.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public NetworkEndpoint.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
NetworkEndpoint.Builder
Overrides

setFqdn(String value)

public NetworkEndpoint.Builder setFqdn(String value)

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;

Parameter
Name Description
value String

The fqdn to set.

Returns
Type Description
NetworkEndpoint.Builder

This builder for chaining.

setFqdnBytes(ByteString value)

public NetworkEndpoint.Builder setFqdnBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for fqdn to set.

Returns
Type Description
NetworkEndpoint.Builder

This builder for chaining.

setInstance(String value)

public NetworkEndpoint.Builder setInstance(String value)

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;

Parameter
Name Description
value String

The instance to set.

Returns
Type Description
NetworkEndpoint.Builder

This builder for chaining.

setInstanceBytes(ByteString value)

public NetworkEndpoint.Builder setInstanceBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for instance to set.

Returns
Type Description
NetworkEndpoint.Builder

This builder for chaining.

setIpAddress(String value)

public NetworkEndpoint.Builder setIpAddress(String value)

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;

Parameter
Name Description
value String

The ipAddress to set.

Returns
Type Description
NetworkEndpoint.Builder

This builder for chaining.

setIpAddressBytes(ByteString value)

public NetworkEndpoint.Builder setIpAddressBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for ipAddress to set.

Returns
Type Description
NetworkEndpoint.Builder

This builder for chaining.

setPort(int value)

public NetworkEndpoint.Builder setPort(int value)

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;

Parameter
Name Description
value int

The port to set.

Returns
Type Description
NetworkEndpoint.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public NetworkEndpoint.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
NetworkEndpoint.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final NetworkEndpoint.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
NetworkEndpoint.Builder
Overrides