Class: Google::Apis::ComputeBeta::NetworkEndpointGroup

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



21732
21733
21734
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21732

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


21602
21603
21604
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21602

def annotations
  @annotations
end

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



21611
21612
21613
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21611

def app_engine
  @app_engine
end

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



21618
21619
21620
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21618

def cloud_function
  @cloud_function
end

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



21626
21627
21628
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21626

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) 


21631
21632
21633
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21631

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) 


21637
21638
21639
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21637

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) 


21643
21644
21645
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21643

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) 


21649
21650
21651
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21649

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) 


21655
21656
21657
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21655

def kind
  @kind
end

#load_balancer ⇒ Google::Apis::ComputeBeta::NetworkEndpointGroupLbNetworkEndpointGroup

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

Returns:



21660
21661
21662
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21660

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) 


21670
21671
21672
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21670

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) 


21676
21677
21678
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21676

def network
  @network
end

#network_endpoint_type ⇒ 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. Corresponds to the JSON property networkEndpointType

Returns:

  • (String) 


21683
21684
21685
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21683

def network_endpoint_type
  @network_endpoint_type
end

#psc_data ⇒ Google::Apis::ComputeBeta::NetworkEndpointGroupPscData

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

Returns:



21689
21690
21691
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21689

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" Corresponds to the JSON property pscTargetService

Returns:

  • (String) 


21696
21697
21698
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21696

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


21702
21703
21704
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21702

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


21707
21708
21709
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21707

def self_link
  @self_link
end

#serverless_deployment ⇒ Google::Apis::ComputeBeta::NetworkEndpointGroupServerlessDeployment

Configuration for a serverless network endpoint group (NEG). The platform 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:



21714
21715
21716
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21714

def serverless_deployment
  @serverless_deployment
end

#size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


21719
21720
21721
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21719

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) 


21725
21726
21727
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21725

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) 


21730
21731
21732
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21730

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21737
21738
21739
21740
21741
21742
21743
21744
21745
21746
21747
21748
21749
21750
21751
21752
21753
21754
21755
21756
21757
21758
21759
 
# File 'lib/google/apis/compute_beta/classes.rb', line 21737

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