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 for different use cases, see Network endpoint groups overview.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NetworkEndpointGroup

Returns a new instance of NetworkEndpointGroup.



27020
27021
27022
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27020

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


26889
26890
26891
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26889

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:



26898
26899
26900
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26898

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:



26905
26906
26907
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26905

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:



26913
26914
26915
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26913

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) 


26918
26919
26920
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26918

def creation_timestamp
  @creation_timestamp
end

#default_port ⇒ Fixnum

The default port used if the port number is not specified in the network endpoint. 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) 


26925
26926
26927
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26925

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) 


26931
26932
26933
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26931

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) 


26937
26938
26939
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26937

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) 


26943
26944
26945
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26943

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:



26948
26949
26950
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26948

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) 


26958
26959
26960
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26958

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) 


26964
26965
26966
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26964

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

Returns:

  • (String) 


26971
26972
26973
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26971

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:



26977
26978
26979
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26977

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) 


26984
26985
26986
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26984

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) 


26990
26991
26992
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26990

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


26995
26996
26997
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26995

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:



27002
27003
27004
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27002

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) 


27007
27008
27009
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27007

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) 


27013
27014
27015
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27013

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) 


27018
27019
27020
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27018

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



27025
27026
27027
27028
27029
27030
27031
27032
27033
27034
27035
27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27025

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