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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ConnectivityTest.BuilderImplements
ConnectivityTestOrBuilderStatic 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 |
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 |
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.v1.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 |
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_id}
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 |
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.v1.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.v1.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 |
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 |
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 | |
---|---|
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.v1.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