Google Cloud Network Management V1 Client - Class Step (2.1.0)

Version 2.1.0

• 2.1.1 (latest)
• 2.1.0
• 2.0.1
• 1.7.3
• 1.5.0
• 1.4.2
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.5

Reference documentation and code samples for the Google Cloud Network Management V1 Client class Step.

A simulated forwarding path is composed of multiple steps.

Each step has a well-defined state and an associated configuration.

Generated from protobuf message google.cloud.networkmanagement.v1.Step

Namespace

Google \ Cloud \ NetworkManagement \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ description	string A description of the step. Usually this is a summary of the state.
↳ state	int 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	string Project ID that contains the configuration this step is validating.
↳ instance	Google\Cloud\NetworkManagement\V1\InstanceInfo Display information of a Compute Engine instance.
↳ firewall	Google\Cloud\NetworkManagement\V1\FirewallInfo Display information of a Compute Engine firewall rule.
↳ route	Google\Cloud\NetworkManagement\V1\RouteInfo Display information of a Compute Engine route.
↳ endpoint	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.
↳ google_service	Google\Cloud\NetworkManagement\V1\GoogleServiceInfo Display information of a Google service
↳ forwarding_rule	Google\Cloud\NetworkManagement\V1\ForwardingRuleInfo Display information of a Compute Engine forwarding rule.
↳ vpn_gateway	Google\Cloud\NetworkManagement\V1\VpnGatewayInfo Display information of a Compute Engine VPN gateway.
↳ vpn_tunnel	Google\Cloud\NetworkManagement\V1\VpnTunnelInfo Display information of a Compute Engine VPN tunnel.
↳ vpc_connector	Google\Cloud\NetworkManagement\V1\VpcConnectorInfo Display information of a VPC connector.
↳ deliver	Google\Cloud\NetworkManagement\V1\DeliverInfo Display information of the final state "deliver" and reason.
↳ forward	Google\Cloud\NetworkManagement\V1\ForwardInfo Display information of the final state "forward" and reason.
↳ abort	Google\Cloud\NetworkManagement\V1\AbortInfo Display information of the final state "abort" and reason.
↳ drop	Google\Cloud\NetworkManagement\V1\DropInfo Display information of the final state "drop" and reason.
↳ load_balancer	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.
↳ network	Google\Cloud\NetworkManagement\V1\NetworkInfo Display information of a Google Cloud network.
↳ gke_master	Google\Cloud\NetworkManagement\V1\GKEMasterInfo Display information of a Google Kubernetes Engine cluster master.
↳ cloud_sql_instance	Google\Cloud\NetworkManagement\V1\CloudSQLInstanceInfo Display information of a Cloud SQL instance.
↳ redis_instance	Google\Cloud\NetworkManagement\V1\RedisInstanceInfo Display information of a Redis Instance.
↳ redis_cluster	Google\Cloud\NetworkManagement\V1\RedisClusterInfo Display information of a Redis Cluster.
↳ cloud_function	Google\Cloud\NetworkManagement\V1\CloudFunctionInfo Display information of a Cloud Function.
↳ app_engine_version	Google\Cloud\NetworkManagement\V1\AppEngineVersionInfo Display information of an App Engine service version.
↳ cloud_run_revision	Google\Cloud\NetworkManagement\V1\CloudRunRevisionInfo Display information of a Cloud Run revision.
↳ nat	Google\Cloud\NetworkManagement\V1\NatInfo Display information of a NAT.
↳ proxy_connection	Google\Cloud\NetworkManagement\V1\ProxyConnectionInfo Display information of a ProxyConnection.
↳ load_balancer_backend_info	Google\Cloud\NetworkManagement\V1\LoadBalancerBackendInfo Display information of a specific load balancer backend.
↳ storage_bucket	Google\Cloud\NetworkManagement\V1\StorageBucketInfo Display information of a Storage Bucket. Used only for return traces.
↳ serverless_neg	Google\Cloud\NetworkManagement\V1\ServerlessNegInfo Display information of a Serverless network endpoint group backend. Used only for return traces.

getDescription

A description of the step. Usually this is a summary of the state.

Returns
Type	Description
string

setDescription

A description of the step. Usually this is a summary of the state.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getState

Each step is in one of the pre-defined states.

Returns
Type	Description
int

setState

Each step is in one of the pre-defined states.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getCausesDrop

This is a step that leads to the final state Drop.

Returns
Type	Description
bool

setCausesDrop

This is a step that leads to the final state Drop.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getProjectId

Project ID that contains the configuration this step is validating.

Returns
Type	Description
string

setProjectId

Project ID that contains the configuration this step is validating.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getInstance

Display information of a Compute Engine instance.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\InstanceInfo|null

hasInstance

setInstance

Display information of a Compute Engine instance.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\InstanceInfo

Returns
Type	Description
$this

getFirewall

Display information of a Compute Engine firewall rule.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\FirewallInfo|null

hasFirewall

setFirewall

Display information of a Compute Engine firewall rule.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\FirewallInfo

Returns
Type	Description
$this

getRoute

Display information of a Compute Engine route.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\RouteInfo|null

hasRoute

setRoute

Display information of a Compute Engine route.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\RouteInfo

Returns
Type	Description
$this

getEndpoint

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
Type	Description
Google\Cloud\NetworkManagement\V1\EndpointInfo|null

hasEndpoint

setEndpoint

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.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\EndpointInfo

Returns
Type	Description
$this

getGoogleService

Display information of a Google service

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\GoogleServiceInfo|null

hasGoogleService

setGoogleService

Display information of a Google service

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\GoogleServiceInfo

Returns
Type	Description
$this

getForwardingRule

Display information of a Compute Engine forwarding rule.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\ForwardingRuleInfo|null

hasForwardingRule

setForwardingRule

Display information of a Compute Engine forwarding rule.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\ForwardingRuleInfo

Returns
Type	Description
$this

getVpnGateway

Display information of a Compute Engine VPN gateway.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\VpnGatewayInfo|null

hasVpnGateway

setVpnGateway

Display information of a Compute Engine VPN gateway.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\VpnGatewayInfo

Returns
Type	Description
$this

getVpnTunnel

Display information of a Compute Engine VPN tunnel.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\VpnTunnelInfo|null

hasVpnTunnel

setVpnTunnel

Display information of a Compute Engine VPN tunnel.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\VpnTunnelInfo

Returns
Type	Description
$this

getVpcConnector

Display information of a VPC connector.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\VpcConnectorInfo|null

hasVpcConnector

setVpcConnector

Display information of a VPC connector.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\VpcConnectorInfo

Returns
Type	Description
$this

getDeliver

Display information of the final state "deliver" and reason.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\DeliverInfo|null

hasDeliver

setDeliver

Display information of the final state "deliver" and reason.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\DeliverInfo

Returns
Type	Description
$this

getForward

Display information of the final state "forward" and reason.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\ForwardInfo|null

hasForward

setForward

Display information of the final state "forward" and reason.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\ForwardInfo

Returns
Type	Description
$this

getAbort

Display information of the final state "abort" and reason.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\AbortInfo|null

hasAbort

setAbort

Display information of the final state "abort" and reason.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\AbortInfo

Returns
Type	Description
$this

getDrop

Display information of the final state "drop" and reason.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\DropInfo|null

hasDrop

setDrop

Display information of the final state "drop" and reason.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\DropInfo

Returns
Type	Description
$this

getLoadBalancer

Display information of the load balancers. Deprecated in favor of the load_balancer_backend_info field, not used in new tests.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\LoadBalancerInfo|null

hasLoadBalancer

setLoadBalancer

Display information of the load balancers. Deprecated in favor of the load_balancer_backend_info field, not used in new tests.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\LoadBalancerInfo

Returns
Type	Description
$this

getNetwork

Display information of a Google Cloud network.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\NetworkInfo|null

hasNetwork

setNetwork

Display information of a Google Cloud network.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\NetworkInfo

Returns
Type	Description
$this

getGkeMaster

Display information of a Google Kubernetes Engine cluster master.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\GKEMasterInfo|null

hasGkeMaster

setGkeMaster

Display information of a Google Kubernetes Engine cluster master.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\GKEMasterInfo

Returns
Type	Description
$this

getCloudSqlInstance

Display information of a Cloud SQL instance.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\CloudSQLInstanceInfo|null

hasCloudSqlInstance

setCloudSqlInstance

Display information of a Cloud SQL instance.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\CloudSQLInstanceInfo

Returns
Type	Description
$this

getRedisInstance

Display information of a Redis Instance.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\RedisInstanceInfo|null

hasRedisInstance

setRedisInstance

Display information of a Redis Instance.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\RedisInstanceInfo

Returns
Type	Description
$this

getRedisCluster

Display information of a Redis Cluster.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\RedisClusterInfo|null

hasRedisCluster

setRedisCluster

Display information of a Redis Cluster.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\RedisClusterInfo

Returns
Type	Description
$this

getCloudFunction

Display information of a Cloud Function.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\CloudFunctionInfo|null

hasCloudFunction

setCloudFunction

Display information of a Cloud Function.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\CloudFunctionInfo

Returns
Type	Description
$this

getAppEngineVersion

Display information of an App Engine service version.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\AppEngineVersionInfo|null

hasAppEngineVersion

setAppEngineVersion

Display information of an App Engine service version.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\AppEngineVersionInfo

Returns
Type	Description
$this

getCloudRunRevision

Display information of a Cloud Run revision.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\CloudRunRevisionInfo|null

hasCloudRunRevision

setCloudRunRevision

Display information of a Cloud Run revision.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\CloudRunRevisionInfo

Returns
Type	Description
$this

getNat

Display information of a NAT.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\NatInfo|null

hasNat

setNat

Display information of a NAT.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\NatInfo

Returns
Type	Description
$this

getProxyConnection

Display information of a ProxyConnection.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\ProxyConnectionInfo|null

hasProxyConnection

setProxyConnection

Display information of a ProxyConnection.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\ProxyConnectionInfo

Returns
Type	Description
$this

getLoadBalancerBackendInfo

Display information of a specific load balancer backend.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\LoadBalancerBackendInfo|null

hasLoadBalancerBackendInfo

setLoadBalancerBackendInfo

Display information of a specific load balancer backend.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\LoadBalancerBackendInfo

Returns
Type	Description
$this

getStorageBucket

Display information of a Storage Bucket. Used only for return traces.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\StorageBucketInfo|null

hasStorageBucket

setStorageBucket

Display information of a Storage Bucket. Used only for return traces.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\StorageBucketInfo

Returns
Type	Description
$this

getServerlessNeg

Display information of a Serverless network endpoint group backend. Used only for return traces.

Returns
Type	Description
Google\Cloud\NetworkManagement\V1\ServerlessNegInfo|null

hasServerlessNeg

setServerlessNeg

Display information of a Serverless network endpoint group backend. Used only for return traces.

Parameter
Name	Description
var	Google\Cloud\NetworkManagement\V1\ServerlessNegInfo

Returns
Type	Description
$this

getStepInfo

Returns
Type	Description
string