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 \ V1Methods
__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. |
↳ 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. |
↳ 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. |
↳ 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. |
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 | |
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 | |
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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\NetworkManagement\V1\LoadBalancerInfo|null | |
hasLoadBalancer
setLoadBalancer
Display information of the load balancers.
| 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 | |
getStepInfo
| Returns | |
|---|---|
| Type | Description |
string | |