Class: Google::Apis::ComputeAlpha::RouterBgpPeer
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::RouterBgpPeer
- 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
Instance Attribute Summary collapse
-
#advertise_mode ⇒ String
User-specified flag to indicate which mode to use for advertisement.
-
#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.
-
#advertised_ip_ranges ⇒ Array<Google::Apis::ComputeAlpha::RouterAdvertisedIpRange>
User-specified list of individual IP ranges to advertise in custom mode.
-
#advertised_route_priority ⇒ Fixnum
The priority of routes advertised to this BGP peer.
-
#bfd ⇒ Google::Apis::ComputeAlpha::RouterBgpPeerBfd
BFD configuration for the BGP peering.
-
#enable ⇒ String
The status of the BGP peer connection.
-
#interface_name ⇒ String
Name of the interface the BGP peer is associated with.
-
#ip_address ⇒ String
IP address of the interface inside Google Cloud Platform.
-
#management_type ⇒ String
[Output Only] The resource that configures and manages this BGP peer.
-
#name ⇒ String
Name of this BGP peer.
-
#peer_asn ⇒ Fixnum
Peer BGP Autonomous System Number (ASN).
-
#peer_ip_address ⇒ String
IP address of the BGP interface outside Google Cloud Platform.
-
#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.
Instance Method Summary collapse
-
#initialize(**args) ⇒ RouterBgpPeer
constructor
A new instance of RouterBgpPeer.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ RouterBgpPeer
Returns a new instance of RouterBgpPeer.
33210 33211 33212 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33210 def initialize(**args) update!(**args) end |
Instance Attribute Details
#advertise_mode ⇒ String
User-specified flag to indicate which mode to use for advertisement.
Corresponds to the JSON property advertiseMode
33113 33114 33115 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33113 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
33125 33126 33127 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33125 def advertised_groups @advertised_groups end |
#advertised_ip_ranges ⇒ Array<Google::Apis::ComputeAlpha::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
33134 33135 33136 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33134 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
33141 33142 33143 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33141 def advertised_route_priority @advertised_route_priority end |
#bfd ⇒ Google::Apis::ComputeAlpha::RouterBgpPeerBfd
BFD configuration for the BGP peering.
Not currently available publicly.
Corresponds to the JSON property bfd
33147 33148 33149 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33147 def bfd @bfd end |
#enable ⇒ String
The status of the BGP peer connection.
Not currently available publicly.
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
33156 33157 33158 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33156 def enable @enable end |
#interface_name ⇒ String
Name of the interface the BGP peer is associated with.
Corresponds to the JSON property interfaceName
33161 33162 33163 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33161 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
33167 33168 33169 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33167 def ip_address @ip_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
33178 33179 33180 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33178 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
33188 33189 33190 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33188 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
33194 33195 33196 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33194 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
33200 33201 33202 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33200 def peer_ip_address @peer_ip_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
33208 33209 33210 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33208 def router_appliance_instance @router_appliance_instance end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
33215 33216 33217 33218 33219 33220 33221 33222 33223 33224 33225 33226 33227 33228 33229 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 33215 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) @interface_name = args[:interface_name] if args.key?(:interface_name) @ip_address = args[:ip_address] if args.key?(:ip_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) @router_appliance_instance = args[:router_appliance_instance] if args.key?(:router_appliance_instance) end |