Package com.google.cloud.networkmanagement.v1

Class ConnectivityTest

  • All Implemented Interfaces:
    ConnectivityTestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ConnectivityTest
extends com.google.protobuf.GeneratedMessageV3
implements ConnectivityTestOrBuilder
     A Connectivity Test for a network reachability analysis.
    Protobuf type google.cloud.networkmanagement.v1.ConnectivityTest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getName in interface ConnectivityTestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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];
        Specified by:
        getNameBytes in interface ConnectivityTestOrBuilder
        Returns:
        The bytes for name.

      • getDescription

        public String getDescription()
         The user-supplied description of the Connectivity Test.
 Maximum of 512 characters.
        string description = 2;
        Specified by:
        getDescription in interface ConnectivityTestOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         The user-supplied description of the Connectivity Test.
 Maximum of 512 characters.
        string description = 2;
        Specified by:
        getDescriptionBytes in interface ConnectivityTestOrBuilder
        Returns:
        The bytes for description.

      • 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];
        Specified by:
        hasSource in interface ConnectivityTestOrBuilder
        Returns:
        Whether the source field is set.

      • 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];
        Specified by:
        getSource in interface ConnectivityTestOrBuilder
        Returns:
        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];
        Specified by:
        getSourceOrBuilder in interface ConnectivityTestOrBuilder

      • 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];
        Specified by:
        hasDestination in interface ConnectivityTestOrBuilder
        Returns:
        Whether the destination field is set.

      • 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];
        Specified by:
        getDestination in interface ConnectivityTestOrBuilder
        Returns:
        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];
        Specified by:
        getDestinationOrBuilder in interface ConnectivityTestOrBuilder

      • getProtocol

        public String getProtocol()
         IP Protocol of the test. When not provided, "TCP" is assumed.
        string protocol = 5;
        Specified by:
        getProtocol in interface ConnectivityTestOrBuilder
        Returns:
        The protocol.

      • getProtocolBytes

        public com.google.protobuf.ByteString getProtocolBytes()
         IP Protocol of the test. When not provided, "TCP" is assumed.
        string protocol = 5;
        Specified by:
        getProtocolBytes in interface ConnectivityTestOrBuilder
        Returns:
        The bytes for protocol.

      • getRelatedProjectsList

        public com.google.protobuf.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;
        Specified by:
        getRelatedProjectsList in interface ConnectivityTestOrBuilder
        Returns:
        A list containing the relatedProjects.

      • 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;
        Specified by:
        getRelatedProjectsCount in interface ConnectivityTestOrBuilder
        Returns:
        The count of relatedProjects.

      • getRelatedProjects

        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;
        Specified by:
        getRelatedProjects in interface ConnectivityTestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The relatedProjects at the given index.

      • getRelatedProjectsBytes

        public com.google.protobuf.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;
        Specified by:
        getRelatedProjectsBytes in interface ConnectivityTestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the relatedProjects at the given index.

      • getDisplayName

        public String getDisplayName()
         Output only. The display name of a Connectivity Test.
        string display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDisplayName in interface ConnectivityTestOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Output only. The display name of a Connectivity Test.
        string display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDisplayNameBytes in interface ConnectivityTestOrBuilder
        Returns:
        The bytes for displayName.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time the test was created.
        .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ConnectivityTestOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time the test was created.
        .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ConnectivityTestOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time the test was created.
        .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ConnectivityTestOrBuilder

      • 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];
        Specified by:
        hasUpdateTime in interface ConnectivityTestOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time the test's configuration was updated.
        .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface ConnectivityTestOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time the test's configuration was updated.
        .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface ConnectivityTestOrBuilder

      • 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];
        Specified by:
        hasReachabilityDetails in interface ConnectivityTestOrBuilder
        Returns:
        Whether the reachabilityDetails field is set.

      • 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];
        Specified by:
        getReachabilityDetails in interface ConnectivityTestOrBuilder
        Returns:
        The reachabilityDetails.

      • 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];
        Specified by:
        getReachabilityDetailsOrBuilder in interface ConnectivityTestOrBuilder

      • 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.v1.ProbingDetails probing_details = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasProbingDetails in interface ConnectivityTestOrBuilder
        Returns:
        Whether the probingDetails field is set.

      • 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.v1.ProbingDetails probing_details = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getProbingDetails in interface ConnectivityTestOrBuilder
        Returns:
        The probingDetails.

      • 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.v1.ProbingDetails probing_details = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getProbingDetailsOrBuilder in interface ConnectivityTestOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ConnectivityTest parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConnectivityTest parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConnectivityTest parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConnectivityTest parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConnectivityTest parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConnectivityTest parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConnectivityTest parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ConnectivityTest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ConnectivityTest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ConnectivityTest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ConnectivityTest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ConnectivityTest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder