Class: AWSCDK::ValidationResult

Inherits:
Jsii::Object
  • Object
show all
Defined in:
validation_result.rb

Overview

Representation of validation results.

Models a tree of validation errors so that we have as much information as possible about the failure that occurred.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(error_message = nil, results = nil) ⇒ ValidationResult

Returns a new instance of ValidationResult.

Parameters:



13
14
15
16
17
 
# File 'validation_result.rb', line 13

def initialize(error_message = nil, results = nil)
  Jsii::Type.check_type(error_message, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "errorMessage") unless error_message.nil?
  Jsii::Type.check_type(results, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5WYWxpZGF0aW9uUmVzdWx0cyJ9")), "results") unless results.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(error_message, results)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



19
20
21
22
23
24
25
26
27
28
 
# File 'validation_result.rb', line 19

def self.jsii_overridable_methods
  {
    :error_message => { kind: :property, name: "errorMessage", is_optional: false },
    :is_success => { kind: :property, name: "isSuccess", is_optional: false },
    :results => { kind: :property, name: "results", is_optional: false },
    :assert_success => { kind: :method, name: "assertSuccess", is_optional: false },
    :error_tree => { kind: :method, name: "errorTree", is_optional: false },
    :prefix => { kind: :method, name: "prefix", is_optional: false },
  }
end

Instance Method Details

#assert_success ⇒ void

This method returns an undefined value.

Turn a failed validation into an exception.



48
49
50
 
# File 'validation_result.rb', line 48

def assert_success()
  jsii_call_method("assertSuccess", [])
end

#error_message ⇒ String

Returns:

  • (String) 


31
32
33
 
# File 'validation_result.rb', line 31

def error_message()
  jsii_get_property("errorMessage")
end

#error_tree ⇒ String

Return a string rendering of the tree of validation failures.

Returns:

  • (String) 


55
56
57
 
# File 'validation_result.rb', line 55

def error_tree()
  jsii_call_method("errorTree", [])
end

#is_success ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'validation_result.rb', line 36

def is_success()
  jsii_get_property("isSuccess")
end

#prefix(message) ⇒ AWSCDK::ValidationResult

Wrap this result with an error message, if it concerns an error.

Parameters:

  • message (String)

Returns:

  • (AWSCDK::ValidationResult) 


63
64
65
66
 
# File 'validation_result.rb', line 63

def prefix(message)
  Jsii::Type.check_type(message, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "message")
  jsii_call_method("prefix", [message])
end

#results ⇒ AWSCDK::ValidationResults

Returns:



41
42
43
 
# File 'validation_result.rb', line 41

def results()
  jsii_get_property("results")
end