Class: Google::Apis::ComputeV1::ForwardingRule

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/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.


2391
2392
2393
# File 'generated/google/apis/compute_v1/classes.rb', line 2391

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

Instance Attribute Details

#creation_timestampString

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

Returns:

  • (String)

2331
2332
2333
# File 'generated/google/apis/compute_v1/classes.rb', line 2331

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)

2337
2338
2339
# File 'generated/google/apis/compute_v1/classes.rb', line 2337

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)

2343
2344
2345
# File 'generated/google/apis/compute_v1/classes.rb', line 2343

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)

2319
2320
2321
# File 'generated/google/apis/compute_v1/classes.rb', line 2319

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)

2326
2327
2328
# File 'generated/google/apis/compute_v1/classes.rb', line 2326

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)

2349
2350
2351
# File 'generated/google/apis/compute_v1/classes.rb', line 2349

def kind
  @kind
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)

2359
2360
2361
# File 'generated/google/apis/compute_v1/classes.rb', line 2359

def name
  @name
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)

2367
2368
2369
# File 'generated/google/apis/compute_v1/classes.rb', line 2367

def port_range
  @port_range
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)

2373
2374
2375
# File 'generated/google/apis/compute_v1/classes.rb', line 2373

def region
  @region
end

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

Returns:

  • (String)

2378
2379
2380
# File 'generated/google/apis/compute_v1/classes.rb', line 2378

def self_link
  @self_link
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)

2389
2390
2391
# File 'generated/google/apis/compute_v1/classes.rb', line 2389

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
# File 'generated/google/apis/compute_v1/classes.rb', line 2396

def update!(**args)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol)
  @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)
  @name = args[:name] if args.key?(:name)
  @port_range = args[:port_range] if args.key?(:port_range)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @target = args[:target] if args.key?(:target)
end