Class Step (1.20.0)

public final class Step extends GeneratedMessageV3 implements StepOrBuilder

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

Protobuf type google.cloud.networkmanagement.v1.Step

Implements

StepOrBuilder

Static Fields

ABORT_FIELD_NUMBER

public static final int ABORT_FIELD_NUMBER
Field Value
TypeDescription
int

CAUSES_DROP_FIELD_NUMBER

public static final int CAUSES_DROP_FIELD_NUMBER
Field Value
TypeDescription
int

CLOUD_SQL_INSTANCE_FIELD_NUMBER

public static final int CLOUD_SQL_INSTANCE_FIELD_NUMBER
Field Value
TypeDescription
int

DELIVER_FIELD_NUMBER

public static final int DELIVER_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DROP_FIELD_NUMBER

public static final int DROP_FIELD_NUMBER
Field Value
TypeDescription
int

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

FIREWALL_FIELD_NUMBER

public static final int FIREWALL_FIELD_NUMBER
Field Value
TypeDescription
int

FORWARDING_RULE_FIELD_NUMBER

public static final int FORWARDING_RULE_FIELD_NUMBER
Field Value
TypeDescription
int

FORWARD_FIELD_NUMBER

public static final int FORWARD_FIELD_NUMBER
Field Value
TypeDescription
int

GKE_MASTER_FIELD_NUMBER

public static final int GKE_MASTER_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
TypeDescription
int

LOAD_BALANCER_FIELD_NUMBER

public static final int LOAD_BALANCER_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

ROUTE_FIELD_NUMBER

public static final int ROUTE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

VPN_GATEWAY_FIELD_NUMBER

public static final int VPN_GATEWAY_FIELD_NUMBER
Field Value
TypeDescription
int

VPN_TUNNEL_FIELD_NUMBER

public static final int VPN_TUNNEL_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Step getDefaultInstance()
Returns
TypeDescription
Step

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Step.Builder newBuilder()
Returns
TypeDescription
Step.Builder

newBuilder(Step prototype)

public static Step.Builder newBuilder(Step prototype)
Parameter
NameDescription
prototypeStep
Returns
TypeDescription
Step.Builder

parseDelimitedFrom(InputStream input)

public static Step parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Step
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Step parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Step
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Step parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Step
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Step parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Step
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Step parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Step
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Step parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Step
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Step parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Step
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Step parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Step
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Step parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Step
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Step parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Step
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Step parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Step
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Step parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Step
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Step> parser()
Returns
TypeDescription
Parser<Step>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAbort()

public AbortInfo getAbort()

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

.google.cloud.networkmanagement.v1.AbortInfo abort = 14;

Returns
TypeDescription
AbortInfo

The abort.

getAbortOrBuilder()

public AbortInfoOrBuilder getAbortOrBuilder()

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

.google.cloud.networkmanagement.v1.AbortInfo abort = 14;

Returns
TypeDescription
AbortInfoOrBuilder

getCausesDrop()

public boolean getCausesDrop()

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

bool causes_drop = 3;

Returns
TypeDescription
boolean

The causesDrop.

getCloudSqlInstance()

public CloudSQLInstanceInfo getCloudSqlInstance()

Display information of a Cloud SQL instance.

.google.cloud.networkmanagement.v1.CloudSQLInstanceInfo cloud_sql_instance = 19;

Returns
TypeDescription
CloudSQLInstanceInfo

The cloudSqlInstance.

getCloudSqlInstanceOrBuilder()

public CloudSQLInstanceInfoOrBuilder getCloudSqlInstanceOrBuilder()

Display information of a Cloud SQL instance.

.google.cloud.networkmanagement.v1.CloudSQLInstanceInfo cloud_sql_instance = 19;

Returns
TypeDescription
CloudSQLInstanceInfoOrBuilder

getDefaultInstanceForType()

public Step getDefaultInstanceForType()
Returns
TypeDescription
Step

getDeliver()

public DeliverInfo getDeliver()

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

.google.cloud.networkmanagement.v1.DeliverInfo deliver = 12;

Returns
TypeDescription
DeliverInfo

The deliver.

getDeliverOrBuilder()

public DeliverInfoOrBuilder getDeliverOrBuilder()

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

.google.cloud.networkmanagement.v1.DeliverInfo deliver = 12;

Returns
TypeDescription
DeliverInfoOrBuilder

getDescription()

public String getDescription()

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

string description = 1;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 1;

Returns
TypeDescription
ByteString

The bytes for description.

getDrop()

public DropInfo getDrop()

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

.google.cloud.networkmanagement.v1.DropInfo drop = 15;

Returns
TypeDescription
DropInfo

The drop.

getDropOrBuilder()

public DropInfoOrBuilder getDropOrBuilder()

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

.google.cloud.networkmanagement.v1.DropInfo drop = 15;

Returns
TypeDescription
DropInfoOrBuilder

getEndpoint()

public EndpointInfo 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.

.google.cloud.networkmanagement.v1.EndpointInfo endpoint = 8;

Returns
TypeDescription
EndpointInfo

The endpoint.

getEndpointOrBuilder()

