Class ConnectivityTest.Builder

Stay organized with collections Save and categorize content based on your preferences.
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.v1.ConnectivityTest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The relatedProjects to add.

Returns
TypeDescription
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
NameDescription
valueString

The relatedProjects to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the relatedProjects to add.

Returns
TypeDescription
ConnectivityTest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ConnectivityTest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ConnectivityTest.Builder
Overrides

build()

public ConnectivityTest build()
Returns
TypeDescription
ConnectivityTest

buildPartial()

public ConnectivityTest buildPartial()
Returns
TypeDescription
ConnectivityTest

clear()

public ConnectivityTest.Builder clear()
Returns
TypeDescription
ConnectivityTest.Builder
Overrides

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

clearDescription()

public ConnectivityTest.Builder clearDescription()

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

string description = 2;

Returns
TypeDescription
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.v1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ConnectivityTest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ConnectivityTest.Builder
Overrides

clearLabels()

public ConnectivityTest.Builder clearLabels()
Returns
TypeDescription
ConnectivityTest.Builder

clearName()

public ConnectivityTest.Builder clearName()

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

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

Returns
TypeDescription
ConnectivityTest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ConnectivityTest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ConnectivityTest.Builder
Overrides

clearProtocol()

public ConnectivityTest.Builder clearProtocol()

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

string protocol = 5;

Returns
TypeDescription
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.v1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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
TypeDescription
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.v1.Endpoint source = 3 [(.google.api.field_behavior) = REQUIRED];

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

clone()

public ConnectivityTest.Builder clone()
Returns
TypeDescription
ConnectivityTest.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ConnectivityTest getDefaultInstanceForType()
Returns
TypeDescription
ConnectivityTest

getDescription()

public String getDescription()

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

string description = 2;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 2;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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.v1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.v1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.v1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for displayName.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Returns
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

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

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for name.

getProtocol()

public String getProtocol()

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

string protocol = 5;

Returns
TypeDescription
String

The protocol.

getProtocolBytes()

public ByteString getProtocolBytes()

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

string protocol = 5;

Returns
TypeDescription
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.v1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.v1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.v1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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.v1.Endpoint source = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.v1.Endpoint source = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.v1.Endpoint source = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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.v1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the destination 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.v1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.v1.Endpoint source = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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.v1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueEndpoint
Returns
TypeDescription
ConnectivityTest.Builder

mergeFrom(ConnectivityTest other)

public ConnectivityTest.Builder mergeFrom(ConnectivityTest other)
Parameter
NameDescription
otherConnectivityTest
Returns
TypeDescription
ConnectivityTest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ConnectivityTest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConnectivityTest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ConnectivityTest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ConnectivityTest.Builder
Overrides

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.v1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueReachabilityDetails
Returns
TypeDescription
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.v1.Endpoint source = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueEndpoint
Returns
TypeDescription
ConnectivityTest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ConnectivityTest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
ConnectivityTest.Builder

removeLabels(String key)

public ConnectivityTest.Builder removeLabels(String key)

Resource labels to represent user-provided metadata.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
ConnectivityTest.Builder

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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueString

The description to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
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.v1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueEndpoint
Returns
TypeDescription
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.v1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueEndpoint.Builder
Returns
TypeDescription
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
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
ConnectivityTest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ConnectivityTest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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_id}

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
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_id}

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
ConnectivityTest.Builder

This builder for chaining.

setProtocol(String value)

public ConnectivityTest.Builder setProtocol(String value)

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

string protocol = 5;

Parameter
NameDescription
valueString

The protocol to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for protocol to set.

Returns
TypeDescription
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.v1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueReachabilityDetails
Returns
TypeDescription
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.v1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueReachabilityDetails.Builder
Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The relatedProjects to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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.v1.Endpoint source = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueEndpoint
Returns
TypeDescription
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.v1.Endpoint source = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueEndpoint.Builder
Returns
TypeDescription
ConnectivityTest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ConnectivityTest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
ConnectivityTest.Builder