Class: Google::Cloud::NetworkManagement::V1::ConnectivityTest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb

Overview

A Connectivity Test for a network reachability analysis.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#bypass_firewall_checks ⇒ ::Boolean

Returns Whether the analysis should skip firewall checking. Default value is false.

Returns:

  • (::Boolean) —

    Whether the analysis should skip firewall checking. Default value is false.



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the test was created.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns The user-supplied description of the Connectivity Test. Maximum of 512 characters.

Returns:

  • (::String) —

    The user-supplied description of the Connectivity Test. Maximum of 512 characters.



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#destination ⇒ ::Google::Cloud::NetworkManagement::V1::Endpoint

Returns Required. Destination specification of the Connectivity Test.

You can use a combination of destination IP address, URI of a supported endpoint, project ID, or VPC network to identify the destination location.

Reachability analysis proceeds even if the destination location is ambiguous. However, the test result might include endpoints or use a destination that you don't intend to test.

Returns:

  • (::Google::Cloud::NetworkManagement::V1::Endpoint) —

    Required. Destination specification of the Connectivity Test.

    You can use a combination of destination IP address, URI of a supported endpoint, project ID, or VPC network to identify the destination location.

    Reachability analysis proceeds even if the destination location is ambiguous. However, the test result might include endpoints or use a destination that you don't intend to test.



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String (readonly)

Returns Output only. The display name of a Connectivity Test.

Returns:

  • (::String) —

    Output only. The display name of a Connectivity Test.



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Resource labels to represent user-provided metadata.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Resource labels to represent user-provided metadata.



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}.

Returns:

  • (::String) —

    Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#probing_details ⇒ ::Google::Cloud::NetworkManagement::V1::ProbingDetails (readonly)

Returns 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.

Returns:

  • (::Google::Cloud::NetworkManagement::V1::ProbingDetails) —

    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.



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#protocol ⇒ ::String

Returns IP Protocol of the test. When not provided, "TCP" is assumed.

Returns:

  • (::String) —

    IP Protocol of the test. When not provided, "TCP" is assumed.



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#reachability_details ⇒ ::Google::Cloud::NetworkManagement::V1::ReachabilityDetails (readonly)

Returns 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.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#related_projects ⇒ ::Array<::String>

Returns Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

Returns:

  • (::Array<::String>) —

    Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#return_reachability_details ⇒ ::Google::Cloud::NetworkManagement::V1::ReachabilityDetails (readonly)

Returns Output only. The reachability details of this test from the latest run for the return path. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#round_trip ⇒ ::Boolean

Returns Whether run analysis for the return path from destination to source. Default value is false.

Returns:

  • (::Boolean) —

    Whether run analysis for the return path from destination to source. Default value is false.



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#source ⇒ ::Google::Cloud::NetworkManagement::V1::Endpoint

Returns Required. Source specification of the Connectivity Test.

You can use a combination of source IP address, URI of a supported endpoint, project ID, or VPC network to identify the source location.

Reachability analysis might proceed even if the source location is ambiguous. However, the test result might include endpoints or use a source that you don't intend to test.

Returns:

  • (::Google::Cloud::NetworkManagement::V1::Endpoint) —

    Required. Source specification of the Connectivity Test.

    You can use a combination of source IP address, URI of a supported endpoint, project ID, or VPC network to identify the source location.

    Reachability analysis might proceed even if the source location is ambiguous. However, the test result might include endpoints or use a source that you don't intend to test.



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the test's configuration was updated.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 96

class ConnectivityTest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end