Struct ConnectivityTest 

#[non_exhaustive]
pub struct ConnectivityTest {

    pub name: String,
    pub description: String,
    pub source: Option<Endpoint>,
    pub destination: Option<Endpoint>,
    pub protocol: String,
    pub related_projects: Vec<String>,
    pub display_name: String,
    pub labels: HashMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub reachability_details: Option<ReachabilityDetails>,
    pub probing_details: Option<ProbingDetails>,
    pub round_trip: bool,
    pub return_reachability_details: Option<ReachabilityDetails>,
    pub bypass_firewall_checks: bool,
    /* private fields */
}

A Connectivity Test for a network reachability analysis.

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.

name: String

Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

description: String

The user-supplied description of the Connectivity Test. Maximum of 512 characters.

source: Option<Endpoint>

Required. Source specification of the Connectivity Test.

You can use a combination of source IP address, URI of a supported endpoint, project ID, or VPC network to identify the source location.

Reachability analysis might proceed even if the source location is ambiguous. However, the test result might include endpoints or use a source that you don’t intend to test.

destination: Option<Endpoint>

Required. Destination specification of the Connectivity Test.

You can use a combination of destination IP address, URI of a supported endpoint, project ID, or VPC network to identify the destination location.

Reachability analysis proceeds even if the destination location is ambiguous. However, the test result might include endpoints or use a destination that you don’t intend to test.

protocol: String

IP Protocol of the test. When not provided, “TCP” is assumed.

related_projects: Vec<String>

Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

display_name: String

Output only. The display name of a Connectivity Test.

labels: HashMap<String, String>

Resource labels to represent user-provided metadata.

create_time: Option<Timestamp>

Output only. The time the test was created.

update_time: Option<Timestamp>

Output only. The time the test’s configuration was updated.

reachability_details: Option<ReachabilityDetails>

Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

probing_details: Option<ProbingDetails>

Output only. The probing details of this test from the latest run, present for applicable tests only. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

round_trip: bool

Whether run analysis for the return path from destination to source. Default value is false.

return_reachability_details: Option<ReachabilityDetails>

Output only. The reachability details of this test from the latest run for the return path. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

bypass_firewall_checks: bool

Whether the analysis should skip firewall checking. Default value is false.

Implementations

impl ConnectivityTest

pub fn new() -> Self

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

Sets the value of name.

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

Sets the value of description.

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

where T: Into<Endpoint>,

Sets the value of source.

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

where T: Into<Endpoint>,

Sets or clears the value of source.

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

where T: Into<Endpoint>,

Sets the value of destination.

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

where T: Into<Endpoint>,

Sets or clears the value of destination.

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

Sets the value of protocol.

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

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of related_projects.

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

Sets the value of display_name.

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

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

where T: Into<Timestamp>,

Sets the value of create_time.

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

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

where T: Into<Timestamp>,

Sets the value of update_time.

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

where T: Into<Timestamp>,

Sets or clears the value of update_time.

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

where T: Into<ReachabilityDetails>,

Sets the value of reachability_details.

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

where T: Into<ReachabilityDetails>,

Sets or clears the value of reachability_details.

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

where T: Into<ProbingDetails>,

Sets the value of probing_details.

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

where T: Into<ProbingDetails>,

Sets or clears the value of probing_details.

pub fn set_round_trip<T: Into<bool>>(self, v: T) -> Self

Sets the value of round_trip.

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

where T: Into<ReachabilityDetails>,

Sets the value of return_reachability_details.

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

where T: Into<ReachabilityDetails>,

Sets or clears the value of return_reachability_details.

pub fn set_bypass_firewall_checks<T: Into<bool>>(self, v: T) -> Self

Sets the value of bypass_firewall_checks.

Trait Implementations

impl Clone for ConnectivityTest

fn clone(&self) -> ConnectivityTest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectivityTest

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

Formats the value using the given formatter.

impl Default for ConnectivityTest

fn default() -> ConnectivityTest

Returns the “default value” for a type.

impl Message for ConnectivityTest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ConnectivityTest

fn eq(&self, other: &ConnectivityTest) -> 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 ConnectivityTest