Network Management V1 API - Class Google::Cloud::NetworkManagement::V1::Step (v1.0.0)

Version 1.0.0

• 1.1.0 (latest)
• 1.0.2
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.2
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.1
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.3

Reference documentation and code samples for the Network Management V1 API class Google::Cloud::NetworkManagement::V1::Step.

A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#abort

def abort() -> ::Google::Cloud::NetworkManagement::V1::AbortInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::AbortInfo) — Display information of the final state "abort" and reason.

#abort=

def abort=(value) -> ::Google::Cloud::NetworkManagement::V1::AbortInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::AbortInfo) — Display information of the final state "abort" and reason.

Returns

• (::Google::Cloud::NetworkManagement::V1::AbortInfo) — Display information of the final state "abort" and reason.

#app_engine_version

def app_engine_version() -> ::Google::Cloud::NetworkManagement::V1::AppEngineVersionInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::AppEngineVersionInfo) — Display information of an App Engine service version.

#app_engine_version=

def app_engine_version=(value) -> ::Google::Cloud::NetworkManagement::V1::AppEngineVersionInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::AppEngineVersionInfo) — Display information of an App Engine service version.

Returns

• (::Google::Cloud::NetworkManagement::V1::AppEngineVersionInfo) — Display information of an App Engine service version.

#causes_drop

def causes_drop() -> ::Boolean

Returns

• (::Boolean) — This is a step that leads to the final state Drop.

#causes_drop=

def causes_drop=(value) -> ::Boolean

Parameter

• value (::Boolean) — This is a step that leads to the final state Drop.

Returns

• (::Boolean) — This is a step that leads to the final state Drop.

#cloud_function

def cloud_function() -> ::Google::Cloud::NetworkManagement::V1::CloudFunctionInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::CloudFunctionInfo) — Display information of a Cloud Function.

#cloud_function=

def cloud_function=(value) -> ::Google::Cloud::NetworkManagement::V1::CloudFunctionInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::CloudFunctionInfo) — Display information of a Cloud Function.

Returns

• (::Google::Cloud::NetworkManagement::V1::CloudFunctionInfo) — Display information of a Cloud Function.

#cloud_run_revision

def cloud_run_revision() -> ::Google::Cloud::NetworkManagement::V1::CloudRunRevisionInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::CloudRunRevisionInfo) — Display information of a Cloud Run revision.

#cloud_run_revision=

def cloud_run_revision=(value) -> ::Google::Cloud::NetworkManagement::V1::CloudRunRevisionInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::CloudRunRevisionInfo) — Display information of a Cloud Run revision.

Returns

• (::Google::Cloud::NetworkManagement::V1::CloudRunRevisionInfo) — Display information of a Cloud Run revision.

#cloud_sql_instance

def cloud_sql_instance() -> ::Google::Cloud::NetworkManagement::V1::CloudSQLInstanceInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::CloudSQLInstanceInfo) — Display information of a Cloud SQL instance.

#cloud_sql_instance=

def cloud_sql_instance=(value) -> ::Google::Cloud::NetworkManagement::V1::CloudSQLInstanceInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::CloudSQLInstanceInfo) — Display information of a Cloud SQL instance.

Returns

• (::Google::Cloud::NetworkManagement::V1::CloudSQLInstanceInfo) — Display information of a Cloud SQL instance.

#deliver

def deliver() -> ::Google::Cloud::NetworkManagement::V1::DeliverInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::DeliverInfo) — Display information of the final state "deliver" and reason.

#deliver=

def deliver=(value) -> ::Google::Cloud::NetworkManagement::V1::DeliverInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::DeliverInfo) — Display information of the final state "deliver" and reason.

Returns

• (::Google::Cloud::NetworkManagement::V1::DeliverInfo) — Display information of the final state "deliver" and reason.

#description

def description() -> ::String

Returns

• (::String) — A description of the step. Usually this is a summary of the state.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — A description of the step. Usually this is a summary of the state.

Returns

• (::String) — A description of the step. Usually this is a summary of the state.

#drop

def drop() -> ::Google::Cloud::NetworkManagement::V1::DropInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::DropInfo) — Display information of the final state "drop" and reason.

#drop=

def drop=(value) -> ::Google::Cloud::NetworkManagement::V1::DropInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::DropInfo) — Display information of the final state "drop" and reason.

Returns

• (::Google::Cloud::NetworkManagement::V1::DropInfo) — Display information of the final state "drop" and reason.

#endpoint

def endpoint() -> ::Google::Cloud::NetworkManagement::V1::EndpointInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::EndpointInfo) — Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy.

#endpoint=

def endpoint=(value) -> ::Google::Cloud::NetworkManagement::V1::EndpointInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::EndpointInfo) — Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy.

