Class: Google::Apis::ComputeAlpha::NetworkEndpointGroup

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb

Overview

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 for different use cases, seeNetwork endpoint groups overview. Note: Use the following APIs to manage network endpoint groups:

- To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity NEGs): zonal

API

To manage NEGs with regional scope (such as regional internet NEGs, serverless NEGs, Private Service Connect NEGs): regional

API

To manage NEGs with global scope (such as global internet NEGs):global API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NetworkEndpointGroup

Returns a new instance of NetworkEndpointGroup.



45044
45045
45046
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 45044

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Optional. Metadata defined as annotations on the network endpoint group. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


44882
44883
44884
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44882

def annotations
  @annotations
end

#app_engine ⇒ Google::Apis::ComputeAlpha::NetworkEndpointGroupAppEngine

Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. Corresponds to the JSON property appEngine

Returns:



44892
44893
44894
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44892

def app_engine
  @app_engine
end

#cloud_function ⇒ Google::Apis::ComputeAlpha::NetworkEndpointGroupCloudFunction

Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. Corresponds to the JSON property cloudFunction

Returns:



44900
44901
44902
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44900

def cloud_function
  @cloud_function
end

#cloud_run ⇒ Google::Apis::ComputeAlpha::NetworkEndpointGroupCloudRun

Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. Corresponds to the JSON property cloudRun

Returns:



44910
44911
44912
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44910

def cloud_run
  @cloud_run
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


44916
44917
44918
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44916

def creation_timestamp
  @creation_timestamp
end

#default_port ⇒ Fixnum

The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. Corresponds to the JSON property defaultPort

Returns:

  • (Fixnum) 


44925
44926
44927
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44925

def default_port
  @default_port
end

#description ⇒ String

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

Returns:

  • (String) 


44931
44932
44933
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44931

def description
  @description
end

#id ⇒ Fixnum

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


44938
44939
44940
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44938

def id
  @id
end

#kind ⇒ String

Output only. [Output Only] Type of the resource. Alwayscompute# networkEndpointGroup for network endpoint group. Corresponds to the JSON property kind

Returns:

  • (String) 


44944
44945
44946
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44944

def kind
  @kind
end

#load_balancer ⇒ Google::Apis::ComputeAlpha::NetworkEndpointGroupLbNetworkEndpointGroup

Load balancing specific fields for network endpoint group. Corresponds to the JSON property loadBalancer

Returns:



44949
44950
44951
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44949

def load_balancer
  @load_balancer
end

#name ⇒ String

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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. Corresponds to the JSON property name

Returns:

  • (String) 


44960
44961
44962
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44960

def name
  @name
end

#network ⇒ String

The URL of the network to which all network endpoints in the NEG belong. For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT, if this field is not specified, a default network will be used. This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for global NEGs. For all other network endpoint types, this field is required. Corresponds to the JSON property network

Returns:

  • (String) 


44972
44973
44974
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44972

def network
  @network
end

#network_endpoint_type ⇒ String

Type of network endpoints in this network endpoint group. Can be one ofGCE_VM_IP, GCE_VM_IP_PORT,NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS,PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. Corresponds to the JSON property networkEndpointType

Returns:

  • (String) 


44979
44980
44981
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44979

def network_endpoint_type
  @network_endpoint_type
end

#psc_data ⇒ Google::Apis::ComputeAlpha::NetworkEndpointGroupPscData

All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. Corresponds to the JSON property pscData

Returns:



44985
44986
44987
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44985

def psc_data
  @psc_data
end

#psc_target_service ⇒ String

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. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. Corresponds to the JSON property pscTargetService

Returns:

  • (String) 


44993
44994
44995
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44993

def psc_target_service
  @psc_target_service
end

#region ⇒ String

Output only. [Output Only] The URL of theregion where the network endpoint group is located. Corresponds to the JSON property region

Returns:

  • (String) 


44999
45000
45001
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 44999

def region
  @region
end

#self_link ⇒ String

Output only. [Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


45004
45005
45006
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 45004

def self_link
  @self_link
end

#self_link_with_id ⇒ String

Output only. [Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


45010
45011
45012
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 45010

def self_link_with_id
  @self_link_with_id
end

#serverless_deployment ⇒ Google::Apis::ComputeAlpha::NetworkEndpointGroupServerlessDeployment

Configuration for a serverless network endpoint group (NEG). Theplatform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG. Corresponds to the JSON property serverlessDeployment

Returns:



45018
45019
45020
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 45018

def serverless_deployment
  @serverless_deployment
end

#size ⇒ Fixnum

Output only. [Output only] Number of network endpoints in the network endpoint group. Corresponds to the JSON property size

Returns:

  • (Fixnum) 


45024
45025
45026
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 45024

def size
  @size
end

#subnetwork ⇒ String

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

Returns:

  • (String) 


45030
45031
45032
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 45030

def subnetwork
  @subnetwork
end

#type ⇒ String

Specify the type of this network endpoint group. OnlyLOAD_BALANCING is valid for now. Corresponds to the JSON property type

Returns:

  • (String) 


45036
45037
45038
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 45036

def type
  @type
end

#zone ⇒ String

Output only. [Output Only] The URL of thezone where the network endpoint group is located. Corresponds to the JSON property zone

Returns:

  • (String) 


45042
45043
45044
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 45042

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



45049
45050
45051
45052
45053
45054
45055
45056
45057
45058
45059
45060
45061
45062
45063
45064
45065
45066
45067
45068
45069
45070
45071
45072
45073
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 45049

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @app_engine = args[:app_engine] if args.key?(:app_engine)
  @cloud_function = args[:cloud_function] if args.key?(:cloud_function)
  @cloud_run = args[:cloud_run] if args.key?(:cloud_run)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @default_port = args[:default_port] if args.key?(:default_port)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @load_balancer = args[:load_balancer] if args.key?(:load_balancer)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @network_endpoint_type = args[:network_endpoint_type] if args.key?(:network_endpoint_type)
  @psc_data = args[:psc_data] if args.key?(:psc_data)
  @psc_target_service = args[:psc_target_service] if args.key?(:psc_target_service)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @serverless_deployment = args[:serverless_deployment] if args.key?(:serverless_deployment)
  @size = args[:size] if args.key?(:size)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @type = args[:type] if args.key?(:type)
  @zone = args[:zone] if args.key?(:zone)
end