Class: Google::Apis::NetworkmanagementV1::ConnectivityTest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/networkmanagement_v1/classes.rb,
lib/google/apis/networkmanagement_v1/representations.rb,
lib/google/apis/networkmanagement_v1/representations.rb

Overview

A Connectivity Test for a network reachability analysis.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ConnectivityTest

Returns a new instance of ConnectivityTest.



600
601
602
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 600

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bypass_firewall_checks ⇒ Boolean Also known as: bypass_firewall_checks?

Whether the analysis should skip firewall checking. Default value is false. Corresponds to the JSON property bypassFirewallChecks

Returns:

  • (Boolean) 


522
523
524
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 522

def bypass_firewall_checks
  @bypass_firewall_checks
end

#create_time ⇒ String

Output only. The time the test was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


528
529
530
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 528

def create_time
  @create_time
end

#description ⇒ String

The user-supplied description of the Connectivity Test. Maximum of 512 characters. Corresponds to the JSON property description

Returns:

  • (String) 


534
535
536
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 534

def description
  @description
end

#destination ⇒ Google::Apis::NetworkmanagementV1::Endpoint

Source or destination of the Connectivity Test. Corresponds to the JSON property destination

Returns:



539
540
541
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 539

def destination
  @destination
end

#display_name ⇒ String

Output only. The display name of a Connectivity Test. Corresponds to the JSON property displayName

Returns:

  • (String) 


544
545
546
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 544

def display_name
  @display_name
end

#labels ⇒ Hash<String,String>

Resource labels to represent user-provided metadata. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


549
550
551
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 549

def labels
  @labels
end

#name ⇒ String

Identifier. Unique name of the resource using the form: projects/project_id/ locations/global/connectivityTests/test_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


555
556
557
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 555

def name
  @name
end

#probing_details ⇒ Google::Apis::NetworkmanagementV1::ProbingDetails

Results of active probing from the last run of the test. Corresponds to the JSON property probingDetails

Returns:



560
561
562
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 560

def probing_details
  @probing_details
end

#protocol ⇒ String

IP Protocol of the test. When not provided, "TCP" is assumed. Corresponds to the JSON property protocol

Returns:

  • (String) 


565
566
567
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 565

def protocol
  @protocol
end

#reachability_details ⇒ Google::Apis::NetworkmanagementV1::ReachabilityDetails

Results of the configuration analysis from the last run of the test. Corresponds to the JSON property reachabilityDetails

Returns:



570
571
572
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 570

def reachability_details
  @reachability_details
end

#related_projects ⇒ Array<String>

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

Returns:

  • (Array<String>) 


576
577
578
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 576

def related_projects
  @related_projects
end

#return_reachability_details ⇒ Google::Apis::NetworkmanagementV1::ReachabilityDetails

Results of the configuration analysis from the last run of the test. Corresponds to the JSON property returnReachabilityDetails

Returns:



581
582
583
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 581

def return_reachability_details
  @return_reachability_details
end

#round_trip ⇒ Boolean Also known as: round_trip?

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

Returns:

  • (Boolean) 


587
588
589
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 587

def round_trip
  @round_trip
end

#source ⇒ Google::Apis::NetworkmanagementV1::Endpoint

Source or destination of the Connectivity Test. Corresponds to the JSON property source

Returns:



593
594
595
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 593

def source
  @source
end

#update_time ⇒ String

Output only. The time the test's configuration was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


598
599
600
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 598

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 605

def update!(**args)
  @bypass_firewall_checks = args[:bypass_firewall_checks] if args.key?(:bypass_firewall_checks)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @destination = args[:destination] if args.key?(:destination)
  @display_name = args[:display_name] if args.key?(:display_name)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @probing_details = args[:probing_details] if args.key?(:probing_details)
  @protocol = args[:protocol] if args.key?(:protocol)
  @reachability_details = args[:reachability_details] if args.key?(:reachability_details)
  @related_projects = args[:related_projects] if args.key?(:related_projects)
  @return_reachability_details = args[:return_reachability_details] if args.key?(:return_reachability_details)
  @round_trip = args[:round_trip] if args.key?(:round_trip)
  @source = args[:source] if args.key?(:source)
  @update_time = args[:update_time] if args.key?(:update_time)
end