Returns

• (::Google::Cloud::NetworkManagement::V1::EndpointInfo) — Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy.

#firewall

def firewall() -> ::Google::Cloud::NetworkManagement::V1::FirewallInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::FirewallInfo) — Display information of a Compute Engine firewall rule.

#firewall=

def firewall=(value) -> ::Google::Cloud::NetworkManagement::V1::FirewallInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::FirewallInfo) — Display information of a Compute Engine firewall rule.

Returns

• (::Google::Cloud::NetworkManagement::V1::FirewallInfo) — Display information of a Compute Engine firewall rule.

#forward

def forward() -> ::Google::Cloud::NetworkManagement::V1::ForwardInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::ForwardInfo) — Display information of the final state "forward" and reason.

#forward=

def forward=(value) -> ::Google::Cloud::NetworkManagement::V1::ForwardInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::ForwardInfo) — Display information of the final state "forward" and reason.

Returns

• (::Google::Cloud::NetworkManagement::V1::ForwardInfo) — Display information of the final state "forward" and reason.

#forwarding_rule

def forwarding_rule() -> ::Google::Cloud::NetworkManagement::V1::ForwardingRuleInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::ForwardingRuleInfo) — Display information of a Compute Engine forwarding rule.

#forwarding_rule=

def forwarding_rule=(value) -> ::Google::Cloud::NetworkManagement::V1::ForwardingRuleInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::ForwardingRuleInfo) — Display information of a Compute Engine forwarding rule.

Returns

• (::Google::Cloud::NetworkManagement::V1::ForwardingRuleInfo) — Display information of a Compute Engine forwarding rule.

#gke_master

def gke_master() -> ::Google::Cloud::NetworkManagement::V1::GKEMasterInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::GKEMasterInfo) — Display information of a Google Kubernetes Engine cluster master.

#gke_master=

def gke_master=(value) -> ::Google::Cloud::NetworkManagement::V1::GKEMasterInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::GKEMasterInfo) — Display information of a Google Kubernetes Engine cluster master.

Returns

• (::Google::Cloud::NetworkManagement::V1::GKEMasterInfo) — Display information of a Google Kubernetes Engine cluster master.

#google_service

def google_service() -> ::Google::Cloud::NetworkManagement::V1::GoogleServiceInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::GoogleServiceInfo) — Display information of a Google service

#google_service=

def google_service=(value) -> ::Google::Cloud::NetworkManagement::V1::GoogleServiceInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::GoogleServiceInfo) — Display information of a Google service

Returns

• (::Google::Cloud::NetworkManagement::V1::GoogleServiceInfo) — Display information of a Google service

#instance

def instance() -> ::Google::Cloud::NetworkManagement::V1::InstanceInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::InstanceInfo) — Display information of a Compute Engine instance.

#instance=

def instance=(value) -> ::Google::Cloud::NetworkManagement::V1::InstanceInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::InstanceInfo) — Display information of a Compute Engine instance.

Returns

• (::Google::Cloud::NetworkManagement::V1::InstanceInfo) — Display information of a Compute Engine instance.

#load_balancer

def load_balancer() -> ::Google::Cloud::NetworkManagement::V1::LoadBalancerInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::LoadBalancerInfo) — Display information of the load balancers. Deprecated in favor of the load_balancer_backend_info field, not used in new tests.

#load_balancer=

def load_balancer=(value) -> ::Google::Cloud::NetworkManagement::V1::LoadBalancerInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::LoadBalancerInfo) — Display information of the load balancers. Deprecated in favor of the load_balancer_backend_info field, not used in new tests.

Returns

• (::Google::Cloud::NetworkManagement::V1::LoadBalancerInfo) — Display information of the load balancers. Deprecated in favor of the load_balancer_backend_info field, not used in new tests.

#load_balancer_backend_info

def load_balancer_backend_info() -> ::Google::Cloud::NetworkManagement::V1::LoadBalancerBackendInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::LoadBalancerBackendInfo) — Display information of a specific load balancer backend.

#load_balancer_backend_info=

def load_balancer_backend_info=(value) -> ::Google::Cloud::NetworkManagement::V1::LoadBalancerBackendInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::LoadBalancerBackendInfo) — Display information of a specific load balancer backend.

Returns

• (::Google::Cloud::NetworkManagement::V1::LoadBalancerBackendInfo) — Display information of a specific load balancer backend.

#nat

def nat() -> ::Google::Cloud::NetworkManagement::V1::NatInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::NatInfo) — Display information of a NAT.

#nat=

def nat=(value) -> ::Google::Cloud::NetworkManagement::V1::NatInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::NatInfo) — Display information of a NAT.

