Class: Openlayer::Models::Governance::RuleResultListResponse::Item

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

Defined Under Namespace

Modules: Status Classes: BlockedBy, Blocking

Instance Attribute Summary collapse

Class Method 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(id:, date_created:, date_updated:, deactivated:, rule_id:, status:, workspace_id:, assignee_id: nil, blocked_by: nil, blocking: nil, date_last_evaluated: nil, date_of_latest_evidence: nil, date_of_next_evaluation: nil, date_of_renewal: nil, deactivated_reason: nil, project_id: nil, status_message: nil) ⇒ Object

Parameters:

  • id (String) —

    The rule result id.

  • date_created (Time) —

    The creation date.

  • date_updated (Time) —

    The last update date.

  • deactivated (Boolean) —

    Whether this result is excluded from compliance calculations.

  • rule_id (String) —

    The rule this result belongs to.

  • status (Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::Status) —

    The compliance status of the rule for this entity.

  • workspace_id (String) —

    The id of the workspace the rule result belongs to.

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

    The user responsible for this result.

  • blocked_by (Array<Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy>) (defaults to: nil) —

    Rule results that must pass before this one can be satisfied.

  • blocking (Array<Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking>) (defaults to: nil) —

    Rule results that this one blocks.

  • date_last_evaluated (Time, nil) (defaults to: nil) —

    When the rule was last evaluated. Platform rules only.

  • date_of_latest_evidence (Time, nil) (defaults to: nil) —

    When the most recent piece of evidence was attached. Evidence rules only.

  • date_of_next_evaluation (Time, nil) (defaults to: nil) —

    When the rule will next be evaluated. Platform rules only.

  • date_of_renewal (Time, nil) (defaults to: nil) —

    When the evidence must be renewed. Evidence rules with a renewal cadence only.

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

    Why the result was excluded.

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

    The project this result was evaluated for. null for workspace-scoped rules.

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

    A human-readable explanation of the status.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/openlayer/models/governance/rule_result_list_response.rb', line 17

