Class: Google::Cloud::Compute::V1::ListBgpRoutesRoutersRequest

Inherits:

Object

• Object
• Google::Cloud::Compute::V1::ListBgpRoutesRoutersRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/compute/v1/compute.rb

Overview

A request message for Routers.ListBgpRoutes. See the method description for details.

Defined Under Namespace

Modules: AddressFamily, RouteType

Instance Attribute Summary

• #address_family ⇒ ::String

  (Required) limit results to this address family (either IPv4 or IPv6) Check the AddressFamily enum for the list of possible values.

• #destination_prefix ⇒ ::String

  Limit results to destinations that are subnets of this CIDR range.

• #filter ⇒ ::String

  A filter expression that filters resources listed in the response.

• #max_results ⇒ ::Integer

  The maximum number of results per page that should be returned.

• #order_by ⇒ ::String

  Sorts list results by a certain order.

• #page_token ⇒ ::String

  Specifies a page token to use.

• #peer ⇒ ::String

  (Required) limit results to the BGP peer with the given name.

• #policy_applied ⇒ ::Boolean

  When true, the method returns post-policy routes.

• #project ⇒ ::String

  Project ID for this request.

• #region ⇒ ::String

  Name of the region for this request.

• #return_partial_success ⇒ ::Boolean

  Opt-in for partial success behavior which provides partial results in case of failure.

• #route_type ⇒ ::String

  (Required) limit results to this type of route (either LEARNED or ADVERTISED) Check the RouteType enum for the list of possible values.

• #router ⇒ ::String

  Name or id of the resource for this request.

Instance Attribute Details

#address_family ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#destination_prefix ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#filter ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#max_results ⇒ ::Integer

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#order_by ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#page_token ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#peer ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#policy_applied ⇒ ::Boolean

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#project ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#region ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#return_partial_success ⇒ ::Boolean

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#route_type ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end

#router ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 19047

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

  # (Required) limit results to this address family (either IPv4 or IPv6)
  module AddressFamily
    # A value indicating that the enum field is not set.
    UNDEFINED_ADDRESS_FAMILY = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_IP_VERSION = 72_938_440
  end

  # (Required) limit results to this type of route (either LEARNED or ADVERTISED)
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    ADVERTISED = 20_302_109

    LEARNED = 231_892_419

    UNSPECIFIED_ROUTE_TYPE = 248_064_440
  end
end