public final class ConnectivityTest extends GeneratedMessageV3 implements ConnectivityTestOrBuilder
A Connectivity Test for a network reachability analysis.
Protobuf type google.cloud.networkmanagement.v1.ConnectivityTest
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESTINATION_FIELD_NUMBER
public static final int DESTINATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROTOCOL_FIELD_NUMBER
public static final int PROTOCOL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REACHABILITY_DETAILS_FIELD_NUMBER
public static final int REACHABILITY_DETAILS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int RELATED_PROJECTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SOURCE_FIELD_NUMBER
public static final int SOURCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ConnectivityTest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ConnectivityTest.Builder newBuilder()
newBuilder(ConnectivityTest prototype)
public static ConnectivityTest.Builder newBuilder(ConnectivityTest prototype)
public static ConnectivityTest parseDelimitedFrom(InputStream input)
public static ConnectivityTest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ConnectivityTest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ConnectivityTest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ConnectivityTest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ConnectivityTest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ConnectivityTest parseFrom(CodedInputStream input)
public static ConnectivityTest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ConnectivityTest parseFrom(InputStream input)
public static ConnectivityTest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ConnectivityTest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ConnectivityTest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ConnectivityTest> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time the test was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public ConnectivityTest getDefaultInstanceForType()
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.
|
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.
|
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];
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()
public Map<String,String> getLabels()
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;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Resource labels to represent user-provided metadata.
map<string, string> labels = 8;
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
|
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 |
|---|
| 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_id}
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<ConnectivityTest> getParserForType()
Overrides
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.v1.ReachabilityDetails reachability_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
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.
|
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.
|
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.
|
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;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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 |
|---|
| Type | Description |
Endpoint | The source.
|
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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
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];
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.v1.Endpoint destination = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
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 |
|---|
| 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.v1.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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ConnectivityTest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ConnectivityTest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ConnectivityTest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
