Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::NetworkEndpointGroup (v1.3.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::NetworkEndpointGroup.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Metadata defined as annotations on the network endpoint group.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Metadata defined as annotations on the network endpoint group.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Metadata defined as annotations on the network endpoint group.

#app_engine

def app_engine() -> ::Google::Cloud::Compute::V1::NetworkEndpointGroupAppEngine
Returns

#app_engine=

def app_engine=(value) -> ::Google::Cloud::Compute::V1::NetworkEndpointGroupAppEngine
Parameter
Returns

#cloud_function

def cloud_function() -> ::Google::Cloud::Compute::V1::NetworkEndpointGroupCloudFunction
Returns

#cloud_function=

def cloud_function=(value) -> ::Google::Cloud::Compute::V1::NetworkEndpointGroupCloudFunction
Parameter
Returns

#cloud_run

def cloud_run() -> ::Google::Cloud::Compute::V1::NetworkEndpointGroupCloudRun
Returns

#cloud_run=

def cloud_run=(value) -> ::Google::Cloud::Compute::V1::NetworkEndpointGroupCloudRun
Parameter
Returns

#creation_timestamp

def creation_timestamp() -> ::String
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Creation timestamp in RFC3339 text format.
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#default_port

def default_port() -> ::Integer
Returns
  • (::Integer) — The default port used if the port number is not specified in the network endpoint.

#default_port=

def default_port=(value) -> ::Integer
Parameter
  • value (::Integer) — The default port used if the port number is not specified in the network endpoint.
Returns
  • (::Integer) — The default port used if the port number is not specified in the network endpoint.

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#id

def id() -> ::Integer
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#kind

def kind() -> ::String
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.

#name

def name() -> ::String
Returns
  • (::String) — 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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
  • (::String) — 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.

#network

def network() -> ::String
Returns
  • (::String) — The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.

#network=

def network=(value) -> ::String
Parameter
  • value (::String) — The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
Returns
  • (::String) — The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.

#network_endpoint_type

def network_endpoint_type() -> ::String
Returns
  • (::String) — 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.

#network_endpoint_type=

def network_endpoint_type=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#psc_target_service

def psc_target_service() -> ::String
Returns
  • (::String) — The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com"

#psc_target_service=

def psc_target_service=(value) -> ::String
Parameter
  • value (::String) — The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com"
Returns
  • (::String) — The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com"

#region

def region() -> ::String
Returns
  • (::String) — [Output Only] The URL of the region where the network endpoint group is located.

#region=

def region=(value) -> ::String
Parameter
  • value (::String) — [Output Only] The URL of the region where the network endpoint group is located.
Returns
  • (::String) — [Output Only] The URL of the region where the network endpoint group is located.

#self_link

def self_link() -> ::String
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Server-defined URL for the resource.
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#size

def size() -> ::Integer
Returns
  • (::Integer) — [Output only] Number of network endpoints in the network endpoint group.

#size=

def size=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output only] Number of network endpoints in the network endpoint group.
Returns
  • (::Integer) — [Output only] Number of network endpoints in the network endpoint group.

#subnetwork

def subnetwork() -> ::String
Returns
  • (::String) — Optional URL of the subnetwork to which all network endpoints in the NEG belong.

#subnetwork=

def subnetwork=(value) -> ::String
Parameter
  • value (::String) — Optional URL of the subnetwork to which all network endpoints in the NEG belong.
Returns
  • (::String) — Optional URL of the subnetwork to which all network endpoints in the NEG belong.

#zone

def zone() -> ::String
Returns
  • (::String) — [Output Only] The URL of the zone where the network endpoint group is located.

#zone=

def zone=(value) -> ::String
Parameter
  • value (::String) — [Output Only] The URL of the zone where the network endpoint group is located.
Returns
  • (::String) — [Output Only] The URL of the zone where the network endpoint group is located.