Class: Cadenya::Models::UploadInfo

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/cadenya/models/upload_info.rb,
sig/cadenya/models/upload_info.rbs

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(created_by: nil, status: nil, upload_url: nil, upload_url_expires_at: nil) ⇒ Object

Some parameter documentations has been truncated, see Cadenya::Models::UploadInfo for more details.

Parameters:

  • created_by (Cadenya::Models::Profile) (defaults to: nil) —

    A profile identifies a user or non-human principal (such as an API key)

  • status (Symbol, Cadenya::Models::UploadInfo::Status) (defaults to: nil) —

    Lifecycle state. Transitions PENDING → COMPLETE (storage confirms the

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

    Presigned PUT URL. Short-lived. The client must PUT with the exact

  • upload_url_expires_at (Time) (defaults to: nil) —

    Absolute time at which upload_url stops working.




# File 'lib/cadenya/models/upload_info.rb', line 37

Instance Attribute Details

#created_by ⇒ Cadenya::Models::Profile?

A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces.

Parameters:

Returns:



12
 
# File 'lib/cadenya/models/upload_info.rb', line 12

optional :created_by, -> { Cadenya::Profile }, api_name: :createdBy

#status ⇒ Cadenya::Models::UploadInfo::status? (readonly)

Returns the value of attribute status.

Returns:

  • (Cadenya::Models::UploadInfo::status, nil) 


16
17
18
 
# File 'sig/cadenya/models/upload_info.rbs', line 16

def status
  @status
end

#upload_url ⇒ String? (readonly)

Returns the value of attribute upload_url.

Returns:

  • (String, nil) 


22
23
24
 
# File 'sig/cadenya/models/upload_info.rbs', line 22

def upload_url
  @upload_url
end

#upload_url_expires_at ⇒ Time? (readonly)

Returns the value of attribute upload_url_expires_at.

Returns:

  • (Time, nil) 


26
27
28
 
# File 'sig/cadenya/models/upload_info.rbs', line 26

def upload_url_expires_at
  @upload_url_expires_at
end

Instance Method Details

#status= ⇒ Object (readonly) 



18
 
# File 'sig/cadenya/models/upload_info.rbs', line 18

def status=: (

#to_hash ⇒ {

Returns:

  • ({) 


37
 
# File 'sig/cadenya/models/upload_info.rbs', line 37

def to_hash: -> {

#upload_url= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


24
 
# File 'sig/cadenya/models/upload_info.rbs', line 24

def upload_url=: (String) -> String

#upload_url_expires_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


28
 
# File 'sig/cadenya/models/upload_info.rbs', line 28

def upload_url_expires_at=: (Time) -> Time