Class: Comet::B2DestinationLocation

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/b2destination_location.rb

Overview

Backblaze B2 native API (DESTINATIONTYPE_B2).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ B2DestinationLocation

Returns a new instance of B2DestinationLocation.



44
45
46
 
# File 'lib/comet/models/b2destination_location.rb', line 44

def initialize
  clear
end

Instance Attribute Details

#account_id ⇒ Object

Key ID



19
20
21
 
# File 'lib/comet/models/b2destination_location.rb', line 19

def 
  @account_id
end

#bucket ⇒ Object

Returns the value of attribute bucket.



26
27
28
 
# File 'lib/comet/models/b2destination_location.rb', line 26

def bucket
  @bucket
end

#hide_deleted_files ⇒ Object

Hide files instead of deleting them. This can be used for ransomware protection if (A) the B2 credentials have the hideFile permission but not the deleteFile permission, and (B) you use the Backblaze B2 server-side lifecycle policies to clean up old hidden files.



39
40
41
 
# File 'lib/comet/models/b2destination_location.rb', line 39

def hide_deleted_files
  @hide_deleted_files
end

#key ⇒ Object

Application Key



23
24
25
 
# File 'lib/comet/models/b2destination_location.rb', line 23

def key
  @key
end

#max_connections ⇒ Object

Deprecated.

This member has been deprecated since Comet version 21.9.7



33
34
35
 
# File 'lib/comet/models/b2destination_location.rb', line 33

def max_connections
  @max_connections
end

#prefix ⇒ Object

Returns the value of attribute prefix.



29
30
31
 
# File 'lib/comet/models/b2destination_location.rb', line 29

def prefix
  @prefix
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



42
43
44
 
# File 'lib/comet/models/b2destination_location.rb', line 42

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



48
49
50
51
52
53
54
55
 
# File 'lib/comet/models/b2destination_location.rb', line 48

def clear
  @account_id = ''
  @key = ''
  @bucket = ''
  @prefix = ''
  @max_connections = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
 
# File 'lib/comet/models/b2destination_location.rb', line 65

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'AccountID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @account_id = v
    when 'Key'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @key = v
    when 'Bucket'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @bucket = v
    when 'Prefix'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @prefix = v
    when 'MaxConnections'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @max_connections = v
    when 'HideDeletedFiles'
      @hide_deleted_files = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


58
59
60
61
62
 
# File 'lib/comet/models/b2destination_location.rb', line 58

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



126
127
128
 
# File 'lib/comet/models/b2destination_location.rb', line 126

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



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
 
# File 'lib/comet/models/b2destination_location.rb', line 99

def to_hash
  ret = {}
  unless @account_id.nil?
    ret['AccountID'] = @account_id
  end
  unless @key.nil?
    ret['Key'] = @key
  end
  unless @bucket.nil?
    ret['Bucket'] = @bucket
  end
  unless @prefix.nil?
    ret['Prefix'] = @prefix
  end
  unless @max_connections.nil?
    ret['MaxConnections'] = @max_connections
  end
  unless @hide_deleted_files.nil?
    ret['HideDeletedFiles'] = @hide_deleted_files
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



131
132
133
 
# File 'lib/comet/models/b2destination_location.rb', line 131

def to_json(options = {})
  to_hash.to_json(options)
end