Class: SafetyKit::Models::DataGetDownloadURLResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/safety_kit/models/data_get_download_url_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Status

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(data_count:, data_expires_at:, data_url:, namespace:, request_id:, status:) ⇒ Object

Some parameter documentations has been truncated, see SafetyKit::Models::DataGetDownloadURLResponse for more details.

Response containing request status and a temporary S3 URL for the full request result. The shape is stable across all request sizes; before processing completes, the download fields are null.

Parameters:

  • data_count (Integer, nil) —

    Number of processed objects in the request. Null until the request has succeeded

  • data_expires_at (String, nil) —

    ISO timestamp when ‘data_url` expires. Null until the request has succeeded.

  • data_url (String, nil) —

    Temporary S3 URL for the full request result. Null until the request has succeed

  • namespace (String)
  • request_id (String)
  • status (Symbol, SafetyKit::Models::DataGetDownloadURLResponse::Status) —

    Current processing status of the request




# File 'lib/safety_kit/models/data_get_download_url_response.rb', line 43

Instance Attribute Details

#data_count ⇒ Integer?

Number of processed objects in the request. Null until the request has succeeded.

Returns:

  • (Integer, nil) 


12
 
# File 'lib/safety_kit/models/data_get_download_url_response.rb', line 12

required :data_count, Integer, nil?: true

#data_expires_at ⇒ String?

ISO timestamp when ‘data_url` expires. Null until the request has succeeded.

Returns:

  • (String, nil) 


18
 
# File 'lib/safety_kit/models/data_get_download_url_response.rb', line 18

required :data_expires_at, String, nil?: true

#data_url ⇒ String?

Temporary S3 URL for the full request result. Null until the request has succeeded.

Returns:

  • (String, nil) 


25
 
# File 'lib/safety_kit/models/data_get_download_url_response.rb', line 25

required :data_url, String, nil?: true

#namespace ⇒ String

Returns:

  • (String) 


30
 
# File 'lib/safety_kit/models/data_get_download_url_response.rb', line 30

required :namespace, String

#request_id ⇒ String

Returns:

  • (String) 


35
 
# File 'lib/safety_kit/models/data_get_download_url_response.rb', line 35

required :request_id, String

#status ⇒ Symbol, SafetyKit::Models::DataGetDownloadURLResponse::Status

Current processing status of the request

Returns:



41
 
# File 'lib/safety_kit/models/data_get_download_url_response.rb', line 41

required :status, enum: -> { SafetyKit::Models::DataGetDownloadURLResponse::Status }