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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NetworkEndpointGroup

Returns a new instance of NetworkEndpointGroup.



31819
31820
31821
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31819

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Optional. Metadata defined as annotations on the network endpoint group. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


31688
31689
31690
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31688

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:



31698
31699
31700
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31698

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:



31706
31707
31708
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31706

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:



31716
31717
31718
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31716

def cloud_run
  @cloud_run
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


31722
31723
31724
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31722

def creation_timestamp
  @creation_timestamp
end

#default_port ⇒ Fixnum

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


31731
31732
31733
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31731

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) 


31737
31738
31739
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31737

def description
  @description
end

#id ⇒ Fixnum

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


31744
31745
31746
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31744

def id
  @id
end

#kind ⇒ String

Output only. [Output Only] Type of the resource. Alwayscompute# networkEndpointGroup for network endpoint group. Corresponds to the JSON property kind

Returns:

  • (String) 


31750
31751
31752
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31750

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


31761
31762
31763
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31761

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) 


31767
31768
31769
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31767

def network
  @network
end

#network_endpoint_type ⇒ String

Type of network endpoints in this network endpoint group. Can be one ofGCE_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) 


31774
31775
31776
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31774

def network_endpoint_type
  @network_endpoint_type
end

#psc_data ⇒ Google::Apis::ComputeV1::NetworkEndpointGroupPscData

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

Returns:



31780
31781
31782
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31780

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. Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. Corresponds to the JSON property pscTargetService

Returns:

  • (String) 


31788
31789
31790
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31788

def psc_target_service
  @psc_target_service
end

#region ⇒ String

Output only. [Output Only] The URL of theregion where the network endpoint group is located. Corresponds to the JSON property region

Returns:

  • (String) 


31794
31795
31796
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31794

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


31799
31800
31801
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31799

def self_link
  @self_link
end

#size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


31805
31806
31807
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31805

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) 


31811
31812
31813
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31811

def subnetwork
  @subnetwork
end

#zone ⇒ String

Output only. [Output Only] The URL of thezone where the network endpoint group is located. Corresponds to the JSON property zone

Returns:

  • (String) 


31817
31818
31819
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31817

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



31824
31825
31826
31827
31828
31829
31830
31831
31832
31833
31834
31835
31836
31837
31838
31839
31840
31841
31842
31843
31844
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31824

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