Class: Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb,
sig/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbs

Overview

See Also:

  • Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper#data

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(id: nil, created_at: nil, meta_token: nil, meta_url: nil, name: nil, record_type: nil, region: nil, s3_bucket: nil, s3_endpoint: nil, status: nil, updated_at: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper::Data for more details.

A CloudFS filesystem, including its metadata credential. This shape is returned only by create and rotate-meta-token.

Parameters:

  • id (String) (defaults to: nil)
  • created_at (Time) (defaults to: nil)
  • meta_token (String) (defaults to: nil) —

    Metadata access token, in cleartext. Returned only by create and rotate-meta-tok

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

    PostgreSQL connection URL for the filesystem's metadata database. In create and

  • name (String) (defaults to: nil)
  • record_type (String) (defaults to: nil)
  • region (String) (defaults to: nil)
  • s3_bucket (String) (defaults to: nil) —

    Name of the bucket that stores this filesystem's data. Created during provisioni

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

    URL of the Telnyx Cloud Storage endpoint backing this filesystem.

  • status (Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus) (defaults to: nil) —

    Lifecycle status of the filesystem. ready means it is fully provisioned and us

  • updated_at (Time) (defaults to: nil) 



# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 96

Instance Attribute Details

#created_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


31
 
# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 31

optional :created_at, Time

#id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


26
 
# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 26

optional :id, String

#meta_token ⇒ String?

Metadata access token, in cleartext. Returned only by create and rotate-meta-token and not retrievable afterwards — store it securely.

Parameters:

  • (String)

Returns:

  • (String, nil) 


38
 
# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 38

optional :meta_token, String

#meta_url ⇒ String?

PostgreSQL connection URL for the filesystem's metadata database. In create and rotate-meta-token responses it embeds the metadata token as the password: postgres://<database>:<meta_token>@us-east-1.telnyxcloudfs.com:5432/<database>?sslmode=require (the example below is shown without the credential; the actual response includes it). Pass it to juicefs mount: the storage configuration is baked in at provisioning, so the metadata URL is all a client needs to mount the filesystem.

Parameters:

  • (String)

Returns:

  • (String, nil) 


49
 
# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 49

optional :meta_url, String

#name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


54
 
# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 54

optional :name, String

#record_type ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


59
 
# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 59

optional :record_type, String

#region ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


64
 
# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 64

optional :region, String

#s3_bucket ⇒ String?

Name of the bucket that stores this filesystem's data. Created during provisioning.

Parameters:

  • (String)

Returns:

  • (String, nil) 


71
 
# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 71

optional :s3_bucket, String

#s3_endpoint ⇒ String?

URL of the Telnyx Cloud Storage endpoint backing this filesystem.

Parameters:

  • (String)

Returns:

  • (String, nil) 


77
 
# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 77

optional :s3_endpoint, String

#status ⇒ Symbol, ...

Lifecycle status of the filesystem. ready means it is fully provisioned and usable. needs_format means the storage bucket and metadata database were provisioned but the filesystem has not yet been formatted — run juicefs format with the filesystem's meta_url before mounting. failed means the last lifecycle action failed — see the filesystem's error message. deleted appears only in the delete response: deleted filesystems are excluded from list results and return a 404 on retrieval.

Returns:



89
 
# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 89

optional :status, enum: -> { Telnyx::Storage::CloudfsFilesystemStatus }

#updated_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


94
 
# File 'lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb', line 94

optional :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


98
 
# File 'sig/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbs', line 98

def to_hash: -> {