public EndpointInfoOrBuilder getEndpointOrBuilder()

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.cloud.networkmanagement.v1.EndpointInfo endpoint = 8;

Returns
TypeDescription
EndpointInfoOrBuilder

getFirewall()

public FirewallInfo getFirewall()

Display information of a Compute Engine firewall rule.

.google.cloud.networkmanagement.v1.FirewallInfo firewall = 6;

Returns
TypeDescription
FirewallInfo

The firewall.

getFirewallOrBuilder()

public FirewallInfoOrBuilder getFirewallOrBuilder()

Display information of a Compute Engine firewall rule.

.google.cloud.networkmanagement.v1.FirewallInfo firewall = 6;

Returns
TypeDescription
FirewallInfoOrBuilder

getForward()

public ForwardInfo getForward()

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

.google.cloud.networkmanagement.v1.ForwardInfo forward = 13;

Returns
TypeDescription
ForwardInfo

The forward.

getForwardOrBuilder()

public ForwardInfoOrBuilder getForwardOrBuilder()

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

.google.cloud.networkmanagement.v1.ForwardInfo forward = 13;

Returns
TypeDescription
ForwardInfoOrBuilder

getForwardingRule()

public ForwardingRuleInfo getForwardingRule()

Display information of a Compute Engine forwarding rule.

.google.cloud.networkmanagement.v1.ForwardingRuleInfo forwarding_rule = 9;

Returns
TypeDescription
ForwardingRuleInfo

The forwardingRule.

getForwardingRuleOrBuilder()

public ForwardingRuleInfoOrBuilder getForwardingRuleOrBuilder()

Display information of a Compute Engine forwarding rule.

.google.cloud.networkmanagement.v1.ForwardingRuleInfo forwarding_rule = 9;

Returns
TypeDescription
ForwardingRuleInfoOrBuilder

getGkeMaster()

public GKEMasterInfo getGkeMaster()

Display information of a Google Kubernetes Engine cluster master.

.google.cloud.networkmanagement.v1.GKEMasterInfo gke_master = 18;

Returns
TypeDescription
GKEMasterInfo

The gkeMaster.

getGkeMasterOrBuilder()

public GKEMasterInfoOrBuilder getGkeMasterOrBuilder()

Display information of a Google Kubernetes Engine cluster master.

.google.cloud.networkmanagement.v1.GKEMasterInfo gke_master = 18;

Returns
TypeDescription
GKEMasterInfoOrBuilder

getInstance()

public InstanceInfo getInstance()

Display information of a Compute Engine instance.

.google.cloud.networkmanagement.v1.InstanceInfo instance = 5;

Returns
TypeDescription
InstanceInfo

The instance.

getInstanceOrBuilder()

public InstanceInfoOrBuilder getInstanceOrBuilder()

Display information of a Compute Engine instance.

.google.cloud.networkmanagement.v1.InstanceInfo instance = 5;

Returns
TypeDescription
InstanceInfoOrBuilder

getLoadBalancer()

public LoadBalancerInfo getLoadBalancer()

Display information of the load balancers.

.google.cloud.networkmanagement.v1.LoadBalancerInfo load_balancer = 16;

Returns
TypeDescription
LoadBalancerInfo

The loadBalancer.

getLoadBalancerOrBuilder()

public LoadBalancerInfoOrBuilder getLoadBalancerOrBuilder()

Display information of the load balancers.

.google.cloud.networkmanagement.v1.LoadBalancerInfo load_balancer = 16;

Returns
TypeDescription
LoadBalancerInfoOrBuilder

getNetwork()

public NetworkInfo getNetwork()

Display information of a Google Cloud network.

.google.cloud.networkmanagement.v1.NetworkInfo network = 17;

Returns
TypeDescription
NetworkInfo

The network.

getNetworkOrBuilder()

public NetworkInfoOrBuilder getNetworkOrBuilder()

Display information of a Google Cloud network.

.google.cloud.networkmanagement.v1.NetworkInfo network = 17;

Returns
TypeDescription
NetworkInfoOrBuilder

getParserForType()

public Parser<Step> getParserForType()
Returns
TypeDescription
Parser<Step>
Overrides

getProjectId()

public String getProjectId()

Project ID that contains the configuration this step is validating.

string project_id = 4;

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Project ID that contains the configuration this step is validating.

string project_id = 4;

Returns
TypeDescription
ByteString

The bytes for projectId.

getRoute()

public RouteInfo getRoute()

Display information of a Compute Engine route.

.google.cloud.networkmanagement.v1.RouteInfo route = 7;

Returns
TypeDescription
RouteInfo

The route.

getRouteOrBuilder()

public RouteInfoOrBuilder getRouteOrBuilder()

Display information of a Compute Engine route.

.google.cloud.networkmanagement.v1.RouteInfo route = 7;

Returns
TypeDescription
RouteInfoOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public Step.State getState()

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

.google.cloud.networkmanagement.v1.Step.State state = 2;

Returns
TypeDescription
Step.State

The state.

getStateValue()

public int getStateValue()

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

.google.cloud.networkmanagement.v1.Step.State state = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getStepInfoCase()

public Step.StepInfoCase getStepInfoCase()
Returns
TypeDescription
Step.StepInfoCase

getVpnGateway()

public VpnGatewayInfo getVpnGateway()

Display information of a Compute Engine VPN gateway.

.google.cloud.networkmanagement.v1.VpnGatewayInfo vpn_gateway = 10;

Returns
TypeDescription
VpnGatewayInfo

The vpnGateway.

getVpnGatewayOrBuilder()

public VpnGatewayInfoOrBuilder getVpnGatewayOrBuilder()

Display information of a Compute Engine VPN gateway.

.google.cloud.networkmanagement.v1.VpnGatewayInfo vpn_gateway = 10;

Returns
TypeDescription
VpnGatewayInfoOrBuilder

getVpnTunnel()

public VpnTunnelInfo getVpnTunnel()

Display information of a Compute Engine VPN tunnel.

.google.cloud.networkmanagement.v1.VpnTunnelInfo vpn_tunnel = 11;

Returns
TypeDescription
VpnTunnelInfo

The vpnTunnel.

getVpnTunnelOrBuilder()

public VpnTunnelInfoOrBuilder getVpnTunnelOrBuilder()

Display information of a Compute Engine VPN tunnel.

.google.cloud.networkmanagement.v1.VpnTunnelInfo vpn_tunnel = 11;

Returns
TypeDescription
VpnTunnelInfoOrBuilder

hasAbort()

public boolean hasAbort()

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

.google.cloud.networkmanagement.v1.AbortInfo abort = 14;

Returns
TypeDescription
boolean

Whether the abort field is set.

hasCloudSqlInstance()

public boolean hasCloudSqlInstance()

Display information of a Cloud SQL instance.

.google.cloud.networkmanagement.v1.CloudSQLInstanceInfo cloud_sql_instance = 19;

Returns
TypeDescription
boolean

Whether the cloudSqlInstance field is set.

hasDeliver()

public boolean hasDeliver()

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

.google.cloud.networkmanagement.v1.DeliverInfo deliver = 12;

Returns
TypeDescription
boolean

Whether the deliver field is set.

hasDrop()

public boolean hasDrop()

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

.google.cloud.networkmanagement.v1.DropInfo drop = 15;

Returns
TypeDescription
boolean

Whether the drop field is set.

hasEndpoint()

public boolean hasEndpoint()

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.cloud.networkmanagement.v1.EndpointInfo endpoint = 8;

Returns
TypeDescription
boolean

Whether the endpoint field is set.

hasFirewall()

public boolean hasFirewall()

Display information of a Compute Engine firewall rule.

.google.cloud.networkmanagement.v1.FirewallInfo firewall = 6;

Returns
TypeDescription
boolean

Whether the firewall field is set.

hasForward()

public boolean hasForward()

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

.google.cloud.networkmanagement.v1.ForwardInfo forward = 13;

Returns
TypeDescription
boolean

Whether the forward field is set.

hasForwardingRule()

public boolean hasForwardingRule()

Display information of a Compute Engine forwarding rule.

.google.cloud.networkmanagement.v1.ForwardingRuleInfo forwarding_rule = 9;

Returns
TypeDescription
boolean

Whether the forwardingRule field is set.

hasGkeMaster()

public boolean hasGkeMaster()

Display information of a Google Kubernetes Engine cluster master.

.google.cloud.networkmanagement.v1.GKEMasterInfo gke_master = 18;

Returns
TypeDescription
boolean

Whether the gkeMaster field is set.

hasInstance()

public boolean hasInstance()

Display information of a Compute Engine instance.

.google.cloud.networkmanagement.v1.InstanceInfo instance = 5;

Returns
TypeDescription
boolean

Whether the instance field is set.

hasLoadBalancer()

public boolean hasLoadBalancer()

Display information of the load balancers.

.google.cloud.networkmanagement.v1.LoadBalancerInfo load_balancer = 16;

Returns
TypeDescription
boolean

Whether the loadBalancer field is set.

hasNetwork()

public boolean hasNetwork()

Display information of a Google Cloud network.

.google.cloud.networkmanagement.v1.NetworkInfo network = 17;

Returns
TypeDescription
boolean

Whether the network field is set.

hasRoute()

public boolean hasRoute()

Display information of a Compute Engine route.

.google.cloud.networkmanagement.v1.RouteInfo route = 7;

Returns
TypeDescription
boolean

Whether the route field is set.

hasVpnGateway()

public boolean hasVpnGateway()

Display information of a Compute Engine VPN gateway.

.google.cloud.networkmanagement.v1.VpnGatewayInfo vpn_gateway = 10;

Returns
TypeDescription
boolean

Whether the vpnGateway field is set.

hasVpnTunnel()

public boolean hasVpnTunnel()

Display information of a Compute Engine VPN tunnel.

.google.cloud.networkmanagement.v1.VpnTunnelInfo vpn_tunnel = 11;

Returns
TypeDescription
boolean

Whether the vpnTunnel field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Step.Builder newBuilderForType()
Returns
TypeDescription
Step.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Step.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Step.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Step.Builder toBuilder()
Returns
TypeDescription
Step.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException