Class Step (1.17.1)

Version latest

• 1.17.1 (latest)
• 1.17.0
• 1.16.0
• 1.15.1
• 1.14.0
• 1.13.3
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.2
• 1.7.1
• 1.6.0
• 1.5.4
• 1.4.0
• 1.3.3
• 1.2.1
• 1.1.0
• 1.0.2
• 0.2.0
• 0.1.1

Step(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
description	str A description of the step. Usually this is a summary of the state.
state	google.cloud.network_management_v1.types.Step.State Each step is in one of the pre-defined states.
causes_drop	bool This is a step that leads to the final state Drop.
project_id	str Project ID that contains the configuration this step is validating.
instance	google.cloud.network_management_v1.types.InstanceInfo Display information of a Compute Engine instance. This field is a member of oneof_ step_info.
firewall	google.cloud.network_management_v1.types.FirewallInfo Display information of a Compute Engine firewall rule. This field is a member of oneof_ step_info.
route	google.cloud.network_management_v1.types.RouteInfo Display information of a Compute Engine route. This field is a member of oneof_ step_info.
endpoint	google.cloud.network_management_v1.types.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. This field is a member of oneof_ step_info.
google_service	google.cloud.network_management_v1.types.GoogleServiceInfo Display information of a Google service This field is a member of oneof_ step_info.
forwarding_rule	google.cloud.network_management_v1.types.ForwardingRuleInfo Display information of a Compute Engine forwarding rule. This field is a member of oneof_ step_info.
vpn_gateway	google.cloud.network_management_v1.types.VpnGatewayInfo Display information of a Compute Engine VPN gateway. This field is a member of oneof_ step_info.
vpn_tunnel	google.cloud.network_management_v1.types.VpnTunnelInfo Display information of a Compute Engine VPN tunnel. This field is a member of oneof_ step_info.
vpc_connector	google.cloud.network_management_v1.types.VpcConnectorInfo Display information of a VPC connector. This field is a member of oneof_ step_info.
deliver	google.cloud.network_management_v1.types.DeliverInfo Display information of the final state "deliver" and reason. This field is a member of oneof_ step_info.
forward	google.cloud.network_management_v1.types.ForwardInfo Display information of the final state "forward" and reason. This field is a member of oneof_ step_info.
abort	google.cloud.network_management_v1.types.AbortInfo Display information of the final state "abort" and reason. This field is a member of oneof_ step_info.
drop	google.cloud.network_management_v1.types.DropInfo Display information of the final state "drop" and reason. This field is a member of oneof_ step_info.
load_balancer	google.cloud.network_management_v1.types.LoadBalancerInfo Display information of the load balancers. Deprecated in favor of the load_balancer_backend_info field, not used in new tests. This field is a member of oneof_ step_info.
network	google.cloud.network_management_v1.types.NetworkInfo Display information of a Google Cloud network. This field is a member of oneof_ step_info.
gke_master	google.cloud.network_management_v1.types.GKEMasterInfo Display information of a Google Kubernetes Engine cluster master. This field is a member of oneof_ step_info.
cloud_sql_instance	google.cloud.network_management_v1.types.CloudSQLInstanceInfo Display information of a Cloud SQL instance. This field is a member of oneof_ step_info.
cloud_function	google.cloud.network_management_v1.types.CloudFunctionInfo Display information of a Cloud Function. This field is a member of oneof_ step_info.
app_engine_version	google.cloud.network_management_v1.types.AppEngineVersionInfo Display information of an App Engine service version. This field is a member of oneof_ step_info.
cloud_run_revision	google.cloud.network_management_v1.types.CloudRunRevisionInfo Display information of a Cloud Run revision. This field is a member of oneof_ step_info.
nat	google.cloud.network_management_v1.types.NatInfo Display information of a NAT. This field is a member of oneof_ step_info.
proxy_connection	google.cloud.network_management_v1.types.ProxyConnectionInfo Display information of a ProxyConnection. This field is a member of oneof_ step_info.
load_balancer_backend_info	google.cloud.network_management_v1.types.LoadBalancerBackendInfo Display information of a specific load balancer backend. This field is a member of oneof_ step_info.
storage_bucket	google.cloud.network_management_v1.types.StorageBucketInfo Display information of a Storage Bucket. Used only for return traces. This field is a member of oneof_ step_info.

Classes

State

State(value)

Type of states that are defined in the network state machine. Each step in the packet trace is in a specific state.

Values: STATE_UNSPECIFIED (0): Unspecified state. START_FROM_INSTANCE (1): Initial state: packet originating from a Compute Engine instance. An InstanceInfo is populated with starting instance information. START_FROM_INTERNET (2): Initial state: packet originating from the internet. The endpoint information is populated. START_FROM_GOOGLE_SERVICE (27): Initial state: packet originating from a Google service. The google_service information is populated. START_FROM_PRIVATE_NETWORK (3): Initial state: packet originating from a VPC or on-premises network with internal source IP. If the source is a VPC network visible to the user, a NetworkInfo is populated with details of the network. START_FROM_GKE_MASTER (21): Initial state: packet originating from a Google Kubernetes Engine cluster master. A GKEMasterInfo is populated with starting instance information. START_FROM_CLOUD_SQL_INSTANCE (22): Initial state: packet originating from a Cloud SQL instance. A CloudSQLInstanceInfo is populated with starting instance information. START_FROM_CLOUD_FUNCTION (23): Initial state: packet originating from a Cloud Function. A CloudFunctionInfo is populated with starting function information. START_FROM_APP_ENGINE_VERSION (25): Initial state: packet originating from an App Engine service version. An AppEngineVersionInfo is populated with starting version information. START_FROM_CLOUD_RUN_REVISION (26): Initial state: packet originating from a Cloud Run revision. A CloudRunRevisionInfo is populated with starting revision information. START_FROM_STORAGE_BUCKET (29): Initial state: packet originating from a Storage Bucket. Used only for return traces. The storage_bucket information is populated. START_FROM_PSC_PUBLISHED_SERVICE (30): Initial state: packet originating from a published service that uses Private Service Connect. Used only for return traces. APPLY_INGRESS_FIREWALL_RULE (4): Config checking state: verify ingress firewall rule. APPLY_EGRESS_FIREWALL_RULE (5): Config checking state: verify egress firewall rule. APPLY_ROUTE (6): Config checking state: verify route. APPLY_FORWARDING_RULE (7): Config checking state: match forwarding rule. ANALYZE_LOAD_BALANCER_BACKEND (28): Config checking state: verify load balancer backend configuration. SPOOFING_APPROVED (8): Config checking state: packet sent or received under foreign IP address and allowed. ARRIVE_AT_INSTANCE (9): Forwarding state: arriving at a Compute Engine instance. ARRIVE_AT_INTERNAL_LOAD_BALANCER (10): Forwarding state: arriving at a Compute Engine internal load balancer. ARRIVE_AT_EXTERNAL_LOAD_BALANCER (11): Forwarding state: arriving at a Compute Engine external load balancer. ARRIVE_AT_VPN_GATEWAY (12): Forwarding state: arriving at a Cloud VPN gateway. ARRIVE_AT_VPN_TUNNEL (13): Forwarding state: arriving at a Cloud VPN tunnel. ARRIVE_AT_VPC_CONNECTOR (24): Forwarding state: arriving at a VPC connector. NAT (14): Transition state: packet header translated. PROXY_CONNECTION (15): Transition state: original connection is terminated and a new proxied connection is initiated. DELIVER (16): Final state: packet could be delivered. DROP (17): Final state: packet could be dropped. FORWARD (18): Final state: packet could be forwarded to a network with an unknown configuration. ABORT (19): Final state: analysis is aborted. VIEWER_PERMISSION_MISSING (20): Special state: viewer of the test result does not have permission to see the configuration in this step.