Class ProbingDetails (1.56.0)

public final class ProbingDetails extends GeneratedMessageV3 implements ProbingDetailsOrBuilder

Results of active probing from the last run of the test.

Protobuf type google.cloud.networkmanagement.v1.ProbingDetails

Static Fields

ABORT_CAUSE_FIELD_NUMBER

public static final int ABORT_CAUSE_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_EGRESS_LOCATION_FIELD_NUMBER

public static final int DESTINATION_EGRESS_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

ENDPOINT_INFO_FIELD_NUMBER

public static final int ENDPOINT_INFO_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

PROBING_LATENCY_FIELD_NUMBER

public static final int PROBING_LATENCY_FIELD_NUMBER
Field Value
Type Description
int

RESULT_FIELD_NUMBER

public static final int RESULT_FIELD_NUMBER
Field Value
Type Description
int

SENT_PROBE_COUNT_FIELD_NUMBER

public static final int SENT_PROBE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SUCCESSFUL_PROBE_COUNT_FIELD_NUMBER

public static final int SUCCESSFUL_PROBE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

VERIFY_TIME_FIELD_NUMBER

public static final int VERIFY_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ProbingDetails getDefaultInstance()
Returns
Type Description
ProbingDetails

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ProbingDetails.Builder newBuilder()
Returns
Type Description
ProbingDetails.Builder

newBuilder(ProbingDetails prototype)

public static ProbingDetails.Builder newBuilder(ProbingDetails prototype)
Parameter
Name Description
prototype ProbingDetails
Returns
Type Description
ProbingDetails.Builder

parseDelimitedFrom(InputStream input)

public static ProbingDetails parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProbingDetails
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProbingDetails parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProbingDetails
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ProbingDetails parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ProbingDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProbingDetails parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProbingDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProbingDetails parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ProbingDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProbingDetails parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProbingDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProbingDetails parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ProbingDetails
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProbingDetails parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProbingDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ProbingDetails parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProbingDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProbingDetails parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProbingDetails
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ProbingDetails parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ProbingDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProbingDetails parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProbingDetails
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ProbingDetails> parser()
Returns
Type Description
Parser<ProbingDetails>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAbortCause()

public ProbingDetails.ProbingAbortCause getAbortCause()

The reason probing was aborted.

.google.cloud.networkmanagement.v1.ProbingDetails.ProbingAbortCause abort_cause = 4;

Returns
Type Description
ProbingDetails.ProbingAbortCause

The abortCause.

getAbortCauseValue()

public int getAbortCauseValue()

The reason probing was aborted.

.google.cloud.networkmanagement.v1.ProbingDetails.ProbingAbortCause abort_cause = 4;

Returns
Type Description
int

The enum numeric value on the wire for abortCause.

getDefaultInstanceForType()

public ProbingDetails getDefaultInstanceForType()
Returns
Type Description
ProbingDetails

getDestinationEgressLocation()

public ProbingDetails.EdgeLocation getDestinationEgressLocation()

The EdgeLocation from which a packet destined for/originating from the internet will egress/ingress the Google network. This will only be populated for a connectivity test which has an internet destination/source address. The absence of this field must not be used as an indication that the destination/source is part of the Google network.

.google.cloud.networkmanagement.v1.ProbingDetails.EdgeLocation destination_egress_location = 9;

Returns
Type Description
ProbingDetails.EdgeLocation

The destinationEgressLocation.

getDestinationEgressLocationOrBuilder()

public ProbingDetails.EdgeLocationOrBuilder getDestinationEgressLocationOrBuilder()

The EdgeLocation from which a packet destined for/originating from the internet will egress/ingress the Google network. This will only be populated for a connectivity test which has an internet destination/source address. The absence of this field must not be used as an indication that the destination/source is part of the Google network.

.google.cloud.networkmanagement.v1.ProbingDetails.EdgeLocation destination_egress_location = 9;

Returns
Type Description
ProbingDetails.EdgeLocationOrBuilder

getEndpointInfo()

public EndpointInfo getEndpointInfo()

The source and destination endpoints derived from the test input and used for active probing.

.google.cloud.networkmanagement.v1.EndpointInfo endpoint_info = 7;

Returns
Type Description
EndpointInfo

The endpointInfo.

getEndpointInfoOrBuilder()

