Console
    Contact Us Start free

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

    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
    InstanceInfo

    Display information of a Compute Engine instance.

    ↳ firewall
    FirewallInfo

    Display information of a Compute Engine firewall rule.

    ↳ route
    RouteInfo

    Display information of a Compute Engine route.

    ↳ endpoint
    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
    GoogleServiceInfo

    Display information of a Google service

    ↳ forwarding_rule
    ForwardingRuleInfo

    Display information of a Compute Engine forwarding rule.

    ↳ vpn_gateway
    VpnGatewayInfo

    Display information of a Compute Engine VPN gateway.

    ↳ vpn_tunnel
    VpnTunnelInfo

    Display information of a Compute Engine VPN tunnel.

    ↳ vpc_connector
    VpcConnectorInfo

    Display information of a VPC connector.

    ↳ direct_vpc_egress_connection
    DirectVpcEgressConnectionInfo

    Display information of a serverless direct VPC egress connection.

    ↳ serverless_external_connection
    ServerlessExternalConnectionInfo

    Display information of a serverless public (external) connection.

    ↳ deliver
    DeliverInfo

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

    ↳ forward
    ForwardInfo

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

    ↳ abort
    AbortInfo

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

    ↳ drop
    DropInfo

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

    ↳ load_balancer
    LoadBalancerInfo

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

    ↳ network
    NetworkInfo

    Display information of a Google Cloud network.

    ↳ gke_master
    GKEMasterInfo

    Display information of a Google Kubernetes Engine cluster master.

    ↳ cloud_sql_instance
    CloudSQLInstanceInfo

    Display information of a Cloud SQL instance.

    ↳ redis_instance
    RedisInstanceInfo

    Display information of a Redis Instance.

    ↳ redis_cluster
    RedisClusterInfo

    Display information of a Redis Cluster.

    ↳ cloud_function
    CloudFunctionInfo

    Display information of a Cloud Function.

    ↳ app_engine_version
    AppEngineVersionInfo

    Display information of an App Engine service version.

    ↳ cloud_run_revision
    CloudRunRevisionInfo

    Display information of a Cloud Run revision.

    ↳ nat
    NatInfo

    Display information of a NAT.

    ↳ proxy_connection
    ProxyConnectionInfo

    Display information of a ProxyConnection.

    ↳ load_balancer_backend_info
    LoadBalancerBackendInfo

    Display information of a specific load balancer backend.

    ↳ storage_bucket
    StorageBucketInfo

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

    ↳ serverless_neg
    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
    InstanceInfo |null

    hasInstance

    setInstance

    Display information of a Compute Engine instance.

    Parameter
    Name
    Description
    var
    InstanceInfo
    Returns
    Type
    Description
    $this

    getFirewall

    Display information of a Compute Engine firewall rule.

    Returns
    Type
    Description
    FirewallInfo |null

    hasFirewall

    setFirewall

    Display information of a Compute Engine firewall rule.

    Parameter
    Name
    Description
    var
    FirewallInfo
    Returns
    Type
    Description
    $this

    getRoute

    Display information of a Compute Engine route.

    Returns
    Type
    Description
    RouteInfo |null

    hasRoute

    setRoute

    Display information of a Compute Engine route.

    Parameter
    Name
    Description
    var
    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
    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
    EndpointInfo
    Returns
    Type
    Description
    $this

    getGoogleService

    Display information of a Google service

    Returns
    Type
    Description
    GoogleServiceInfo |null

    hasGoogleService

    setGoogleService

    Display information of a Google service

    Parameter
    Name
    Description
    var
    GoogleServiceInfo
    Returns
    Type
    Description
    $this

    getForwardingRule

    Display information of a Compute Engine forwarding rule.

    Returns
    Type
    Description
    ForwardingRuleInfo |null

    hasForwardingRule

    setForwardingRule

    Display information of a Compute Engine forwarding rule.

    Parameter
    Name
    Description
    var
    ForwardingRuleInfo
    Returns
    Type
    Description
    $this

    getVpnGateway

    Display information of a Compute Engine VPN gateway.

    Returns
    Type
    Description
    VpnGatewayInfo |null

    hasVpnGateway

    setVpnGateway

    Display information of a Compute Engine VPN gateway.

    Parameter
    Name
    Description
    var
    VpnGatewayInfo
    Returns
    Type
    Description
    $this

    getVpnTunnel

    Display information of a Compute Engine VPN tunnel.

    Returns
    Type
    Description
    VpnTunnelInfo |null

    hasVpnTunnel

    setVpnTunnel

    Display information of a Compute Engine VPN tunnel.

    Parameter
    Name
    Description
    var
    VpnTunnelInfo
    Returns
    Type
    Description
    $this

    getVpcConnector

    Display information of a VPC connector.

    Returns
    Type
    Description
    VpcConnectorInfo |null

    hasVpcConnector

    setVpcConnector

    Display information of a VPC connector.

    Parameter
    Name
    Description
    var
    VpcConnectorInfo
    Returns
    Type
    Description
    $this

    getDirectVpcEgressConnection

    Display information of a serverless direct VPC egress connection.

    Returns
    Type
    Description
    DirectVpcEgressConnectionInfo |null

    hasDirectVpcEgressConnection

    setDirectVpcEgressConnection

    Display information of a serverless direct VPC egress connection.

    Parameter
    Name
    Description
    var
    DirectVpcEgressConnectionInfo
    Returns
    Type
    Description
    $this

    getServerlessExternalConnection

    Display information of a serverless public (external) connection.

    Returns
    Type
    Description
    ServerlessExternalConnectionInfo |null

    hasServerlessExternalConnection

    setServerlessExternalConnection

    Display information of a serverless public (external) connection.

    Parameter
    Name
    Description
    var
    ServerlessExternalConnectionInfo
    Returns
    Type
    Description
    $this

    getDeliver

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

    Returns
    Type
    Description
    DeliverInfo |null

    hasDeliver

    setDeliver

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

    Parameter
    Name
    Description
    var
    DeliverInfo
    Returns
    Type
    Description
    $this

    getForward

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

    Returns
    Type
    Description
    ForwardInfo |null

    hasForward

    setForward

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

    Parameter
    Name
    Description
    var
    ForwardInfo
    Returns
    Type
    Description
    $this

    getAbort

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

    Returns
    Type
    Description
    AbortInfo |null

    hasAbort

    setAbort

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

    Parameter
    Name
    Description
    var
    AbortInfo
    Returns
    Type
    Description
    $this

    getDrop

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

    Returns
    Type
    Description
    DropInfo |null

    hasDrop

    setDrop

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

    Parameter
    Name
    Description
    var
    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
    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
    LoadBalancerInfo
    Returns
    Type
    Description
    $this

    getNetwork

    Display information of a Google Cloud network.

    Returns
    Type
    Description
    NetworkInfo |null

    hasNetwork

    setNetwork

    Display information of a Google Cloud network.

    Parameter
    Name
    Description
    var
    NetworkInfo
    Returns
    Type
    Description
    $this

    getGkeMaster

    Display information of a Google Kubernetes Engine cluster master.

    Returns
    Type
    Description
    GKEMasterInfo |null

    hasGkeMaster

    setGkeMaster

    Display information of a Google Kubernetes Engine cluster master.

    Parameter
    Name
    Description
    var
    GKEMasterInfo
    Returns
    Type
    Description
    $this

    getCloudSqlInstance

    Display information of a Cloud SQL instance.

    Returns
    Type
    Description
    CloudSQLInstanceInfo |null

    hasCloudSqlInstance

    setCloudSqlInstance

    Display information of a Cloud SQL instance.

    Parameter
    Name
    Description
    var
    CloudSQLInstanceInfo
    Returns
    Type
    Description
    $this

    getRedisInstance

    Display information of a Redis Instance.

    Returns
    Type
    Description
    RedisInstanceInfo |null

    hasRedisInstance

    setRedisInstance

    Display information of a Redis Instance.

    Parameter
    Name
    Description
    var
    RedisInstanceInfo
    Returns
    Type
    Description
    $this

    getRedisCluster

    Display information of a Redis Cluster.

    Returns
    Type
    Description
    RedisClusterInfo |null

    hasRedisCluster

    setRedisCluster

    Display information of a Redis Cluster.

    Parameter
    Name
    Description
    var
    RedisClusterInfo
    Returns
    Type
    Description
    $this

    getCloudFunction

    Display information of a Cloud Function.

    Returns
    Type
    Description
    CloudFunctionInfo |null

    hasCloudFunction

    setCloudFunction

    Display information of a Cloud Function.

    Parameter
    Name
    Description
    var
    CloudFunctionInfo
    Returns
    Type
    Description
    $this

    getAppEngineVersion

    Display information of an App Engine service version.

    Returns
    Type
    Description
    AppEngineVersionInfo |null

    hasAppEngineVersion

    setAppEngineVersion

    Display information of an App Engine service version.

    Parameter
    Name
    Description
    var
    AppEngineVersionInfo
    Returns
    Type
    Description
    $this

    getCloudRunRevision

    Display information of a Cloud Run revision.

    Returns
    Type
    Description
    CloudRunRevisionInfo |null

    hasCloudRunRevision

    setCloudRunRevision

    Display information of a Cloud Run revision.

    Parameter
    Name
    Description
    var
    CloudRunRevisionInfo
    Returns
    Type
    Description
    $this

    getNat

    Display information of a NAT.

    Returns
    Type
    Description
    NatInfo |null

    hasNat

    setNat

    Display information of a NAT.

    Parameter
    Name
    Description
    var
    NatInfo
    Returns
    Type
    Description
    $this

    getProxyConnection

    Display information of a ProxyConnection.

    Returns
    Type
    Description
    ProxyConnectionInfo |null

    hasProxyConnection

    setProxyConnection

    Display information of a ProxyConnection.

    Parameter
    Name
    Description
    var
    ProxyConnectionInfo
    Returns
    Type
    Description
    $this

    getLoadBalancerBackendInfo

    Display information of a specific load balancer backend.

    Returns
    Type
    Description
    LoadBalancerBackendInfo |null

    hasLoadBalancerBackendInfo

    setLoadBalancerBackendInfo

    Display information of a specific load balancer backend.

    Parameter
    Name
    Description
    var
    LoadBalancerBackendInfo
    Returns
    Type
    Description
    $this

    getStorageBucket

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

    Returns
    Type
    Description
    StorageBucketInfo |null

    hasStorageBucket

    setStorageBucket

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

    Parameter
    Name
    Description
    var
    StorageBucketInfo
    Returns
    Type
    Description
    $this

    getServerlessNeg

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

    Returns
    Type
    Description
    ServerlessNegInfo |null

    hasServerlessNeg

    setServerlessNeg

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

    Parameter
    Name
    Description
    var
    ServerlessNegInfo
    Returns
    Type
    Description
    $this

    getStepInfo

    Returns
    Type
    Description
    string
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: