com.google.api.services.compute.model

Class NetworkEndpointGroup

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.NetworkEndpointGroup

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class NetworkEndpointGroup
extends GenericJson

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.

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

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
NetworkEndpointGroup()

Method Summary

Modifier and Type	Method and Description
NetworkEndpointGroup	clone()
Map<String,String>	getAnnotations() Metadata defined as annotations on the network endpoint group.
NetworkEndpointGroupAppEngine	getAppEngine() Only valid when networkEndpointType is "SERVERLESS".
NetworkEndpointGroupCloudFunction	getCloudFunction() Only valid when networkEndpointType is "SERVERLESS".
NetworkEndpointGroupCloudRun	getCloudRun() Only valid when networkEndpointType is "SERVERLESS".
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
Integer	getDefaultPort() The default port used if the port number is not specified in the network endpoint.
String	getDescription() An optional description of this resource.
BigInteger	getId() [Output Only] The unique identifier for the resource.
String	getKind() [Output Only] Type of the resource.
NetworkEndpointGroupLbNetworkEndpointGroup	getLoadBalancer() This field is only valid when the network endpoint group is used for load balancing.
String	getName() Name of the resource; provided by the client when the resource is created.
String	getNetwork() The URL of the network to which all network endpoints in the NEG belong.
String	getNetworkEndpointType() Type of network endpoints in this network endpoint group.
String	getPscTargetService() The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment.
String	getRegion() [Output Only] The URL of the region where the network endpoint group is located.
String	getSelfLink() [Output Only] Server-defined URL for the resource.
NetworkEndpointGroupServerlessDeployment	getServerlessDeployment() Only valid when networkEndpointType is "SERVERLESS".
Integer	getSize() [Output only] Number of network endpoints in the network endpoint group.
String	getSubnetwork() Optional URL of the subnetwork to which all network endpoints in the NEG belong.
String	getZone() [Output Only] The URL of the zone where the network endpoint group is located.
NetworkEndpointGroup	set(String fieldName, Object value)
NetworkEndpointGroup	setAnnotations(Map<String,String> annotations) Metadata defined as annotations on the network endpoint group.
NetworkEndpointGroup	setAppEngine(NetworkEndpointGroupAppEngine appEngine) Only valid when networkEndpointType is "SERVERLESS".
NetworkEndpointGroup	setCloudFunction(NetworkEndpointGroupCloudFunction cloudFunction) Only valid when networkEndpointType is "SERVERLESS".
NetworkEndpointGroup	setCloudRun(NetworkEndpointGroupCloudRun cloudRun) Only valid when networkEndpointType is "SERVERLESS".
NetworkEndpointGroup	setCreationTimestamp(String creationTimestamp) [Output Only] Creation timestamp in RFC3339 text format.
NetworkEndpointGroup	setDefaultPort(Integer defaultPort) The default port used if the port number is not specified in the network endpoint.
NetworkEndpointGroup	setDescription(String description) An optional description of this resource.
NetworkEndpointGroup	setId(BigInteger id) [Output Only] The unique identifier for the resource.
NetworkEndpointGroup	setKind(String kind) [Output Only] Type of the resource.
NetworkEndpointGroup	setLoadBalancer(NetworkEndpointGroupLbNetworkEndpointGroup loadBalancer) This field is only valid when the network endpoint group is used for load balancing.
NetworkEndpointGroup	setName(String name) Name of the resource; provided by the client when the resource is created.
NetworkEndpointGroup	setNetwork(String network) The URL of the network to which all network endpoints in the NEG belong.
NetworkEndpointGroup	setNetworkEndpointType(String networkEndpointType) Type of network endpoints in this network endpoint group.
NetworkEndpointGroup	setPscTargetService(String pscTargetService) The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment.
NetworkEndpointGroup	setRegion(String region) [Output Only] The URL of the region where the network endpoint group is located.
NetworkEndpointGroup	setSelfLink(String selfLink) [Output Only] Server-defined URL for the resource.
NetworkEndpointGroup	setServerlessDeployment(NetworkEndpointGroupServerlessDeployment serverlessDeployment) Only valid when networkEndpointType is "SERVERLESS".
NetworkEndpointGroup	setSize(Integer size) [Output only] Number of network endpoints in the network endpoint group.
NetworkEndpointGroup	setSubnetwork(String subnetwork) Optional URL of the subnetwork to which all network endpoints in the NEG belong.
NetworkEndpointGroup	setZone(String zone) [Output Only] The URL of the zone where the network endpoint group is located.

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

NetworkEndpointGroup

public NetworkEndpointGroup()

Method Detail

getAnnotations

public Map<String,String> getAnnotations()

Metadata defined as annotations on the network endpoint group.

Returns:

value or null for none

setAnnotations

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

Metadata defined as annotations on the network endpoint group.

Parameters:

annotations - annotations or null for none

getAppEngine

public NetworkEndpointGroupAppEngine getAppEngine()

Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

Returns:

value or null for none

setAppEngine

public NetworkEndpointGroup setAppEngine(NetworkEndpointGroupAppEngine appEngine)

Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

