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.



3105
3106
3107
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 3105

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:



3081
3082
3083
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 3081

def action_item
  @action_item
end

#code ⇒ String

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

Returns:

  • (String) 


3086
3087
3088
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 3086

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:



3092
3093
3094
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 3092

def error_message
  @error_message
end

#error_time ⇒ String

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

Returns:

  • (String) 


3097
3098
3099
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 3097

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:



3103
3104
3105
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 3103

def help_links
  @help_links
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3110
3111
3112
3113
3114
3115
3116
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 3110

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