Class: Google::Cloud::Compute::V1::RouterBgpPeer

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/compute/v1/compute.rb

Defined Under Namespace

Modules: AdvertiseMode, AdvertisedGroups, Enable, ManagementType

Instance Attribute Summary collapse

Instance Attribute Details

Returns User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.

Returns:

  • (::String) —

    User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#advertised_groups ⇒ ::Array<::String>

Returns User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. 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. Check the AdvertisedGroups enum for the list of possible values.

Returns:

  • (::Array<::String>) —

    User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. 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. Check the AdvertisedGroups enum for the list of possible values.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#advertised_ip_ranges ⇒ ::Array<::Google::Cloud::Compute::V1::RouterAdvertisedIpRange>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Compute::V1::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.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#advertised_route_priority ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#bfd ⇒ ::Google::Cloud::Compute::V1::RouterBgpPeerBfd

Returns BFD configuration for the BGP peering.

Returns:



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#custom_learned_ip_ranges ⇒ ::Array<::Google::Cloud::Compute::V1::RouterBgpPeerCustomLearnedIpRange>

Returns A list of user-defined custom learned route IP address ranges for a BGP session.

Returns:



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#custom_learned_route_priority ⇒ ::Integer

Returns The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.

Returns:

  • (::Integer) —

    The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#enable ⇒ ::String

Returns 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. Check the Enable enum for the list of possible values.

Returns:

  • (::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. Check the Enable enum for the list of possible values.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#enable_ipv4 ⇒ ::Boolean

Returns Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.

Returns:

  • (::Boolean) —

    Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#enable_ipv6 ⇒ ::Boolean

Returns Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.

Returns:

  • (::Boolean) —

    Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#export_policies ⇒ ::Array<::String>

Returns List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.

Returns:

  • (::Array<::String>) —

    List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#import_policies ⇒ ::Array<::String>

Returns List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.

Returns:

  • (::Array<::String>) —

    List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#interface_name ⇒ ::String

Returns Name of the interface the BGP peer is associated with.

Returns:

  • (::String) —

    Name of the interface the BGP peer is associated with.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#ip_address ⇒ ::String

Returns IP address of the interface inside Google Cloud Platform.

Returns:

  • (::String) —

    IP address of the interface inside Google Cloud Platform.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#ipv4_nexthop_address ⇒ ::String

Returns IPv4 address of the interface inside Google Cloud Platform.

Returns:

  • (::String) —

    IPv4 address of the interface inside Google Cloud Platform.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#ipv6_nexthop_address ⇒ ::String

Returns IPv6 address of the interface inside Google Cloud Platform.

Returns:

  • (::String) —

    IPv6 address of the interface inside Google Cloud Platform.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#management_type ⇒ ::String

Returns [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. Check the ManagementType enum for the list of possible values.

Returns:

  • (::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. Check the ManagementType enum for the list of possible values.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#md5_authentication_key_name ⇒ ::String

Returns Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.

Returns:

  • (::String) —

    Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#name ⇒ ::String

Returns 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.

Returns:

  • (::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.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#peer_asn ⇒ ::Integer

Returns Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

Returns:

  • (::Integer) —

    Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#peer_ip_address ⇒ ::String

Returns IP address of the BGP interface outside Google Cloud Platform.

Returns:

  • (::String) —

    IP address of the BGP interface outside Google Cloud Platform.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#peer_ipv4_nexthop_address ⇒ ::String

Returns IPv4 address of the BGP interface outside Google Cloud Platform.

Returns:

  • (::String) —

    IPv4 address of the BGP interface outside Google Cloud Platform.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#peer_ipv6_nexthop_address ⇒ ::String

Returns IPv6 address of the BGP interface outside Google Cloud Platform.

Returns:

  • (::String) —

    IPv6 address of the BGP interface outside Google Cloud Platform.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end

#router_appliance_instance ⇒ ::String

Returns 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.

Returns:

  • (::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.



27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27338

class RouterBgpPeer
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User-specified flag to indicate which mode to use for advertisement.
  module AdvertiseMode
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISE_MODE = 0

    CUSTOM = 388_595_569

    DEFAULT = 115_302_945
  end

  module AdvertisedGroups
    # A value indicating that the enum field is not set.
    UNDEFINED_ADVERTISED_GROUPS = 0

    # Advertise all available subnets (including peer VPC subnets).
    ALL_SUBNETS = 3_622_872
  end

  # 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.
  module Enable
    # A value indicating that the enum field is not set.
    UNDEFINED_ENABLE = 0

    FALSE = 66_658_563

    TRUE = 2_583_950
  end

  # [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.
  module ManagementType
    # A value indicating that the enum field is not set.
    UNDEFINED_MANAGEMENT_TYPE = 0

    # The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.
    MANAGED_BY_ATTACHMENT = 458_926_411

    # Default value, the BGP peer is manually created and managed by user.
    MANAGED_BY_USER = 317_294_067
  end
end