- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public final class NetworkEndpointGroup extends GeneratedMessageV3 implements NetworkEndpointGroupOrBuilder
Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless NEGs.
Protobuf type google.cloud.compute.v1.NetworkEndpointGroup
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NetworkEndpointGroupImplements
NetworkEndpointGroupOrBuilderStatic Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
Type | Description |
int |
APP_ENGINE_FIELD_NUMBER
public static final int APP_ENGINE_FIELD_NUMBER
Type | Description |
int |
CLOUD_FUNCTION_FIELD_NUMBER
public static final int CLOUD_FUNCTION_FIELD_NUMBER
Type | Description |
int |
CLOUD_RUN_FIELD_NUMBER
public static final int CLOUD_RUN_FIELD_NUMBER
Type | Description |
int |
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Type | Description |
int |
DEFAULT_PORT_FIELD_NUMBER
public static final int DEFAULT_PORT_FIELD_NUMBER
Type | Description |
int |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Type | Description |
int |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Type | Description |
int |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Type | Description |
int |
NETWORK_ENDPOINT_TYPE_FIELD_NUMBER
public static final int NETWORK_ENDPOINT_TYPE_FIELD_NUMBER
Type | Description |
int |
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
Type | Description |
int |
PSC_TARGET_SERVICE_FIELD_NUMBER
public static final int PSC_TARGET_SERVICE_FIELD_NUMBER
Type | Description |
int |
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
Type | Description |
int |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
Type | Description |
int |
SIZE_FIELD_NUMBER
public static final int SIZE_FIELD_NUMBER
Type | Description |
int |
SUBNETWORK_FIELD_NUMBER
public static final int SUBNETWORK_FIELD_NUMBER
Type | Description |
int |
ZONE_FIELD_NUMBER
public static final int ZONE_FIELD_NUMBER
Type | Description |
int |
Static Methods
getDefaultInstance()
public static NetworkEndpointGroup getDefaultInstance()
Type | Description |
NetworkEndpointGroup |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
newBuilder()
public static NetworkEndpointGroup.Builder newBuilder()
Type | Description |
NetworkEndpointGroup.Builder |
newBuilder(NetworkEndpointGroup prototype)
public static NetworkEndpointGroup.Builder newBuilder(NetworkEndpointGroup prototype)
Name | Description |
prototype | NetworkEndpointGroup |
Type | Description |
NetworkEndpointGroup.Builder |
parseDelimitedFrom(InputStream input)
public static NetworkEndpointGroup parseDelimitedFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
NetworkEndpointGroup |
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NetworkEndpointGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NetworkEndpointGroup |
Type | Description |
IOException |
parseFrom(byte[] data)
public static NetworkEndpointGroup parseFrom(byte[] data)
Name | Description |
data | byte[] |
Type | Description |
NetworkEndpointGroup |
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NetworkEndpointGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NetworkEndpointGroup |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static NetworkEndpointGroup parseFrom(ByteString data)
Name | Description |
data | ByteString |
Type | Description |
NetworkEndpointGroup |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NetworkEndpointGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NetworkEndpointGroup |
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static NetworkEndpointGroup parseFrom(CodedInputStream input)
Name | Description |
input | CodedInputStream |
Type | Description |
NetworkEndpointGroup |
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NetworkEndpointGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NetworkEndpointGroup |
Type | Description |
IOException |
parseFrom(InputStream input)
public static NetworkEndpointGroup parseFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
NetworkEndpointGroup |
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NetworkEndpointGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NetworkEndpointGroup |
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static NetworkEndpointGroup parseFrom(ByteBuffer data)
Name | Description |
data | ByteBuffer |
Type | Description |
NetworkEndpointGroup |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NetworkEndpointGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NetworkEndpointGroup |
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<NetworkEndpointGroup> parser()
Type | Description |
Parser<NetworkEndpointGroup> |
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)
Metadata defined as annotations on the network endpoint group.
map<string, string> annotations = 112032548;
Name | Description |
key | String |
Type | Description |
boolean |
equals(Object obj)
public boolean equals(Object obj)
Name | Description |
obj | Object |
Type | Description |
boolean |
getAnnotations()
public Map<String,String> getAnnotations()
Use #getAnnotationsMap() instead.
Type | Description |
Map<String,String> |
getAnnotationsCount()
public int getAnnotationsCount()
Metadata defined as annotations on the network endpoint group.
map<string, string> annotations = 112032548;
Type | Description |
int |
getAnnotationsMap()
public Map<String,String> getAnnotationsMap()
Metadata defined as annotations on the network endpoint group.
map<string, string> annotations = 112032548;
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 group.
map<string, string> annotations = 112032548;
Name | Description |
key | String |
defaultValue | String |
Type | Description |
String |
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
Metadata defined as annotations on the network endpoint group.
map<string, string> annotations = 112032548;
Name | Description |
key | String |
Type | Description |
String |
getAppEngine()
public NetworkEndpointGroupAppEngine getAppEngine()
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
optional .google.cloud.compute.v1.NetworkEndpointGroupAppEngine app_engine = 340788768;
Type | Description |
NetworkEndpointGroupAppEngine | The appEngine. |
getAppEngineOrBuilder()
public NetworkEndpointGroupAppEngineOrBuilder getAppEngineOrBuilder()
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
optional .google.cloud.compute.v1.NetworkEndpointGroupAppEngine app_engine = 340788768;
Type | Description |
NetworkEndpointGroupAppEngineOrBuilder |
getCloudFunction()
public NetworkEndpointGroupCloudFunction getCloudFunction()
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
optional .google.cloud.compute.v1.NetworkEndpointGroupCloudFunction cloud_function = 519893666;
Type | Description |
NetworkEndpointGroupCloudFunction | The cloudFunction. |
getCloudFunctionOrBuilder()
public NetworkEndpointGroupCloudFunctionOrBuilder getCloudFunctionOrBuilder()
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
optional .google.cloud.compute.v1.NetworkEndpointGroupCloudFunction cloud_function = 519893666;
Type | Description |
NetworkEndpointGroupCloudFunctionOrBuilder |
getCloudRun()
public NetworkEndpointGroupCloudRun getCloudRun()
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
optional .google.cloud.compute.v1.NetworkEndpointGroupCloudRun cloud_run = 111060353;
Type | Description |
NetworkEndpointGroupCloudRun | The cloudRun. |
getCloudRunOrBuilder()
public NetworkEndpointGroupCloudRunOrBuilder getCloudRunOrBuilder()
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
optional .google.cloud.compute.v1.NetworkEndpointGroupCloudRun cloud_run = 111060353;
Type | Description |
NetworkEndpointGroupCloudRunOrBuilder |
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public NetworkEndpointGroup getDefaultInstanceForType()
Type | Description |
NetworkEndpointGroup |
getDefaultPort()
public int getDefaultPort()
The default port used if the port number is not specified in the network endpoint.
optional int32 default_port = 423377855;
Type | Description |
int | The defaultPort. |
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Type | Description |
String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Type | Description |
ByteString | The bytes for description. |
getId()
public long getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Type | Description |
long | The id. |
getKind()
public String getKind()
[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
optional string kind = 3292052;
Type | Description |
String | The kind. |
getKindBytes()
public ByteString getKindBytes()
[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
optional string kind = 3292052;
Type | Description |
ByteString | The bytes for kind. |
getName()
public String getName()
Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()
Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Type | Description |
ByteString | The bytes for name. |
getNetwork()
public String getNetwork()
The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
optional string network = 232872494;
Type | Description |
String | The network. |
getNetworkBytes()
public ByteString getNetworkBytes()
The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
optional string network = 232872494;
Type | Description |
ByteString | The bytes for network. |
getNetworkEndpointType()
public String getNetworkEndpointType()
Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. Check the NetworkEndpointType enum for the list of possible values.
optional string network_endpoint_type = 118301523;
Type | Description |
String | The networkEndpointType. |
getNetworkEndpointTypeBytes()
public ByteString getNetworkEndpointTypeBytes()
Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. Check the NetworkEndpointType enum for the list of possible values.
optional string network_endpoint_type = 118301523;
Type | Description |
ByteString | The bytes for networkEndpointType. |
getParserForType()
public Parser<NetworkEndpointGroup> getParserForType()
Type | Description |
Parser<NetworkEndpointGroup> |
getPscTargetService()
public String getPscTargetService()
The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com"
optional string psc_target_service = 269132134;
Type | Description |
String | The pscTargetService. |
getPscTargetServiceBytes()
public ByteString getPscTargetServiceBytes()
The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com"
optional string psc_target_service = 269132134;
Type | Description |
ByteString | The bytes for pscTargetService. |
getRegion()
public String getRegion()
[Output Only] The URL of the region where the network endpoint group is located.
optional string region = 138946292;
Type | Description |
String | The region. |
getRegionBytes()
public ByteString getRegionBytes()
[Output Only] The URL of the region where the network endpoint group is located.
optional string region = 138946292;
Type | Description |
ByteString | The bytes for region. |
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
ByteString | The bytes for selfLink. |
getSerializedSize()
public int getSerializedSize()
Type | Description |
int |
getSize()
public int getSize()
[Output only] Number of network endpoints in the network endpoint group.
optional int32 size = 3530753;
Type | Description |
int | The size. |
getSubnetwork()
public String getSubnetwork()
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
optional string subnetwork = 307827694;
Type | Description |
String | The subnetwork. |
getSubnetworkBytes()
public ByteString getSubnetworkBytes()
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
optional string subnetwork = 307827694;
Type | Description |
ByteString | The bytes for subnetwork. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Type | Description |
UnknownFieldSet |
getZone()
public String getZone()
[Output Only] The URL of the zone where the network endpoint group is located.
optional string zone = 3744684;
Type | Description |
String | The zone. |
getZoneBytes()
public ByteString getZoneBytes()
[Output Only] The URL of the zone where the network endpoint group is located.
optional string zone = 3744684;
Type | Description |
ByteString | The bytes for zone. |
hasAppEngine()
public boolean hasAppEngine()
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
optional .google.cloud.compute.v1.NetworkEndpointGroupAppEngine app_engine = 340788768;
Type | Description |
boolean | Whether the appEngine field is set. |
hasCloudFunction()
public boolean hasCloudFunction()
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
optional .google.cloud.compute.v1.NetworkEndpointGroupCloudFunction cloud_function = 519893666;
Type | Description |
boolean | Whether the cloudFunction field is set. |
hasCloudRun()
public boolean hasCloudRun()
Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
optional .google.cloud.compute.v1.NetworkEndpointGroupCloudRun cloud_run = 111060353;
Type | Description |
boolean | Whether the cloudRun field is set. |
hasCreationTimestamp()
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
boolean | Whether the creationTimestamp field is set. |
hasDefaultPort()
public boolean hasDefaultPort()
The default port used if the port number is not specified in the network endpoint.
optional int32 default_port = 423377855;
Type | Description |
boolean | Whether the defaultPort field is set. |
hasDescription()
public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Type | Description |
boolean | Whether the description field is set. |
hasId()
public boolean hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Type | Description |
boolean | Whether the id field is set. |
hasKind()
public boolean hasKind()
[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
optional string kind = 3292052;
Type | Description |
boolean | Whether the kind field is set. |
hasName()
public boolean hasName()
Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Type | Description |
boolean | Whether the name field is set. |
hasNetwork()
public boolean hasNetwork()
The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
optional string network = 232872494;
Type | Description |
boolean | Whether the network field is set. |
hasNetworkEndpointType()
public boolean hasNetworkEndpointType()
Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. Check the NetworkEndpointType enum for the list of possible values.
optional string network_endpoint_type = 118301523;
Type | Description |
boolean | Whether the networkEndpointType field is set. |
hasPscTargetService()
public boolean hasPscTargetService()
The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com"
optional string psc_target_service = 269132134;
Type | Description |
boolean | Whether the pscTargetService field is set. |
hasRegion()
public boolean hasRegion()
[Output Only] The URL of the region where the network endpoint group is located.
optional string region = 138946292;
Type | Description |
boolean | Whether the region field is set. |
hasSelfLink()
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
boolean | Whether the selfLink field is set. |
hasSize()
public boolean hasSize()
[Output only] Number of network endpoints in the network endpoint group.
optional int32 size = 3530753;
Type | Description |
boolean | Whether the size field is set. |
hasSubnetwork()
public boolean hasSubnetwork()
Optional URL of the subnetwork to which all network endpoints in the NEG belong.
optional string subnetwork = 307827694;
Type | Description |
boolean | Whether the subnetwork field is set. |
hasZone()
public boolean hasZone()
[Output Only] The URL of the zone where the network endpoint group is located.
optional string zone = 3744684;
Type | Description |
boolean | Whether the zone field is set. |
hashCode()
public int hashCode()
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
newBuilderForType()
public NetworkEndpointGroup.Builder newBuilderForType()
Type | Description |
NetworkEndpointGroup.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NetworkEndpointGroup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Name | Description |
parent | BuilderParent |
Type | Description |
NetworkEndpointGroup.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Name | Description |
unused | UnusedPrivateParameter |
Type | Description |
Object |
toBuilder()
public NetworkEndpointGroup.Builder toBuilder()
Type | Description |
NetworkEndpointGroup.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Name | Description |
output | CodedOutputStream |
Type | Description |
IOException |