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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/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, 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. (== resource_for $api_version. networkEndpointGroups ==) (== resource_for $api_version. globalNetworkEndpointGroups ==) (== resource_for $api_version. regionNetworkEndpointGroups ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NetworkEndpointGroup

Returns a new instance of NetworkEndpointGroup.



21319
21320
21321
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21319

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


21195
21196
21197
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21195

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:



21205
21206
21207
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21205

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:



21213
21214
21215
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21213

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:



21222
21223
21224
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21222

def cloud_run
  @cloud_run
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


21227
21228
21229
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21227

def creation_timestamp
  @creation_timestamp
end

#default_port ⇒ Fixnum

The default port used if the port number is not specified in the network endpoint. Corresponds to the JSON property defaultPort

Returns:

  • (Fixnum) 


21233
21234
21235
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21233

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) 


21239
21240
21241
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21239

def description
  @description
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


21245
21246
21247
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21245

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


21251
21252
21253
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21251

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:



21256
21257
21258
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21256

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 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. Corresponds to the JSON property name

Returns:

  • (String) 


21266
21267
21268
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21266

def name
  @name
end

#network ⇒ String

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

Returns:

  • (String) 


21272
21273
21274
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21272

def network
  @network
end

#network_endpoint_type ⇒ String

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

Returns:

  • (String) 


21279
21280
21281
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21279

def network_endpoint_type
  @network_endpoint_type
end

#region ⇒ String

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

Returns:

  • (String) 


21285
21286
21287
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21285

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


21290
21291
21292
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21290

def self_link
  @self_link
end

#self_link_with_id ⇒ String

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

Returns:

  • (String) 


21295
21296
21297
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21295

def self_link_with_id
  @self_link_with_id
end

#size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


21300
21301
21302
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21300

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) 


21306
21307
21308
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21306

def subnetwork
  @subnetwork
end

#type ⇒ String

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

Returns:

  • (String) 


21312
21313
21314
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21312

def type
  @type
end

#zone ⇒ String

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

Returns:

  • (String) 


21317
21318
21319
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21317

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21324
21325
21326
21327
21328
21329
21330
21331
21332
21333
21334
21335
21336
21337
21338
21339
21340
21341
21342
21343
21344
21345
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 21324

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)
  @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)
  @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