Package com.google.cloud.networkmanagement.v1

Interface ConnectivityTestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ConnectivityTest, ConnectivityTest.Builder
    public interface ConnectivityTestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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];
        Returns:
        The name.

      • getNameBytes

        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];
        Returns:
        The bytes for name.

      • getDescription

        String getDescription()
         The user-supplied description of the Connectivity Test.
 Maximum of 512 characters.
        string description = 2;
        Returns:
        The description.

      • getDescriptionBytes

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

      • hasSource

        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:
        Whether the source field is set.

      • getSource

        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:
        The source.

      • getSourceOrBuilder

        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];

      • hasDestination

        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:
        Whether the destination field is set.

      • getDestination

        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:
        The destination.

      • getDestinationOrBuilder

        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];

      • getProtocol

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

      • getProtocolBytes

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

      • getRelatedProjectsList

        List<String> 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:
        A list containing the relatedProjects.

      • getRelatedProjectsCount

        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:
        The count of relatedProjects.

      • getRelatedProjects

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The relatedProjects at the given index.

      • getRelatedProjectsBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the relatedProjects at the given index.

      • getDisplayName

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

      • getDisplayNameBytes

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

      • getLabelsCount

        int getLabelsCount()
         Resource labels to represent user-provided metadata.
        map<string, string> labels = 8;

      • containsLabels

        boolean containsLabels​(String key)
         Resource labels to represent user-provided metadata.
        map<string, string> labels = 8;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Resource labels to represent user-provided metadata.
        map<string, string> labels = 8;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Resource labels to represent user-provided metadata.
        map<string, string> labels = 8;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Resource labels to represent user-provided metadata.
        map<string, string> labels = 8;

      • hasCreateTime

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

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        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];

      • hasUpdateTime

        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:
        Whether the updateTime field is set.

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        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];

      • hasReachabilityDetails

        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:
        Whether the reachabilityDetails field is set.

      • getReachabilityDetails

        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:
        The reachabilityDetails.

      • getReachabilityDetailsOrBuilder

        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];

      • hasProbingDetails

        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];
        Returns:
        Whether the probingDetails field is set.

      • getProbingDetails

        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];
        Returns:
        The probingDetails.

      • getProbingDetailsOrBuilder

        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];