Parameters:

appEngine - appEngine or null for none

getCloudFunction

public NetworkEndpointGroupCloudFunction getCloudFunction()

Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

Returns:

value or null for none

setCloudFunction

public NetworkEndpointGroup setCloudFunction(NetworkEndpointGroupCloudFunction cloudFunction)

Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

Parameters:

cloudFunction - cloudFunction or null for none

getCloudRun

public NetworkEndpointGroupCloudRun getCloudRun()

Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

Returns:

value or null for none

setCloudRun

public NetworkEndpointGroup setCloudRun(NetworkEndpointGroupCloudRun cloudRun)

Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

Parameters:

cloudRun - cloudRun or null for none

getCreationTimestamp

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public NetworkEndpointGroup setCreationTimestamp(String creationTimestamp)

[Output Only] Creation timestamp in RFC3339 text format.

Parameters:

creationTimestamp - creationTimestamp or null for none

getDefaultPort

public Integer getDefaultPort()

The default port used if the port number is not specified in the network endpoint.

Returns:

value or null for none

setDefaultPort

public NetworkEndpointGroup setDefaultPort(Integer defaultPort)

The default port used if the port number is not specified in the network endpoint.

Parameters:

defaultPort - defaultPort or null for none

getDescription

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

Returns:

value or null for none

setDescription

public NetworkEndpointGroup setDescription(String description)

An optional description of this resource. Provide this property when you create the resource.

Parameters:

description - description or null for none

getId

public BigInteger getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:

value or null for none

setId

public NetworkEndpointGroup setId(BigInteger id)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters:

id - id or null for none

getKind

public String getKind()

[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.

Returns:

value or null for none

setKind

public NetworkEndpointGroup setKind(String kind)

[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.

Parameters:

kind - kind or null for none

getLoadBalancer

public NetworkEndpointGroupLbNetworkEndpointGroup getLoadBalancer()

This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated.

Returns:

value or null for none

setLoadBalancer

public NetworkEndpointGroup setLoadBalancer(NetworkEndpointGroupLbNetworkEndpointGroup loadBalancer)

This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated.

Parameters:

loadBalancer - loadBalancer or null for none

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]([-a-z0-9]*[a-z0-9])?` 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.

Returns:

value or null for none

setName

public NetworkEndpointGroup setName(String name)

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]([-a-z0-9]*[a-z0-9])?` 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.

Parameters:

name - name or null for none

getNetwork

public String getNetwork()

The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.

Returns:

value or null for none

setNetwork

public NetworkEndpointGroup setNetwork(String network)

The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.

Parameters:

network - network or null for none

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.

Returns:

value or null for none

setNetworkEndpointType

public NetworkEndpointGroup setNetworkEndpointType(String networkEndpointType)

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.

Parameters:

networkEndpointType - networkEndpointType or null for none

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"

Returns:

value or null for none

setPscTargetService

public NetworkEndpointGroup setPscTargetService(String pscTargetService)

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"

Parameters:

pscTargetService - pscTargetService or null for none

getRegion

public String getRegion()

[Output Only] The URL of the region where the network endpoint group is located.

Returns:

value or null for none

setRegion

public NetworkEndpointGroup setRegion(String region)

[Output Only] The URL of the region where the network endpoint group is located.

Parameters:

region - region or null for none

getSelfLink

public String getSelfLink()

[Output Only] Server-defined URL for the resource.

Returns:

value or null for none

setSelfLink

public NetworkEndpointGroup setSelfLink(String selfLink)

[Output Only] Server-defined URL for the resource.

Parameters:

selfLink - selfLink or null for none

getServerlessDeployment

public NetworkEndpointGroupServerlessDeployment getServerlessDeployment()

Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set.

Returns:

value or null for none

setServerlessDeployment

public NetworkEndpointGroup setServerlessDeployment(NetworkEndpointGroupServerlessDeployment serverlessDeployment)

Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set.

Parameters:

serverlessDeployment - serverlessDeployment or null for none

getSize

public Integer getSize()

[Output only] Number of network endpoints in the network endpoint group.

Returns:

value or null for none

setSize

public NetworkEndpointGroup setSize(Integer size)

[Output only] Number of network endpoints in the network endpoint group.

Parameters:

size - size or null for none

getSubnetwork

public String getSubnetwork()

Optional URL of the subnetwork to which all network endpoints in the NEG belong.

Returns:

value or null for none

setSubnetwork

public NetworkEndpointGroup setSubnetwork(String subnetwork)

Optional URL of the subnetwork to which all network endpoints in the NEG belong.

Parameters:

subnetwork - subnetwork or null for none

getZone

public String getZone()

[Output Only] The URL of the zone where the network endpoint group is located.

Returns:

value or null for none

setZone

public NetworkEndpointGroup setZone(String zone)

[Output Only] The URL of the zone where the network endpoint group is located.

Parameters:

zone - zone or null for none

set

public NetworkEndpointGroup set(String fieldName,
                                Object value)

Overrides:

set in class GenericJson

clone

public NetworkEndpointGroup clone()

Overrides:

clone in class GenericJson