Struct ListBgpRoutesRequest 

#[non_exhaustive]
pub struct ListBgpRoutesRequest {

    pub address_family: Option<AddressFamily>,
    pub destination_prefix: Option<String>,
    pub filter: Option<String>,
    pub max_results: Option<u32>,
    pub order_by: Option<String>,
    pub page_token: Option<String>,
    pub peer: Option<String>,
    pub policy_applied: Option<bool>,
    pub project: String,
    pub region: String,
    pub return_partial_success: Option<bool>,
    pub route_type: Option<RouteType>,
    pub router: String,
    /* private fields */
}

Available on crate feature routers only.

Synthetic request message for the listBgpRoutes() method.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

address_family: Option<AddressFamily>

(Required) limit results to this address family (either IPv4 or IPv6)

destination_prefix: Option<String>

Limit results to destinations that are subnets of this CIDR range

filter: Option<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 onresource 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 GoogleRE2 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.

max_results: Option<u32>

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)

order_by: Option<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.

page_token: Option<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.

peer: Option<String>

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

policy_applied: Option<bool>

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

project: String

Project ID for this request.

region: String

Name of the region for this request.

return_partial_success: Option<bool>

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.

route_type: Option<RouteType>

(Required) limit results to this type of route (either LEARNED or ADVERTISED)

router: String

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

Implementations

impl ListBgpRoutesRequest

pub fn new() -> Self

pub fn set_address_family<T>(self, v: T) -> Self

where T: Into<AddressFamily>,

Sets the value of address_family.

Example

use google_cloud_compute_v1::model::routers::list_bgp_routes_request::AddressFamily;
let x0 = ListBgpRoutesRequest::new().set_address_family(AddressFamily::Ipv6);
let x1 = ListBgpRoutesRequest::new().set_address_family(AddressFamily::UnspecifiedIpVersion);

pub fn set_or_clear_address_family<T>(self, v: Option<T>) -> Self

where T: Into<AddressFamily>,

Sets or clears the value of address_family.

Example

use google_cloud_compute_v1::model::routers::list_bgp_routes_request::AddressFamily;
let x0 = ListBgpRoutesRequest::new().set_or_clear_address_family(Some(AddressFamily::Ipv6));
let x1 = ListBgpRoutesRequest::new().set_or_clear_address_family(Some(AddressFamily::UnspecifiedIpVersion));
let x_none = ListBgpRoutesRequest::new().set_or_clear_address_family(None::<AddressFamily>);

pub fn set_destination_prefix<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of destination_prefix.

Example

let x = ListBgpRoutesRequest::new().set_destination_prefix("example");

pub fn set_or_clear_destination_prefix<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of destination_prefix.

Example

let x = ListBgpRoutesRequest::new().set_or_clear_destination_prefix(Some("example"));
let x = ListBgpRoutesRequest::new().set_or_clear_destination_prefix(None::<String>);

pub fn set_filter<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of filter.

Example

let x = ListBgpRoutesRequest::new().set_filter("example");

pub fn set_or_clear_filter<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of filter.

Example

let x = ListBgpRoutesRequest::new().set_or_clear_filter(Some("example"));
let x = ListBgpRoutesRequest::new().set_or_clear_filter(None::<String>);

pub fn set_max_results<T>(self, v: T) -> Self

where T: Into<u32>,

Sets the value of max_results.

Example

let x = ListBgpRoutesRequest::new().set_max_results(42_u32);

pub fn set_or_clear_max_results<T>(self, v: Option<T>) -> Self

where T: Into<u32>,

Sets or clears the value of max_results.

Example

let x = ListBgpRoutesRequest::new().set_or_clear_max_results(Some(42_u32));
let x = ListBgpRoutesRequest::new().set_or_clear_max_results(None::<u32>);

pub fn set_order_by<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of order_by.

Example

let x = ListBgpRoutesRequest::new().set_order_by("example");

pub fn set_or_clear_order_by<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of order_by.

Example

let x = ListBgpRoutesRequest::new().set_or_clear_order_by(Some("example"));
let x = ListBgpRoutesRequest::new().set_or_clear_order_by(None::<String>);

pub fn set_page_token<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of page_token.

Example

let x = ListBgpRoutesRequest::new().set_page_token("example");

pub fn set_or_clear_page_token<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of page_token.

Example

let x = ListBgpRoutesRequest::new().set_or_clear_page_token(Some("example"));
let x = ListBgpRoutesRequest::new().set_or_clear_page_token(None::<String>);

pub fn set_peer<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of peer.

Example

let x = ListBgpRoutesRequest::new().set_peer("example");

pub fn set_or_clear_peer<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of peer.

Example

let x = ListBgpRoutesRequest::new().set_or_clear_peer(Some("example"));
let x = ListBgpRoutesRequest::new().set_or_clear_peer(None::<String>);

pub fn set_policy_applied<T>(self, v: T) -> Self

where T: Into<bool>,

Sets the value of policy_applied.

Example

let x = ListBgpRoutesRequest::new().set_policy_applied(true);

pub fn set_or_clear_policy_applied<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

Sets or clears the value of policy_applied.

Example

let x = ListBgpRoutesRequest::new().set_or_clear_policy_applied(Some(false));
let x = ListBgpRoutesRequest::new().set_or_clear_policy_applied(None::<bool>);

pub fn set_project<T: Into<String>>(self, v: T) -> Self

Sets the value of project.

Example

let x = ListBgpRoutesRequest::new().set_project("example");

pub fn set_region<T: Into<String>>(self, v: T) -> Self

Sets the value of region.

Example

let x = ListBgpRoutesRequest::new().set_region("example");

pub fn set_return_partial_success<T>(self, v: T) -> Self

where T: Into<bool>,

Sets the value of return_partial_success.

Example

let x = ListBgpRoutesRequest::new().set_return_partial_success(true);

pub fn set_or_clear_return_partial_success<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

Sets or clears the value of return_partial_success.

Example

let x = ListBgpRoutesRequest::new().set_or_clear_return_partial_success(Some(false));
let x = ListBgpRoutesRequest::new().set_or_clear_return_partial_success(None::<bool>);

pub fn set_route_type<T>(self, v: T) -> Self

where T: Into<RouteType>,

Sets the value of route_type.

Example

use google_cloud_compute_v1::model::routers::list_bgp_routes_request::RouteType;
let x0 = ListBgpRoutesRequest::new().set_route_type(RouteType::Learned);
let x1 = ListBgpRoutesRequest::new().set_route_type(RouteType::UnspecifiedRouteType);

pub fn set_or_clear_route_type<T>(self, v: Option<T>) -> Self

where T: Into<RouteType>,

Sets or clears the value of route_type.

Example

use google_cloud_compute_v1::model::routers::list_bgp_routes_request::RouteType;
let x0 = ListBgpRoutesRequest::new().set_or_clear_route_type(Some(RouteType::Learned));
let x1 = ListBgpRoutesRequest::new().set_or_clear_route_type(Some(RouteType::UnspecifiedRouteType));
let x_none = ListBgpRoutesRequest::new().set_or_clear_route_type(None::<RouteType>);

pub fn set_router<T: Into<String>>(self, v: T) -> Self

Sets the value of router.

Example

let x = ListBgpRoutesRequest::new().set_router("example");

Trait Implementations

impl Clone for ListBgpRoutesRequest

fn clone(&self) -> ListBgpRoutesRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListBgpRoutesRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListBgpRoutesRequest

fn default() -> ListBgpRoutesRequest

Returns the “default value” for a type.

impl PartialEq for ListBgpRoutesRequest

fn eq(&self, other: &ListBgpRoutesRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListBgpRoutesRequest