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.



1967
1968
1969
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1967

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:



1943
1944
1945
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1943

def action_item
  @action_item
end

#code ⇒ String

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

Returns:

  • (String) 


1948
1949
1950
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1948

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:



1954
1955
1956
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1954

def error_message
  @error_message
end

#error_time ⇒ String

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

Returns:

  • (String) 


1959
1960
1961
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1959

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:



1965
1966
1967
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1965

def help_links
  @help_links
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1972
1973
1974
1975
1976
1977
1978
 
# File 'lib/google/apis/vmmigration_v1/classes.rb', line 1972

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