Class: Openlayer::Models::Governance::FrameworkExportResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openlayer/models/governance/framework_export_response.rb,
sig/openlayer/models/governance/framework_export_response.rbs

Overview

See Also:

  • Openlayer::Resources::Governance::Frameworks#export

Instance Attribute Summary collapse

Instance Method Summary collapse

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(task_result_id:, task_result_url:) ⇒ Object

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

Parameters:

  • task_result_id (String) —

    The background task id, for GET /background-tasks/{taskId}.

  • task_result_url (String) —

    The path to poll for this export's status and result. Already /v1-prefixed, so



# File 'lib/openlayer/models/governance/framework_export_response.rb', line 22

Instance Attribute Details

#task_result_id ⇒ String

The background task id, for GET /background-tasks/{taskId}.

Parameters:

  • value (String)

Returns:

  • (String)


12
# File 'lib/openlayer/models/governance/framework_export_response.rb', line 12

required :task_result_id, String, api_name: :taskResultId

#task_result_url ⇒ String

The path to poll for this export's status and result. Already /v1-prefixed, so it is relative to the API host rather than to the /v1 base url -- or just pass taskResultId to GET /background-tasks/{taskId}.

Parameters:

  • value (String)

Returns:

  • (String)


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

required :task_result_url, String, api_name: :taskResultUrl

Instance Method Details

#to_hash ⇒ { task_result_id: String, task_result_url: String }

Returns:

  • ({ task_result_id: String, task_result_url: String })


17
# File 'sig/openlayer/models/governance/framework_export_response.rbs', line 17

def to_hash: -> { task_result_id: String, task_result_url: String }