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.



537
538
539
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 537

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


477
478
479
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 477

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) 


483
484
485
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 483

def description
  @description
end

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

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

Returns:



488
489
490
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 488

def destination
  @destination
end

#display_name ⇒ String

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

Returns:

  • (String) 


493
494
495
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 493

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>) 


498
499
500
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 498

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


504
505
506
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 504

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:



509
510
511
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 509

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) 


514
515
516
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 514

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:



519
520
521
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 519

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>) 


525
526
527
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 525

def related_projects
  @related_projects
end

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

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

Returns:



530
531
532
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 530

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) 


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

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 542

def update!(**args)
  @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)
  @source = args[:source] if args.key?(:source)
  @update_time = args[:update_time] if args.key?(:update_time)
end