Class: Openlayer::Models::Governance::RuleResultCreateEvidenceParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openlayer/models/governance/rule_result_create_evidence_params.rb,
sig/openlayer/models/governance/rule_result_create_evidence_params.rbs

Overview

See Also:

  • Openlayer::Resources::Governance::RuleResults#create_evidence

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Openlayer

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(rule_result_id:, description: nil, name: nil, storage_uri: nil, text: nil, url: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Openlayer::Models::Governance::RuleResultCreateEvidenceParams for more details.

Parameters:

  • rule_result_id (String)
  • description (String, nil) (defaults to: nil) —

    A description of what the evidence shows.

  • name (String, nil) (defaults to: nil) —

    The evidence name.

  • storage_uri (String, nil) (defaults to: nil) —

    Where the uploaded file is stored. Set when the rule's evidenceType is `docume

  • text (String, nil) (defaults to: nil) —

    The evidence text. Set when the rule's evidenceType is text.

  • url (String, nil) (defaults to: nil) —

    A link to the evidence. Set when the rule's evidenceType is url.

  • request_options (Openlayer::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/openlayer/models/governance/rule_result_create_evidence_params.rb', line 47

Instance Attribute Details

#description ⇒ String?

A description of what the evidence shows.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


20
 
# File 'lib/openlayer/models/governance/rule_result_create_evidence_params.rb', line 20

optional :description, String, nil?: true

#name ⇒ String?

The evidence name.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


26
 
# File 'lib/openlayer/models/governance/rule_result_create_evidence_params.rb', line 26

optional :name, String, nil?: true

#rule_result_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/openlayer/models/governance/rule_result_create_evidence_params.rb', line 14

required :rule_result_id, String

#storage_uri ⇒ String?

Where the uploaded file is stored. Set when the rule's evidenceType is document.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


33
 
# File 'lib/openlayer/models/governance/rule_result_create_evidence_params.rb', line 33

optional :storage_uri, String, api_name: :storageUri, nil?: true

#text ⇒ String?

The evidence text. Set when the rule's evidenceType is text.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


39
 
# File 'lib/openlayer/models/governance/rule_result_create_evidence_params.rb', line 39

optional :text, String, nil?: true

#url ⇒ String?

A link to the evidence. Set when the rule's evidenceType is url.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


45
 
# File 'lib/openlayer/models/governance/rule_result_create_evidence_params.rb', line 45

optional :url, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


41
 
# File 'sig/openlayer/models/governance/rule_result_create_evidence_params.rbs', line 41

def to_hash: -> {