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, see Network endpoint groups overview.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NetworkEndpointGroup

Returns a new instance of NetworkEndpointGroup.



28072
28073
28074
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28072

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


27925
27926
27927
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27925

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:



27934
27935
27936
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27934

def app_engine
  @app_engine
end

#client_port_mapping_mode ⇒ String

Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. Corresponds to the JSON property clientPortMappingMode

Returns:

  • (String) 


27939
27940
27941
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27939

def client_port_mapping_mode
  @client_port_mapping_mode
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:



27946
27947
27948
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27946

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:



27954
27955
27956
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27954

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) 


27959
27960
27961
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27959

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) 


27966
27967
27968
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27966

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) 


27972
27973
27974
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27972

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) 


27978
27979
27980
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27978

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) 


27984
27985
27986
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27984

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:



27989
27990
27991
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27989

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) 


27999
28000
28001
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27999

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) 


28005
28006
28007
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28005

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) 


28012
28013
28014
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28012

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:



28018
28019
28020
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28018

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) 


28025
28026
28027
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28025

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) 


28031
28032
28033
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28031

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


28036
28037
28038
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28036

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) 


28041
28042
28043
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28041

def self_link_with_id
  @self_link_with_id
end

#serverless_deployment ⇒ Google::Apis::ComputeAlpha::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:



28048
28049
28050
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28048

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) 


28053
28054
28055
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28053

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) 


28059
28060
28061
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28059

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) 


28065
28066
28067
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28065

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) 


28070
28071
28072
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28070

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



28077
28078
28079
28080
28081
28082
28083
28084
28085
28086
28087
28088
28089
28090
28091
28092
28093
28094
28095
28096
28097
28098
28099
28100
28101
28102
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28077

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @app_engine = args[:app_engine] if args.key?(:app_engine)
  @client_port_mapping_mode = args[:client_port_mapping_mode] if args.key?(:client_port_mapping_mode)
  @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