Class: Google::Apis::ComputeV1::NetworkEndpointGroup

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NetworkEndpointGroup

Returns a new instance of NetworkEndpointGroup.



18451
18452
18453
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18451

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


18346
18347
18348
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18346

def annotations
  @annotations
end

#app_engine ⇒ Google::Apis::ComputeV1::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:



18355
18356
18357
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18355

def app_engine
  @app_engine
end

#cloud_function ⇒ Google::Apis::ComputeV1::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:



18362
18363
18364
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18362

def cloud_function
  @cloud_function
end

#cloud_run ⇒ Google::Apis::ComputeV1::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:



18370
18371
18372
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18370

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) 


18375
18376
18377
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18375

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) 


18381
18382
18383
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18381

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) 


18387
18388
18389
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18387

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) 


18393
18394
18395
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18393

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) 


18399
18400
18401
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18399

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


18409
18410
18411
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18409

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) 


18415
18416
18417
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18415

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, SERVERLESS, PRIVATE_SERVICE_CONNECT. Corresponds to the JSON property networkEndpointType

Returns:

  • (String) 


18422
18423
18424
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18422

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) 


18428
18429
18430
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18428

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


18433
18434
18435
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18433

def self_link
  @self_link
end

#size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


18438
18439
18440
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18438

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) 


18444
18445
18446
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18444

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


18449
18450
18451
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18449

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18456
18457
18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
18473
18474
 
# File 'lib/google/apis/compute_v1/classes.rb', line 18456

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)
  @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)
  @size = args[:size] if args.key?(:size)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @zone = args[:zone] if args.key?(:zone)
end