public EndpointInfoOrBuilder getEndpointInfoOrBuilder()

The source and destination endpoints derived from the test input and used for active probing.

.google.cloud.networkmanagement.v1.EndpointInfo endpoint_info = 7;

Returns
Type Description
EndpointInfoOrBuilder

getError()

public Status getError()

Details about an internal failure or the cancellation of active probing.

.google.rpc.Status error = 3;

Returns
Type Description
com.google.rpc.Status

The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

Details about an internal failure or the cancellation of active probing.

.google.rpc.Status error = 3;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getParserForType()

public Parser<ProbingDetails> getParserForType()
Returns
Type Description
Parser<ProbingDetails>
Overrides

getProbingLatency()

public LatencyDistribution getProbingLatency()

Latency as measured by active probing in one direction: from the source to the destination endpoint.

.google.cloud.networkmanagement.v1.LatencyDistribution probing_latency = 8;

Returns
Type Description
LatencyDistribution

The probingLatency.

getProbingLatencyOrBuilder()

public LatencyDistributionOrBuilder getProbingLatencyOrBuilder()

Latency as measured by active probing in one direction: from the source to the destination endpoint.

.google.cloud.networkmanagement.v1.LatencyDistribution probing_latency = 8;

Returns
Type Description
LatencyDistributionOrBuilder

getResult()

public ProbingDetails.ProbingResult getResult()

The overall result of active probing.

.google.cloud.networkmanagement.v1.ProbingDetails.ProbingResult result = 1;

Returns
Type Description
ProbingDetails.ProbingResult

The result.

getResultValue()

public int getResultValue()

The overall result of active probing.

.google.cloud.networkmanagement.v1.ProbingDetails.ProbingResult result = 1;

Returns
Type Description
int

The enum numeric value on the wire for result.

getSentProbeCount()

public int getSentProbeCount()

Number of probes sent.

int32 sent_probe_count = 5;

Returns
Type Description
int

The sentProbeCount.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSuccessfulProbeCount()

public int getSuccessfulProbeCount()

Number of probes that reached the destination.

int32 successful_probe_count = 6;

Returns
Type Description
int

The successfulProbeCount.

getVerifyTime()

public Timestamp getVerifyTime()

The time that reachability was assessed through active probing.

.google.protobuf.Timestamp verify_time = 2;

Returns
Type Description
Timestamp

The verifyTime.

getVerifyTimeOrBuilder()

public TimestampOrBuilder getVerifyTimeOrBuilder()

The time that reachability was assessed through active probing.

.google.protobuf.Timestamp verify_time = 2;

Returns
Type Description
TimestampOrBuilder

hasDestinationEgressLocation()

public boolean hasDestinationEgressLocation()

The EdgeLocation from which a packet destined for/originating from the internet will egress/ingress the Google network. This will only be populated for a connectivity test which has an internet destination/source address. The absence of this field must not be used as an indication that the destination/source is part of the Google network.

.google.cloud.networkmanagement.v1.ProbingDetails.EdgeLocation destination_egress_location = 9;

Returns
Type Description
boolean

Whether the destinationEgressLocation field is set.

hasEndpointInfo()

public boolean hasEndpointInfo()

The source and destination endpoints derived from the test input and used for active probing.

.google.cloud.networkmanagement.v1.EndpointInfo endpoint_info = 7;

Returns
Type Description
boolean

Whether the endpointInfo field is set.

hasError()

public boolean hasError()

Details about an internal failure or the cancellation of active probing.

.google.rpc.Status error = 3;

Returns
Type Description
boolean

Whether the error field is set.

hasProbingLatency()

public boolean hasProbingLatency()

Latency as measured by active probing in one direction: from the source to the destination endpoint.

.google.cloud.networkmanagement.v1.LatencyDistribution probing_latency = 8;

Returns
Type Description
boolean

Whether the probingLatency field is set.

hasVerifyTime()

public boolean hasVerifyTime()

The time that reachability was assessed through active probing.

.google.protobuf.Timestamp verify_time = 2;

Returns
Type Description
boolean

Whether the verifyTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ProbingDetails.Builder newBuilderForType()
Returns
Type Description
ProbingDetails.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProbingDetails.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ProbingDetails.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ProbingDetails.Builder toBuilder()
Returns
Type Description
ProbingDetails.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException