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.



2139
2140
2141
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 2139

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:



2115
2116
2117
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 2115

def action_item
  @action_item
end

#code ⇒ String

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

Returns:

  • (String) 


2120
2121
2122
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 2120

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:



2126
2127
2128
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 2126

def error_message
  @error_message
end

#error_time ⇒ String

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

Returns:

  • (String) 


2131
2132
2133
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 2131

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:



2137
2138
2139
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 2137

def help_links
  @help_links
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2144
2145
2146
2147
2148
2149
2150
 
# File 'lib/google/apis/vmmigration_v1alpha1/classes.rb', line 2144

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