Class: Google::Apis::ComputeBeta::ForwardingRule

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_beta/classes.rb,
generated/google/apis/compute_beta/representations.rb,
generated/google/apis/compute_beta/representations.rb

Overview

A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [ IPAddress, IPProtocol, portRange] tuple.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ForwardingRule

Returns a new instance of ForwardingRule.


2658
2659
2660
# File 'generated/google/apis/compute_beta/classes.rb', line 2658

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

Instance Attribute Details

#backend_serviceString

This field is not used for external load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. Corresponds to the JSON property backendService

Returns:

  • (String)

2556
2557
2558
# File 'generated/google/apis/compute_beta/classes.rb', line 2556

def backend_service
  @backend_service
end

#creation_timestampString

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String)

2561
2562
2563
# File 'generated/google/apis/compute_beta/classes.rb', line 2561

def creation_timestamp
  @creation_timestamp
end

#descriptionString

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String)

2567
2568
2569
# File 'generated/google/apis/compute_beta/classes.rb', line 2567

def description
  @description
end

#idString

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

Returns:

  • (String)

2573
2574
2575
# File 'generated/google/apis/compute_beta/classes.rb', line 2573

def id
  @id
end

#ip_addressString

The IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope ( global or regional) will be assigned. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. Corresponds to the JSON property IPAddress

Returns:

  • (String)

2542
2543
2544
# File 'generated/google/apis/compute_beta/classes.rb', line 2542

def ip_address
  @ip_address
end

#ip_protocolString

The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid. Corresponds to the JSON property IPProtocol

Returns:

  • (String)

2549
2550
2551
# File 'generated/google/apis/compute_beta/classes.rb', line 2549

def ip_protocol
  @ip_protocol
end

#kindString

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. Corresponds to the JSON property kind

Returns:

  • (String)

2579
2580
2581
# File 'generated/google/apis/compute_beta/classes.rb', line 2579

def kind
  @kind
end

#load_balancing_schemeString

This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) Corresponds to the JSON property loadBalancingScheme

Returns:

  • (String)

2588
2589
2590
# File 'generated/google/apis/compute_beta/classes.rb', line 2588

def load_balancing_scheme
  @load_balancing_scheme
end

#nameString

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

2598
2599
2600
# File 'generated/google/apis/compute_beta/classes.rb', line 2598

def name
  @name
end

#networkString

This field is not used for external load balancing. For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. Corresponds to the JSON property network

Returns:

  • (String)

2606
2607
2608
# File 'generated/google/apis/compute_beta/classes.rb', line 2606

def network
  @network
end

#port_rangeString

Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. This field is not used for internal load balancing. Corresponds to the JSON property portRange

Returns:

  • (String)

2614
2615
2616
# File 'generated/google/apis/compute_beta/classes.rb', line 2614

def port_range
  @port_range
end

#portsArray<String>

This field is not used for external load balancing. When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through. You may specify a maximum of up to 5 ports. Corresponds to the JSON property ports

Returns:

  • (Array<String>)

2624
2625
2626
# File 'generated/google/apis/compute_beta/classes.rb', line 2624

def ports
  @ports
end

#regionString

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. Corresponds to the JSON property region

Returns:

  • (String)

2630
2631
2632
# File 'generated/google/apis/compute_beta/classes.rb', line 2630

def region
  @region
end

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

Returns:

  • (String)

2635
2636
2637
# File 'generated/google/apis/compute_beta/classes.rb', line 2635

def self_link
  @self_link
end

#subnetworkString

This field is not used for external load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. Corresponds to the JSON property subnetwork

Returns:

  • (String)

2645
2646
2647
# File 'generated/google/apis/compute_beta/classes.rb', line 2645

def subnetwork
  @subnetwork
end

#targetString

The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic. This field is not used for internal load balancing. Corresponds to the JSON property target

Returns:

  • (String)

2656
2657
2658
# File 'generated/google/apis/compute_beta/classes.rb', line 2656

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
# File 'generated/google/apis/compute_beta/classes.rb', line 2663

def update!(**args)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol)
  @backend_service = args[:backend_service] if args.key?(:backend_service)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @load_balancing_scheme = args[:load_balancing_scheme] if args.key?(:load_balancing_scheme)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @port_range = args[:port_range] if args.key?(:port_range)
  @ports = args[:ports] if args.key?(:ports)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @target = args[:target] if args.key?(:target)
end