Class: Knockapi::Models::BulkOperation

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/bulk_operation.rb

Overview

See Also:

Defined Under Namespace

Modules: Status Classes: ErrorItem

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:, _typename:, estimated_total_rows:, inserted_at:, name:, processed_rows:, status:, success_count:, updated_at:, completed_at: nil, error_count: nil, error_items: nil, failed_at: nil, progress_path: nil, started_at: nil) ⇒ Object

A bulk operation entity.

Parameters:

  • id (String) —

    Unique identifier for the bulk operation.

  • _typename (String) —

    The typename of the schema.

  • estimated_total_rows (Integer) —

    The estimated total number of rows to process.

  • inserted_at (Time) —

    Timestamp when the resource was created.

  • name (String) —

    The name of the bulk operation.

  • processed_rows (Integer) —

    The number of rows processed so far.

  • status (Symbol, Knockapi::Models::BulkOperation::Status) —

    The status of the bulk operation.

  • success_count (Integer) —

    The number of successful operations.

  • updated_at (Time) —

    The timestamp when the resource was last updated.

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

    Timestamp when the bulk operation was completed.

  • error_count (Integer) (defaults to: nil) —

    The number of failed operations.

  • error_items (Array<Knockapi::Models::BulkOperation::ErrorItem>) (defaults to: nil) —

    A list of items that failed to be processed.

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

    Timestamp when the bulk operation failed.

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

    The URI to the bulk operation’s progress.

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

    Timestamp when the bulk operation was started.




# File 'lib/knockapi/models/bulk_operation.rb', line 97

Instance Attribute Details

#_typename ⇒ String

The typename of the schema.

Returns:

  • (String) 


17
 
# File 'lib/knockapi/models/bulk_operation.rb', line 17

required :_typename, String, api_name: :__typename

#completed_at ⇒ Time?

Timestamp when the bulk operation was completed.

Returns:

  • (Time, nil) 


65
 
# File 'lib/knockapi/models/bulk_operation.rb', line 65

optional :completed_at, Time, nil?: true

#error_count ⇒ Integer?

The number of failed operations.

Returns:

  • (Integer, nil) 


71
 
# File 'lib/knockapi/models/bulk_operation.rb', line 71

optional :error_count, Integer

#error_items ⇒ Array<Knockapi::Models::BulkOperation::ErrorItem>?

A list of items that failed to be processed.

Returns:



77
 
# File 'lib/knockapi/models/bulk_operation.rb', line 77

optional :error_items, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::BulkOperation::ErrorItem] }

#estimated_total_rows ⇒ Integer

The estimated total number of rows to process.

Returns:

  • (Integer) 


23
 
# File 'lib/knockapi/models/bulk_operation.rb', line 23

required :estimated_total_rows, Integer

#failed_at ⇒ Time?

Timestamp when the bulk operation failed.

Returns:

  • (Time, nil) 


83
 
# File 'lib/knockapi/models/bulk_operation.rb', line 83

optional :failed_at, Time, nil?: true

#id ⇒ String

Unique identifier for the bulk operation.

Returns:

  • (String) 


11
 
# File 'lib/knockapi/models/bulk_operation.rb', line 11

required :id, String

#inserted_at ⇒ Time

Timestamp when the resource was created.

Returns:

  • (Time) 


29
 
# File 'lib/knockapi/models/bulk_operation.rb', line 29

required :inserted_at, Time

#name ⇒ String

The name of the bulk operation.

Returns:

  • (String) 


35
 
# File 'lib/knockapi/models/bulk_operation.rb', line 35

required :name, String

#processed_rows ⇒ Integer

The number of rows processed so far.

Returns:

  • (Integer) 


41
 
# File 'lib/knockapi/models/bulk_operation.rb', line 41

required :processed_rows, Integer

#progress_path ⇒ String?

The URI to the bulk operation’s progress.

Returns:

  • (String, nil) 


89
 
# File 'lib/knockapi/models/bulk_operation.rb', line 89

optional :progress_path, String

#started_at ⇒ Time?

Timestamp when the bulk operation was started.

Returns:

  • (Time, nil) 


95
 
# File 'lib/knockapi/models/bulk_operation.rb', line 95

optional :started_at, Time, nil?: true

#status ⇒ Symbol, Knockapi::Models::BulkOperation::Status

The status of the bulk operation.

Returns:



47
 
# File 'lib/knockapi/models/bulk_operation.rb', line 47

required :status, enum: -> { Knockapi::BulkOperation::Status }

#success_count ⇒ Integer

The number of successful operations.

Returns:

  • (Integer) 


53
 
# File 'lib/knockapi/models/bulk_operation.rb', line 53

required :success_count, Integer

#updated_at ⇒ Time

The timestamp when the resource was last updated.

Returns:

  • (Time) 


59
 
# File 'lib/knockapi/models/bulk_operation.rb', line 59

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/knockapi/models/bulk_operation.rb', line 141