Class: Stigg::Models::V1::Events::DataExportTriggerSyncResponse::Data::Result

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/events/data_export_trigger_sync_response.rb

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(destination_id:, triggered:, error_message: nil, transfer_id: nil) ⇒ Object

Per-destination trigger results.

Parameters:

  • destination_id (String) —

    Provider destination ID

  • triggered (Boolean) —

    True if a transfer was kicked

  • error_message (String) (defaults to: nil) —

    Error message if triggered=false on a hard failure

  • transfer_id (String) (defaults to: nil) —

    Provider-side transfer ID



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/stigg/models/v1/events/data_export_trigger_sync_response.rb', line 34

class Result < Stigg::Internal::Type::BaseModel
  # @!attribute destination_id
  #   Provider destination ID
  #
  #   @return [String]
  required :destination_id, String, api_name: :destinationId

  # @!attribute triggered
  #   True if a transfer was kicked
  #
  #   @return [Boolean]
  required :triggered, Stigg::Internal::Type::Boolean

  # @!attribute error_message
  #   Error message if triggered=false on a hard failure
  #
  #   @return [String, nil]
  optional :error_message, String, api_name: :errorMessage

  # @!attribute transfer_id
  #   Provider-side transfer ID
  #
  #   @return [String, nil]
  optional :transfer_id, String, api_name: :transferId

  # @!method initialize(destination_id:, triggered:, error_message: nil, transfer_id: nil)
  #   Per-destination trigger results.
  #
  #   @param destination_id [String] Provider destination ID
  #
  #   @param triggered [Boolean] True if a transfer was kicked
  #
  #   @param error_message [String] Error message if triggered=false on a hard failure
  #
  #   @param transfer_id [String] Provider-side transfer ID
end

Instance Attribute Details

#destination_id ⇒ String

Provider destination ID

Returns:

  • (String) 


39
 
# File 'lib/stigg/models/v1/events/data_export_trigger_sync_response.rb', line 39

required :destination_id, String, api_name: :destinationId

#error_message ⇒ String?

Error message if triggered=false on a hard failure

Returns:

  • (String, nil) 


51
 
# File 'lib/stigg/models/v1/events/data_export_trigger_sync_response.rb', line 51

optional :error_message, String, api_name: :errorMessage

#transfer_id ⇒ String?

Provider-side transfer ID

Returns:

  • (String, nil) 


57
 
# File 'lib/stigg/models/v1/events/data_export_trigger_sync_response.rb', line 57

optional :transfer_id, String, api_name: :transferId

#triggered ⇒ Boolean

True if a transfer was kicked

Returns:

  • (Boolean) 


45
 
# File 'lib/stigg/models/v1/events/data_export_trigger_sync_response.rb', line 45

required :triggered, Stigg::Internal::Type::Boolean