Class: Google::Apis::ComputeV1::RouterBgpPeer

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RouterBgpPeer

Returns a new instance of RouterBgpPeer.



29006
29007
29008
 
# File 'lib/google/apis/compute_v1/classes.rb', line 29006

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

Instance Attribute Details

User-specified flag to indicate which mode to use for advertisement. Corresponds to the JSON property advertiseMode

Returns:

  • (String) 


28897
28898
28899
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28897

def advertise_mode
  @advertise_mode
end

#advertised_groups ⇒ Array<String>

User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router' s own VPC subnets. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. Corresponds to the JSON property advertisedGroups

Returns:

  • (Array<String>) 


28908
28909
28910
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28908

def advertised_groups
  @advertised_groups
end

#advertised_ip_ranges ⇒ Array<Google::Apis::ComputeV1::RouterAdvertisedIpRange>

User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Corresponds to the JSON property advertisedIpRanges

Returns:



28917
28918
28919
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28917

def advertised_ip_ranges
  @advertised_ip_ranges
end

#advertised_route_priority ⇒ Fixnum

The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win. Corresponds to the JSON property advertisedRoutePriority

Returns:

  • (Fixnum) 


28924
28925
28926
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28924

def advertised_route_priority
  @advertised_route_priority
end

#bfd ⇒ Google::Apis::ComputeV1::RouterBgpPeerBfd

BFD configuration for the BGP peering. Corresponds to the JSON property bfd

Returns:



28929
28930
28931
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28929

def bfd
  @bfd
end

#enable ⇒ String

The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. Corresponds to the JSON property enable

Returns:

  • (String) 


28937
28938
28939
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28937

def enable
  @enable
end

#enable_ipv6 ⇒ Boolean Also known as: enable_ipv6?

Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. Corresponds to the JSON property enableIpv6

Returns:

  • (Boolean) 


28942
28943
28944
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28942

def enable_ipv6
  @enable_ipv6
end

#interface_name ⇒ String

Name of the interface the BGP peer is associated with. Corresponds to the JSON property interfaceName

Returns:

  • (String) 


28948
28949
28950
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28948

def interface_name
  @interface_name
end

#ip_address ⇒ String

IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. Corresponds to the JSON property ipAddress

Returns:

  • (String) 


28954
28955
28956
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28954

def ip_address
  @ip_address
end

#ipv6_nexthop_address ⇒ String

IPv6 address of the interface inside Google Cloud Platform. Corresponds to the JSON property ipv6NexthopAddress

Returns:

  • (String) 


28959
28960
28961
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28959

def ipv6_nexthop_address
  @ipv6_nexthop_address
end

#management_type ⇒ String

[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. Corresponds to the JSON property managementType

Returns:

  • (String) 


28969
28970
28971
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28969

def management_type
  @management_type
end

#name ⇒ String

Name of this BGP peer. 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) 


28979
28980
28981
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28979

def name
  @name
end

#peer_asn ⇒ Fixnum

Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. Corresponds to the JSON property peerAsn

Returns:

  • (Fixnum) 


28985
28986
28987
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28985

def peer_asn
  @peer_asn
end

#peer_ip_address ⇒ String

IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Corresponds to the JSON property peerIpAddress

Returns:

  • (String) 


28991
28992
28993
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28991

def peer_ip_address
  @peer_ip_address
end

#peer_ipv6_nexthop_address ⇒ String

IPv6 address of the BGP interface outside Google Cloud Platform. Corresponds to the JSON property peerIpv6NexthopAddress

Returns:

  • (String) 


28996
28997
28998
 
# File 'lib/google/apis/compute_v1/classes.rb', line 28996

def peer_ipv6_nexthop_address
  @peer_ipv6_nexthop_address
end

#router_appliance_instance ⇒ String

URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session. Corresponds to the JSON property routerApplianceInstance

Returns:

  • (String) 


29004
29005
29006
 
# File 'lib/google/apis/compute_v1/classes.rb', line 29004

def router_appliance_instance
  @router_appliance_instance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



29011
29012
29013
29014
29015
29016
29017
29018
29019
29020
29021
29022
29023
29024
29025
29026
29027
29028
 
# File 'lib/google/apis/compute_v1/classes.rb', line 29011

def update!(**args)
  @advertise_mode = args[:advertise_mode] if args.key?(:advertise_mode)
  @advertised_groups = args[:advertised_groups] if args.key?(:advertised_groups)
  @advertised_ip_ranges = args[:advertised_ip_ranges] if args.key?(:advertised_ip_ranges)
  @advertised_route_priority = args[:advertised_route_priority] if args.key?(:advertised_route_priority)
  @bfd = args[:bfd] if args.key?(:bfd)
  @enable = args[:enable] if args.key?(:enable)
  @enable_ipv6 = args[:enable_ipv6] if args.key?(:enable_ipv6)
  @interface_name = args[:interface_name] if args.key?(:interface_name)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @ipv6_nexthop_address = args[:ipv6_nexthop_address] if args.key?(:ipv6_nexthop_address)
  @management_type = args[:management_type] if args.key?(:management_type)
  @name = args[:name] if args.key?(:name)
  @peer_asn = args[:peer_asn] if args.key?(:peer_asn)
  @peer_ip_address = args[:peer_ip_address] if args.key?(:peer_ip_address)
  @peer_ipv6_nexthop_address = args[:peer_ipv6_nexthop_address] if args.key?(:peer_ipv6_nexthop_address)
  @router_appliance_instance = args[:router_appliance_instance] if args.key?(:router_appliance_instance)
end