Class ConnectivityTest.Builder (1.44.0) 

public static final class ConnectivityTest.Builder extends GeneratedMessageV3.Builder<ConnectivityTest.Builder> implements ConnectivityTestOrBuilder

A Connectivity Test for a network reachability analysis.

Protobuf type google.cloud.networkmanagement.v1beta1.ConnectivityTest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ConnectivityTest.Builder

Static Methods

getDescriptor()

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

Methods

addAllRelatedProjects(Iterable<String> values)

public ConnectivityTest.Builder addAllRelatedProjects(Iterable<String> values)

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
values Iterable<String>

The relatedProjects to add.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

addRelatedProjects(String value)

public ConnectivityTest.Builder addRelatedProjects(String value)

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
value String

The relatedProjects to add.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

addRelatedProjectsBytes(ByteString value)

public ConnectivityTest.Builder addRelatedProjectsBytes(ByteString value)

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
value ByteString

The bytes of the relatedProjects to add.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ConnectivityTest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConnectivityTest.Builder
Overrides

build()

public ConnectivityTest build()
Returns
Type Description
ConnectivityTest

buildPartial()

public ConnectivityTest buildPartial()
Returns
Type Description
ConnectivityTest

clear()

public ConnectivityTest.Builder clear()
Returns
Type Description
ConnectivityTest.Builder
Overrides

clearBypassFirewallChecks()

public ConnectivityTest.Builder clearBypassFirewallChecks()

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

bool bypass_firewall_checks = 17;

Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

clearCreateTime()

public ConnectivityTest.Builder clearCreateTime()

Output only. The time the test was created.

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

Returns
Type Description
ConnectivityTest.Builder

clearDescription()

public ConnectivityTest.Builder clearDescription()

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

string description = 2;

Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

clearDestination()

public ConnectivityTest.Builder clearDestination()

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
ConnectivityTest.Builder

clearDisplayName()

public ConnectivityTest.Builder clearDisplayName()

Output only. The display name of a Connectivity Test.

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

Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ConnectivityTest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ConnectivityTest.Builder
Overrides

clearLabels()

public ConnectivityTest.Builder clearLabels()
Returns
Type Description
ConnectivityTest.Builder

clearName()

public ConnectivityTest.Builder clearName()

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

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

Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ConnectivityTest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ConnectivityTest.Builder
Overrides

clearProbingDetails()

public ConnectivityTest.Builder clearProbingDetails()

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
ConnectivityTest.Builder

clearProtocol()

public ConnectivityTest.Builder clearProtocol()

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

string protocol = 5;

Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

clearReachabilityDetails()

public ConnectivityTest.Builder clearReachabilityDetails()

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
ConnectivityTest.Builder

clearRelatedProjects()

public ConnectivityTest.Builder clearRelatedProjects()

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
ConnectivityTest.Builder

This builder for chaining.

clearSource()

public ConnectivityTest.Builder clearSource()

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
ConnectivityTest.Builder

clearUpdateTime()

public ConnectivityTest.Builder clearUpdateTime()

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
ConnectivityTest.Builder

clone()

public ConnectivityTest.Builder clone()
Returns
Type Description
ConnectivityTest.Builder
Overrides

containsLabels(String key)

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

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time the test was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public 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

getDefaultInstanceForType()

public ConnectivityTest getDefaultInstanceForType()
Returns
Type Description
ConnectivityTest

getDescription()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDestination()

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

getDestinationBuilder()

public Endpoint.Builder getDestinationBuilder()

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.Builder

getDestinationOrBuilder()

public 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 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Returns
Type Description
int

getLabelsMap()

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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for name.

getProbingDetails()

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

getProbingDetailsBuilder()

public ProbingDetails.Builder getProbingDetailsBuilder()

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.Builder

getProbingDetailsOrBuilder()

public 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 String getProtocol()

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

string protocol = 5;

Returns
Type Description
String

The protocol.

getProtocolBytes()

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

getReachabilityDetailsBuilder()

public ReachabilityDetails.Builder getReachabilityDetailsBuilder()

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.Builder

getReachabilityDetailsOrBuilder()

public 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the relatedProjects.

getSource()

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

getSourceBuilder()

public Endpoint.Builder getSourceBuilder()

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.Builder

getSourceOrBuilder()

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

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

getUpdateTimeOrBuilder()

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

hasSource()

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

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public ConnectivityTest.Builder mergeCreateTime(Timestamp value)

Output only. The time the test was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ConnectivityTest.Builder

mergeDestination(Endpoint value)

public ConnectivityTest.Builder mergeDestination(Endpoint value)

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];

Parameter
Name Description
value Endpoint
Returns
Type Description
ConnectivityTest.Builder

mergeFrom(ConnectivityTest other)

public ConnectivityTest.Builder mergeFrom(ConnectivityTest other)
Parameter
Name Description
other ConnectivityTest
Returns
Type Description
ConnectivityTest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ConnectivityTest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConnectivityTest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ConnectivityTest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ConnectivityTest.Builder
Overrides

mergeProbingDetails(ProbingDetails value)

