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, 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.



22161
22162
22163
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22161

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


22023
22024
22025
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22023

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:



22033
22034
22035
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22033

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:



22041
22042
22043
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22041

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:



22050
22051
22052
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22050

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) 


22055
22056
22057
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22055

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) 


22061
22062
22063
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22061

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) 


22067
22068
22069
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22067

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) 


22073
22074
22075
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22073

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) 


22079
22080
22081
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22079

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:



22084
22085
22086
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22084

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) 


22094
22095
22096
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22094

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) 


22100
22101
22102
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22100

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) 


22107
22108
22109
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22107

def network_endpoint_type
  @network_endpoint_type
end

#psc_target_service ⇒ String

The target service url used to set up private service connection to a Google API. An example value is: "asia-northeast3-cloudkms.googleapis.com" Corresponds to the JSON property pscTargetService

Returns:

  • (String) 


22113
22114
22115
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22113

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) 


22119
22120
22121
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22119

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


22124
22125
22126
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22124

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) 


22129
22130
22131
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22129

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:



22137
22138
22139
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22137

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) 


22142
22143
22144
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22142

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) 


22148
22149
22150
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22148

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) 


22154
22155
22156
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22154

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) 


22159
22160
22161
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22159

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



22166
22167
22168
22169
22170
22171
22172
22173
22174
22175
22176
22177
22178
22179
22180
22181
22182
22183
22184
22185
22186
22187
22188
22189
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 22166

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