class Item < Openlayer::Internal::Type::BaseModel
  # @!attribute deactivated
  #   Whether this result is excluded from compliance calculations.
  #
  #   @return [Boolean]
  required :deactivated, Openlayer::Internal::Type::Boolean

  # @!attribute status
  #   The compliance status of the rule for this entity.
  #
  #   @return [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::Status]
  required :status, enum: -> { Openlayer::Models::Governance::RuleResultListResponse::Item::Status }

  # @!attribute assignee_id
  #   The user responsible for this result.
  #
  #   @return [String, nil]
  optional :assignee_id, String, api_name: :assigneeId, nil?: true

  # @!attribute blocked_by
  #   Rule results that must pass before this one can be satisfied.
  #
  #   @return [Array<Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy>, nil]
  optional :blocked_by,
           -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy] },
           api_name: :blockedBy

  # @!attribute blocking
  #   Rule results that this one blocks.
  #
  #   @return [Array<Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking>, nil]
  optional :blocking,
           -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking] }

  # @!attribute deactivated_reason
  #   Why the result was excluded.
  #
  #   @return [String, nil]
  optional :deactivated_reason, String, api_name: :deactivatedReason, nil?: true

  # @!attribute status_message
  #   A human-readable explanation of the status.
  #
  #   @return [String, nil]
  optional :status_message, String, api_name: :statusMessage, nil?: true

  response_only do
    # @!attribute id
    #   The rule result id.
    #
    #   @return [String]
    required :id, String

    # @!attribute date_created
    #   The creation date.
    #
    #   @return [Time]
    required :date_created, Time, api_name: :dateCreated

    # @!attribute date_updated
    #   The last update date.
    #
    #   @return [Time]
    required :date_updated, Time, api_name: :dateUpdated

    # @!attribute rule_id
    #   The rule this result belongs to.
    #
    #   @return [String]
    required :rule_id, String, api_name: :ruleId

    # @!attribute workspace_id
    #   The id of the workspace the rule result belongs to.
    #
    #   @return [String]
    required :workspace_id, String, api_name: :workspaceId

    # @!attribute date_last_evaluated
    #   When the rule was last evaluated. Platform rules only.
    #
    #   @return [Time, nil]
    optional :date_last_evaluated, Time, api_name: :dateLastEvaluated, nil?: true

    # @!attribute date_of_latest_evidence
    #   When the most recent piece of evidence was attached. Evidence rules only.
    #
    #   @return [Time, nil]
    optional :date_of_latest_evidence, Time, api_name: :dateOfLatestEvidence, nil?: true

    # @!attribute date_of_next_evaluation
    #   When the rule will next be evaluated. Platform rules only.
    #
    #   @return [Time, nil]
    optional :date_of_next_evaluation, Time, api_name: :dateOfNextEvaluation, nil?: true

    # @!attribute date_of_renewal
    #   When the evidence must be renewed. Evidence rules with a renewal cadence only.
    #
    #   @return [Time, nil]
    optional :date_of_renewal, Time, api_name: :dateOfRenewal, nil?: true

    # @!attribute project_id
    #   The project this result was evaluated for. `null` for workspace-scoped rules.
    #
    #   @return [String, nil]
    optional :project_id, String, api_name: :projectId, nil?: true
  end

  # @!method initialize(id:, date_created:, date_updated:, deactivated:, rule_id:, status:, workspace_id:, assignee_id: nil, blocked_by: nil, blocking: nil, date_last_evaluated: nil, date_of_latest_evidence: nil, date_of_next_evaluation: nil, date_of_renewal: nil, deactivated_reason: nil, project_id: nil, status_message: nil)
  #   @param id [String] The rule result id.
  #
  #   @param date_created [Time] The creation date.
  #
  #   @param date_updated [Time] The last update date.
  #
  #   @param deactivated [Boolean] Whether this result is excluded from compliance calculations.
  #
  #   @param rule_id [String] The rule this result belongs to.
  #
  #   @param status [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::Status] The compliance status of the rule for this entity.
  #
  #   @param workspace_id [String] The id of the workspace the rule result belongs to.
  #
  #   @param assignee_id [String, nil] The user responsible for this result.
  #
  #   @param blocked_by [Array<Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy>] Rule results that must pass before this one can be satisfied.
  #
  #   @param blocking [Array<Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking>] Rule results that this one blocks.
  #
  #   @param date_last_evaluated [Time, nil] When the rule was last evaluated. Platform rules only.
  #
  #   @param date_of_latest_evidence [Time, nil] When the most recent piece of evidence was attached. Evidence rules only.
  #
  #   @param date_of_next_evaluation [Time, nil] When the rule will next be evaluated. Platform rules only.
  #
  #   @param date_of_renewal [Time, nil] When the evidence must be renewed. Evidence rules with a renewal cadence only.
  #
  #   @param deactivated_reason [String, nil] Why the result was excluded.
  #
  #   @param project_id [String, nil] The project this result was evaluated for. `null` for workspace-scoped rules.
  #
  #   @param status_message [String, nil] A human-readable explanation of the status.

  # The compliance status of the rule for this entity.
  #
  # @see Openlayer::Models::Governance::RuleResultListResponse::Item#status
  module Status
    extend Openlayer::Internal::Type::Enum

    RUNNING = :running
    PASSING = :passing
    FAILING = :failing
    SKIPPED = :skipped
    ERROR = :error
    PENDING = :pending
    DUE_SOON = :due_soon

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  class BlockedBy < Openlayer::Internal::Type::BaseModel
    # @!attribute id
    #
    #   @return [String, nil]
    optional :id, String

    # @!attribute status
    #   The compliance status of the rule for this entity.
    #
    #   @return [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy::Status, nil]
    optional :status,
             enum: -> { Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy::Status }

    # @!method initialize(id: nil, status: nil)
    #   @param id [String]
    #
    #   @param status [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy::Status] The compliance status of the rule for this entity.

    # The compliance status of the rule for this entity.
    #
    # @see Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy#status
    module Status
      extend Openlayer::Internal::Type::Enum

      RUNNING = :running
      PASSING = :passing
      FAILING = :failing
      SKIPPED = :skipped
      ERROR = :error
      PENDING = :pending
      DUE_SOON = :due_soon

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  class Blocking < Openlayer::Internal::Type::BaseModel
    # @!attribute id
    #
    #   @return [String, nil]
    optional :id, String

    # @!attribute status
    #   The compliance status of the rule for this entity.
    #
    #   @return [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking::Status, nil]
    optional :status,
             enum: -> { Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking::Status }

    # @!method initialize(id: nil, status: nil)
    #   @param id [String]
    #
    #   @param status [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking::Status] The compliance status of the rule for this entity.

    # The compliance status of the rule for this entity.
    #
    # @see Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking#status
    module Status
      extend Openlayer::Internal::Type::Enum

      RUNNING = :running
      PASSING = :passing
      FAILING = :failing
      SKIPPED = :skipped
      ERROR = :error
      PENDING = :pending
      DUE_SOON = :due_soon

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end
end

Instance Attribute Details

