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

Inherits:

Object

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

show all

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 collapse

#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`

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

Returns:

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

# 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`

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

Returns:

(::String) —
Limit results to destinations that are subnets of this CIDR range

# 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`

Returns A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

Returns:

(::String) —
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

# 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`

Returns The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).

Returns:

(::Integer) —
The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

# 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`

Returns Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

Returns:

(::String) —
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

# 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`

Returns Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Returns:

(::String) —
Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

# 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`

Returns (Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.

Returns:

(::String) —
(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.

# 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`

Returns When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.

Returns:

(::Boolean) —
When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.

# 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`

Returns Project ID for this request.

Returns:

(::String) —
Project ID for this request.

# 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`

Returns Name of the region for this request.

Returns:

(::String) —
Name of the region for this request.

# 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`

Returns Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Returns:

(::Boolean) —
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

# 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`

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

Returns:

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

# 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`

Returns Name or id of the resource for this request. Name should conform to RFC1035.

Returns:

(::String) —
Name or id of the resource for this request. Name should conform to RFC1035.

# 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

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

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#address_family ⇒ ::String

#destination_prefix ⇒ ::String

#filter ⇒ ::String

#max_results ⇒ ::Integer

#order_by ⇒ ::String

#page_token ⇒ ::String

#peer ⇒ ::String

#policy_applied ⇒ ::Boolean

#project ⇒ ::String

#region ⇒ ::String

#return_partial_success ⇒ ::Boolean

#route_type ⇒ ::String

#router ⇒ ::String

#address_family ⇒ `::String`

#destination_prefix ⇒ `::String`

#filter ⇒ `::String`

#max_results ⇒ `::Integer`

#order_by ⇒ `::String`

#page_token ⇒ `::String`

#peer ⇒ `::String`

#policy_applied ⇒ `::Boolean`

#project ⇒ `::String`

#region ⇒ `::String`

#return_partial_success ⇒ `::Boolean`

#route_type ⇒ `::String`

#router ⇒ `::String`