Returns

• (::Google::Cloud::NetworkManagement::V1::NatInfo) — Display information of a NAT.

#network

def network() -> ::Google::Cloud::NetworkManagement::V1::NetworkInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::NetworkInfo) — Display information of a Google Cloud network.

#network=

def network=(value) -> ::Google::Cloud::NetworkManagement::V1::NetworkInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::NetworkInfo) — Display information of a Google Cloud network.

Returns

• (::Google::Cloud::NetworkManagement::V1::NetworkInfo) — Display information of a Google Cloud network.

#project_id

def project_id() -> ::String

Returns

• (::String) — Project ID that contains the configuration this step is validating.

#project_id=

def project_id=(value) -> ::String

Parameter

• value (::String) — Project ID that contains the configuration this step is validating.

Returns

• (::String) — Project ID that contains the configuration this step is validating.

#proxy_connection

def proxy_connection() -> ::Google::Cloud::NetworkManagement::V1::ProxyConnectionInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::ProxyConnectionInfo) — Display information of a ProxyConnection.

#proxy_connection=

def proxy_connection=(value) -> ::Google::Cloud::NetworkManagement::V1::ProxyConnectionInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::ProxyConnectionInfo) — Display information of a ProxyConnection.

Returns

• (::Google::Cloud::NetworkManagement::V1::ProxyConnectionInfo) — Display information of a ProxyConnection.

#route

def route() -> ::Google::Cloud::NetworkManagement::V1::RouteInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::RouteInfo) — Display information of a Compute Engine route.

#route=

def route=(value) -> ::Google::Cloud::NetworkManagement::V1::RouteInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::RouteInfo) — Display information of a Compute Engine route.

Returns

• (::Google::Cloud::NetworkManagement::V1::RouteInfo) — Display information of a Compute Engine route.

#state

def state() -> ::Google::Cloud::NetworkManagement::V1::Step::State

Returns

• (::Google::Cloud::NetworkManagement::V1::Step::State) — Each step is in one of the pre-defined states.

#state=

def state=(value) -> ::Google::Cloud::NetworkManagement::V1::Step::State

Parameter

• value (::Google::Cloud::NetworkManagement::V1::Step::State) — Each step is in one of the pre-defined states.

Returns

• (::Google::Cloud::NetworkManagement::V1::Step::State) — Each step is in one of the pre-defined states.

#storage_bucket

def storage_bucket() -> ::Google::Cloud::NetworkManagement::V1::StorageBucketInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::StorageBucketInfo) — Display information of a Storage Bucket. Used only for return traces.

#storage_bucket=

def storage_bucket=(value) -> ::Google::Cloud::NetworkManagement::V1::StorageBucketInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::StorageBucketInfo) — Display information of a Storage Bucket. Used only for return traces.

Returns

• (::Google::Cloud::NetworkManagement::V1::StorageBucketInfo) — Display information of a Storage Bucket. Used only for return traces.

#vpc_connector

def vpc_connector() -> ::Google::Cloud::NetworkManagement::V1::VpcConnectorInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::VpcConnectorInfo) — Display information of a VPC connector.

#vpc_connector=

def vpc_connector=(value) -> ::Google::Cloud::NetworkManagement::V1::VpcConnectorInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::VpcConnectorInfo) — Display information of a VPC connector.

Returns

• (::Google::Cloud::NetworkManagement::V1::VpcConnectorInfo) — Display information of a VPC connector.

#vpn_gateway

def vpn_gateway() -> ::Google::Cloud::NetworkManagement::V1::VpnGatewayInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::VpnGatewayInfo) — Display information of a Compute Engine VPN gateway.

#vpn_gateway=

def vpn_gateway=(value) -> ::Google::Cloud::NetworkManagement::V1::VpnGatewayInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::VpnGatewayInfo) — Display information of a Compute Engine VPN gateway.

Returns

• (::Google::Cloud::NetworkManagement::V1::VpnGatewayInfo) — Display information of a Compute Engine VPN gateway.

#vpn_tunnel

def vpn_tunnel() -> ::Google::Cloud::NetworkManagement::V1::VpnTunnelInfo

Returns

• (::Google::Cloud::NetworkManagement::V1::VpnTunnelInfo) — Display information of a Compute Engine VPN tunnel.

#vpn_tunnel=

def vpn_tunnel=(value) -> ::Google::Cloud::NetworkManagement::V1::VpnTunnelInfo

Parameter

• value (::Google::Cloud::NetworkManagement::V1::VpnTunnelInfo) — Display information of a Compute Engine VPN tunnel.

Returns

• (::Google::Cloud::NetworkManagement::V1::VpnTunnelInfo) — Display information of a Compute Engine VPN tunnel.