Class ConnectivityTest.Builder (1.20.0)

Version latest

• 1.20.0 (latest)
• 1.19.0
• 1.18.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

Implements

ConnectivityTestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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