Class: Google::Apis::VmmigrationV1alpha1::MigrationError

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/vmmigration_v1alpha1/classes.rb,
lib/google/apis/vmmigration_v1alpha1/representations.rb,
lib/google/apis/vmmigration_v1alpha1/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.



1327
1328
1329
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 1327

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

Instance Attribute Details

#action_item ⇒ Google::Apis::VmmigrationV1alpha1::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:



1303
1304
1305
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 1303

def action_item
  @action_item
end

#code ⇒ String

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

Returns:

  • (String) 


1308
1309
1310
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 1308

def code
  @code
end

#error_message ⇒ Google::Apis::VmmigrationV1alpha1::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:



1314
1315
1316
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 1314

def error_message
  @error_message
end

#error_time ⇒ String

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

Returns:

  • (String) 


1319
1320
1321
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 1319

def error_time
  @error_time
end

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

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

Returns:



1325
1326
1327
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 1325

def help_links
  @help_links
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1332
1333
1334
1335
1336
1337
1338
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 1332

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