public ConnectivityTest.Builder mergeProbingDetails(ProbingDetails value)

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];

Parameter
Name Description
value ProbingDetails
Returns
Type Description
ConnectivityTest.Builder

mergeReachabilityDetails(ReachabilityDetails value)

public ConnectivityTest.Builder mergeReachabilityDetails(ReachabilityDetails value)

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];

Parameter
Name Description
value ReachabilityDetails
Returns
Type Description
ConnectivityTest.Builder

mergeSource(Endpoint value)

public ConnectivityTest.Builder mergeSource(Endpoint value)

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];

Parameter
Name Description
value Endpoint
Returns
Type Description
ConnectivityTest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ConnectivityTest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConnectivityTest.Builder
Overrides

mergeUpdateTime(Timestamp value)

public ConnectivityTest.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ConnectivityTest.Builder

putAllLabels(Map<String,String> values)

public ConnectivityTest.Builder putAllLabels(Map<String,String> values)

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
ConnectivityTest.Builder

putLabels(String key, String value)

public ConnectivityTest.Builder putLabels(String key, String value)

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Parameters
Name Description
key String
value String
Returns
Type Description
ConnectivityTest.Builder

removeLabels(String key)

public ConnectivityTest.Builder removeLabels(String key)

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
ConnectivityTest.Builder

setBypassFirewallChecks(boolean value)

public ConnectivityTest.Builder setBypassFirewallChecks(boolean value)

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

bool bypass_firewall_checks = 17;

Parameter
Name Description
value boolean

The bypassFirewallChecks to set.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public ConnectivityTest.Builder setCreateTime(Timestamp value)

Output only. The time the test was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ConnectivityTest.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ConnectivityTest.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time the test was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ConnectivityTest.Builder

setDescription(String value)

public ConnectivityTest.Builder setDescription(String value)

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

string description = 2;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public ConnectivityTest.Builder setDescriptionBytes(ByteString value)

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

string description = 2;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

setDestination(Endpoint value)

public ConnectivityTest.Builder setDestination(Endpoint value)

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];

Parameter
Name Description
value Endpoint
Returns
Type Description
ConnectivityTest.Builder

setDestination(Endpoint.Builder builderForValue)

public ConnectivityTest.Builder setDestination(Endpoint.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Endpoint.Builder
Returns
Type Description
ConnectivityTest.Builder

setDisplayName(String value)

public ConnectivityTest.Builder setDisplayName(String value)

Output only. The display name of a Connectivity Test.

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

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ConnectivityTest.Builder setDisplayNameBytes(ByteString value)

Output only. The display name of a Connectivity Test.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ConnectivityTest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConnectivityTest.Builder
Overrides

setName(String value)

public ConnectivityTest.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ConnectivityTest.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

setProbingDetails(ProbingDetails value)

public ConnectivityTest.Builder setProbingDetails(ProbingDetails value)

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];

Parameter
Name Description
value ProbingDetails
Returns
Type Description
ConnectivityTest.Builder

setProbingDetails(ProbingDetails.Builder builderForValue)

public ConnectivityTest.Builder setProbingDetails(ProbingDetails.Builder builderForValue)

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];

Parameter
Name Description
builderForValue ProbingDetails.Builder
Returns
Type Description
ConnectivityTest.Builder

setProtocol(String value)

public ConnectivityTest.Builder setProtocol(String value)

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

string protocol = 5;

Parameter
Name Description
value String

The protocol to set.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

setProtocolBytes(ByteString value)

public ConnectivityTest.Builder setProtocolBytes(ByteString value)

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

string protocol = 5;

Parameter
Name Description
value ByteString

The bytes for protocol to set.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

setReachabilityDetails(ReachabilityDetails value)

public ConnectivityTest.Builder setReachabilityDetails(ReachabilityDetails value)

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];

Parameter
Name Description
value ReachabilityDetails
Returns
Type Description
ConnectivityTest.Builder

setReachabilityDetails(ReachabilityDetails.Builder builderForValue)

public ConnectivityTest.Builder setReachabilityDetails(ReachabilityDetails.Builder builderForValue)

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];

Parameter
Name Description
builderForValue ReachabilityDetails.Builder
Returns
Type Description
ConnectivityTest.Builder

setRelatedProjects(int index, String value)

public ConnectivityTest.Builder setRelatedProjects(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.
value String

The relatedProjects to set.
Returns
Type Description
ConnectivityTest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ConnectivityTest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ConnectivityTest.Builder
Overrides

setSource(Endpoint value)

public ConnectivityTest.Builder setSource(Endpoint value)

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];

Parameter
Name Description
value Endpoint
Returns
Type Description
ConnectivityTest.Builder

setSource(Endpoint.Builder builderForValue)

public ConnectivityTest.Builder setSource(Endpoint.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Endpoint.Builder
Returns
Type Description
ConnectivityTest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ConnectivityTest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConnectivityTest.Builder
Overrides

setUpdateTime(Timestamp value)

public ConnectivityTest.Builder setUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ConnectivityTest.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public ConnectivityTest.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ConnectivityTest.Builder