Interface ConnectivityTestOrBuilder (1.56.0) 

public interface ConnectivityTestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
boolean

getBypassFirewallChecks()

public abstract boolean getBypassFirewallChecks()

Whether the test should skip firewall checking. If not provided, we assume false.

bool bypass_firewall_checks = 17;

Returns
Type Description
boolean

The bypassFirewallChecks.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time the test was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the test was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

The user-supplied description of the Connectivity Test. Maximum of 512 characters.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

The user-supplied description of the Connectivity Test. Maximum of 512 characters.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getDestination()

public abstract Endpoint getDestination()

Required. Destination specification of the Connectivity Test.

You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location.

Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information.

If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface.

A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.

.google.cloud.networkmanagement.v1beta1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Endpoint

The destination.

getDestinationOrBuilder()

public abstract EndpointOrBuilder getDestinationOrBuilder()

Required. Destination specification of the Connectivity Test.

You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location.

Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information.

If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface.

A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.

.google.cloud.networkmanagement.v1beta1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EndpointOrBuilder

getDisplayName()

public abstract String getDisplayName()

Output only. The display name of a Connectivity Test.

string display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Output only. The display name of a Connectivity Test.

string display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for displayName.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public abstract String getName()

Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getProbingDetails()

public abstract ProbingDetails getProbingDetails()

Output only. The probing details of this test from the latest run, present for applicable tests only. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

.google.cloud.networkmanagement.v1beta1.ProbingDetails probing_details = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProbingDetails

The probingDetails.

getProbingDetailsOrBuilder()

public abstract ProbingDetailsOrBuilder getProbingDetailsOrBuilder()

Output only. The probing details of this test from the latest run, present for applicable tests only. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

.google.cloud.networkmanagement.v1beta1.ProbingDetails probing_details = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProbingDetailsOrBuilder

getProtocol()

public abstract String getProtocol()

IP Protocol of the test. When not provided, "TCP" is assumed.

string protocol = 5;

Returns
Type Description
String

The protocol.

getProtocolBytes()

public abstract ByteString getProtocolBytes()

IP Protocol of the test. When not provided, "TCP" is assumed.

string protocol = 5;

Returns
Type Description
ByteString

The bytes for protocol.

getReachabilityDetails()

public abstract ReachabilityDetails getReachabilityDetails()

Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

.google.cloud.networkmanagement.v1beta1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ReachabilityDetails

The reachabilityDetails.

getReachabilityDetailsOrBuilder()

public abstract ReachabilityDetailsOrBuilder getReachabilityDetailsOrBuilder()

Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

.google.cloud.networkmanagement.v1beta1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ReachabilityDetailsOrBuilder

getRelatedProjects(int index)

public abstract String getRelatedProjects(int index)

Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

repeated string related_projects = 6;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The relatedProjects at the given index.

getRelatedProjectsBytes(int index)

public abstract ByteString getRelatedProjectsBytes(int index)

Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

repeated string related_projects = 6;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the relatedProjects at the given index.

getRelatedProjectsCount()

public abstract int getRelatedProjectsCount()

Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

repeated string related_projects = 6;

Returns
Type Description
int

The count of relatedProjects.

getRelatedProjectsList()

public abstract List<String> getRelatedProjectsList()

Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

repeated string related_projects = 6;

Returns
Type Description
List<String>

A list containing the relatedProjects.

getReturnReachabilityDetails()

public abstract ReachabilityDetails getReturnReachabilityDetails()

Output only. The reachability details of this test from the latest run for the return path. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

.google.cloud.networkmanagement.v1beta1.ReachabilityDetails return_reachability_details = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ReachabilityDetails

The returnReachabilityDetails.

getReturnReachabilityDetailsOrBuilder()

public abstract ReachabilityDetailsOrBuilder getReturnReachabilityDetailsOrBuilder()

Output only. The reachability details of this test from the latest run for the return path. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

.google.cloud.networkmanagement.v1beta1.ReachabilityDetails return_reachability_details = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ReachabilityDetailsOrBuilder

getRoundTrip()

public abstract boolean getRoundTrip()

Whether run analysis for the return path from destination to source. Default value is false.

bool round_trip = 15;

Returns
Type Description
boolean

The roundTrip.

getSource()

public abstract Endpoint getSource()

Required. Source specification of the Connectivity Test.

You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location.

Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information.

If the source of the test is within an on-premises network, then you must provide the destination VPC network.

If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network.

A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.

.google.cloud.networkmanagement.v1beta1.Endpoint source = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Endpoint

The source.

getSourceOrBuilder()

public abstract EndpointOrBuilder getSourceOrBuilder()

Required. Source specification of the Connectivity Test.

You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location.

Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information.

If the source of the test is within an on-premises network, then you must provide the destination VPC network.

If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network.

A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.

.google.cloud.networkmanagement.v1beta1.Endpoint source = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EndpointOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time the test's configuration was updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the test's configuration was updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time the test was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDestination()

public abstract boolean hasDestination()

Required. Destination specification of the Connectivity Test.

You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location.

Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information.

If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface.

A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.

.google.cloud.networkmanagement.v1beta1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the destination field is set.

hasProbingDetails()

public abstract boolean hasProbingDetails()

Output only. The probing details of this test from the latest run, present for applicable tests only. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

.google.cloud.networkmanagement.v1beta1.ProbingDetails probing_details = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the probingDetails field is set.

hasReachabilityDetails()

public abstract boolean hasReachabilityDetails()

Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

.google.cloud.networkmanagement.v1beta1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the reachabilityDetails field is set.

hasReturnReachabilityDetails()

public abstract boolean hasReturnReachabilityDetails()

Output only. The reachability details of this test from the latest run for the return path. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

.google.cloud.networkmanagement.v1beta1.ReachabilityDetails return_reachability_details = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the returnReachabilityDetails field is set.

hasSource()

public abstract boolean hasSource()

Required. Source specification of the Connectivity Test.

You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location.

Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information.

If the source of the test is within an on-premises network, then you must provide the destination VPC network.

If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network.

A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.

.google.cloud.networkmanagement.v1beta1.Endpoint source = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the source field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time the test's configuration was updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.