Class: Google::Apis::VmmigrationV1::MigrationError

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

Overview

Represents migration resource error information that can be used with google. rpc.Status message. MigrationError is used to present the user with error information in migration operations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MigrationError

Returns a new instance of MigrationError.



1429
1430
1431
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1429

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

Instance Attribute Details

#action_item ⇒ Google::Apis::VmmigrationV1::LocalizedMessage

Provides a localized error message that is safe to return to the user which can be attached to an RPC error. Corresponds to the JSON property actionItem

Returns:



1405
1406
1407
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1405

def action_item
  @action_item
end

#code ⇒ String

Output only. The error code. Corresponds to the JSON property code

Returns:

  • (String) 


1410
1411
1412
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1410

def code
  @code
end

#error_message ⇒ Google::Apis::VmmigrationV1::LocalizedMessage

Provides a localized error message that is safe to return to the user which can be attached to an RPC error. Corresponds to the JSON property errorMessage

Returns:



1416
1417
1418
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1416

def error_message
  @error_message
end

#error_time ⇒ String

Output only. The time the error occurred. Corresponds to the JSON property errorTime

Returns:

  • (String) 


1421
1422
1423
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1421

def error_time
  @error_time
end

#help_links ⇒ Array<Google::Apis::VmmigrationV1::Link>

Output only. URL(s) pointing to additional information on handling the current error. Corresponds to the JSON property helpLinks

Returns:



1427
1428
1429
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1427

def help_links
  @help_links
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1434

def update!(**args)
  @action_item = args[:action_item] if args.key?(:action_item)
  @code = args[:code] if args.key?(:code)
  @error_message = args[:error_message] if args.key?(:error_message)
  @error_time = args[:error_time] if args.key?(:error_time)
  @help_links = args[:help_links] if args.key?(:help_links)
end