#assignee_id ⇒ String?

The user responsible for this result.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


34
 
# File 'lib/openlayer/models/governance/rule_result_list_response.rb', line 34

optional :assignee_id, String, api_name: :assigneeId, nil?: true

#blocked_by ⇒ Array<Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy>?

Rule results that must pass before this one can be satisfied.

Returns:



40
41
42
 
# File 'lib/openlayer/models/governance/rule_result_list_response.rb', line 40

optional :blocked_by,
-> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy] },
api_name: :blockedBy

#blocking ⇒ Array<Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking>?

Rule results that this one blocks.

Returns:



48
49
 
# File 'lib/openlayer/models/governance/rule_result_list_response.rb', line 48

optional :blocking,
-> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking] }

#date_created ⇒ Time

Returns the value of attribute date_created.

Returns:

  • (Time) 


66
67
68
 
# File 'sig/openlayer/models/governance/rule_result_list_response.rbs', line 66

def date_created
  @date_created
end

#date_last_evaluated ⇒ Time?

Returns the value of attribute date_last_evaluated.

Returns:

  • (Time, nil) 


74
75
76
 
# File 'sig/openlayer/models/governance/rule_result_list_response.rbs', line 74

def date_last_evaluated
  @date_last_evaluated
end

#date_of_latest_evidence ⇒ Time?

Returns the value of attribute date_of_latest_evidence.

Returns:

  • (Time, nil) 


76
77
78
 
# File 'sig/openlayer/models/governance/rule_result_list_response.rbs', line 76

def date_of_latest_evidence
  @date_of_latest_evidence
end

#date_of_next_evaluation ⇒ Time?

Returns the value of attribute date_of_next_evaluation.

Returns:

  • (Time, nil) 


78
79
80
 
# File 'sig/openlayer/models/governance/rule_result_list_response.rbs', line 78

def date_of_next_evaluation
  @date_of_next_evaluation
end

#date_of_renewal ⇒ Time?

Returns the value of attribute date_of_renewal.

Returns:

  • (Time, nil) 


80
81
82
 
# File 'sig/openlayer/models/governance/rule_result_list_response.rbs', line 80

def date_of_renewal
  @date_of_renewal
end

#date_updated ⇒ Time

Returns the value of attribute date_updated.

Returns:

  • (Time) 


68
69
70
 
# File 'sig/openlayer/models/governance/rule_result_list_response.rbs', line 68

def date_updated
  @date_updated
end

#deactivated ⇒ Boolean

Whether this result is excluded from compliance calculations.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


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

required :deactivated, Openlayer::Internal::Type::Boolean

#deactivated_reason ⇒ String?

Why the result was excluded.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


55
 
# File 'lib/openlayer/models/governance/rule_result_list_response.rb', line 55

optional :deactivated_reason, String, api_name: :deactivatedReason, nil?: true

#id ⇒ String

Returns the value of attribute id.

Returns:

  • (String) 


64
65
66
 
# File 'sig/openlayer/models/governance/rule_result_list_response.rbs', line 64

def id
  @id
end

#project_id ⇒ String?

Returns the value of attribute project_id.

Returns:

  • (String, nil) 


82
83
84
 
# File 'sig/openlayer/models/governance/rule_result_list_response.rbs', line 82

def project_id
  @project_id
end

#rule_id ⇒ String

Returns the value of attribute rule_id.

Returns:

  • (String) 


70
71
72
 
# File 'sig/openlayer/models/governance/rule_result_list_response.rbs', line 70

def rule_id
  @rule_id
end

#status ⇒ Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::Status

The compliance status of the rule for this entity.

Parameters:

  • value (Openlayer::Models::Governance::RuleResultListResponse::Item::status)

Returns:



28
 
# File 'lib/openlayer/models/governance/rule_result_list_response.rb', line 28

required :status, enum: -> { Openlayer::Models::Governance::RuleResultListResponse::Item::Status }

#status_message ⇒ String?

A human-readable explanation of the status.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


61
 
# File 'lib/openlayer/models/governance/rule_result_list_response.rb', line 61

optional :status_message, String, api_name: :statusMessage, nil?: true

#workspace_id ⇒ String

Returns the value of attribute workspace_id.

Returns:

  • (String) 


72
73
74
 
# File 'sig/openlayer/models/governance/rule_result_list_response.rbs', line 72

def workspace_id
  @workspace_id
end

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openlayer/models/governance/rule_result_list_response.rb', line 174

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


104
 
# File 'sig/openlayer/models/governance/rule_result_list_response.rbs', line 104

def to_hash: -> {