Class: Comet::DestinationLocation

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

Overview

This type is available in Comet 17.3.3 and later.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeDestinationLocation

Returns a new instance of DestinationLocation.



193
194
195
# File 'lib/comet/models/destination_location.rb', line 193

def initialize
  clear
end

Instance Attribute Details

#azbaccount_keyObject

Returns the value of attribute azbaccount_key.



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

def azbaccount_key
  @azbaccount_key
end

#azbaccount_nameObject

Returns the value of attribute azbaccount_name.



128
129
130
# File 'lib/comet/models/destination_location.rb', line 128

def azbaccount_name
  @azbaccount_name
end

#azbcontainerObject

Returns the value of attribute azbcontainer.



134
135
136
# File 'lib/comet/models/destination_location.rb', line 134

def azbcontainer
  @azbcontainer
end

#azbprefixObject

Returns the value of attribute azbprefix.



141
142
143
# File 'lib/comet/models/destination_location.rb', line 141

def azbprefix
  @azbprefix
end

#azbrealmObject

The base URL for the Azure Blob Storage service. Leave blank to use the global default URL.



138
139
140
# File 'lib/comet/models/destination_location.rb', line 138

def azbrealm
  @azbrealm
end

#b2Object

Returns the value of attribute b2.



164
165
166
# File 'lib/comet/models/destination_location.rb', line 164

def b2
  @b2
end

#comet_bucketObject

Returns the value of attribute comet_bucket.



27
28
29
# File 'lib/comet/models/destination_location.rb', line 27

def comet_bucket
  @comet_bucket
end

#comet_bucket_keyObject

Returns the value of attribute comet_bucket_key.



30
31
32
# File 'lib/comet/models/destination_location.rb', line 30

def comet_bucket_key
  @comet_bucket_key
end

#comet_serverObject

The URL for the target Comet Server Storage Role, including http/https and trailing slash



24
25
26
# File 'lib/comet/models/destination_location.rb', line 24

def comet_server
  @comet_server
end

#destination_typeObject

One of the DESTINATIONTYPE_ constants



20
21
22
# File 'lib/comet/models/destination_location.rb', line 20

def destination_type
  @destination_type
end

#ftpaccept_invalid_sslObject

Returns the value of attribute ftpaccept_invalid_ssl.



125
126
127
# File 'lib/comet/models/destination_location.rb', line 125

def ftpaccept_invalid_ssl
  @ftpaccept_invalid_ssl
end

#ftpbase_use_home_directoryObject

If true, store data in the default home directory given by the FTP server. If false, store data in the FTPCustomBaseDirectory path.



107
108
109
# File 'lib/comet/models/destination_location.rb', line 107

def ftpbase_use_home_directory
  @ftpbase_use_home_directory
end

#ftpcustom_base_directoryObject

If FTPBaseUseHomeDirectory is false, this field controls the path where data is stored.



111
112
113
# File 'lib/comet/models/destination_location.rb', line 111

def ftpcustom_base_directory
  @ftpcustom_base_directory
end

#ftpmax_connectionsObject

If set to zero, uses a system default value that is not unlimited.



122
123
124
# File 'lib/comet/models/destination_location.rb', line 122

def ftpmax_connections
  @ftpmax_connections
end

#ftppasswordObject

Returns the value of attribute ftppassword.



102
103
104
# File 'lib/comet/models/destination_location.rb', line 102

def ftppassword
  @ftppassword
end

#ftpportObject

Returns the value of attribute ftpport.



118
119
120
# File 'lib/comet/models/destination_location.rb', line 118

def ftpport
  @ftpport
end

#ftpserverObject

Returns the value of attribute ftpserver.



96
97
98
# File 'lib/comet/models/destination_location.rb', line 96

def ftpserver
  @ftpserver
end

#ftpsmodeObject

Control whether this is plaintext FTP or secure FTPS by using one of the FTPS_MODE_ constants.



115
116
117
# File 'lib/comet/models/destination_location.rb', line 115

def ftpsmode
  @ftpsmode
end

#ftpusernameObject

Returns the value of attribute ftpusername.



99
100
101
# File 'lib/comet/models/destination_location.rb', line 99

def ftpusername
  @ftpusername
end

#localcopy_pathObject

Returns the value of attribute localcopy_path.



144
145
146
# File 'lib/comet/models/destination_location.rb', line 144

def localcopy_path
  @localcopy_path
end

#localcopy_win_smbpasswordObject

If logging in to a Windows network share (SMB/CIFS) is required, enter the password here. The password may be hashed as per the LocalcopyWinSMBPasswordFormat field.



153
154
155
# File 'lib/comet/models/destination_location.rb', line 153

def localcopy_win_smbpassword
  @localcopy_win_smbpassword
end

#localcopy_win_smbpassword_formatObject

One of the PASSWORD_FORMAT_ constants. It controls the hash format of the LocalcopyWinSMBPassword field.



158
159
160
# File 'lib/comet/models/destination_location.rb', line 158

def localcopy_win_smbpassword_format
  @localcopy_win_smbpassword_format
end

#localcopy_win_smbusernameObject

If logging in to a Windows network share (SMB/CIFS) is required, enter the username here.



148
149
150
# File 'lib/comet/models/destination_location.rb', line 148

def localcopy_win_smbusername
  @localcopy_win_smbusername
end

#s3access_keyObject

Returns the value of attribute s3access_key.



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

def s3access_key
  @s3access_key
end

#s3bucket_nameObject

Returns the value of attribute s3bucket_name.



45
46
47
# File 'lib/comet/models/destination_location.rb', line 45

def s3bucket_name
  @s3bucket_name
end

#s3custom_regionObject

Returns the value of attribute s3custom_region.



51
52
53
# File 'lib/comet/models/destination_location.rb', line 51

def s3custom_region
  @s3custom_region
end

#s3object_lock_daysObject

Returns the value of attribute s3object_lock_days.



61
62
63
# File 'lib/comet/models/destination_location.rb', line 61

def s3object_lock_days
  @s3object_lock_days
end

#s3remove_deletedObject

Returns the value of attribute s3remove_deleted.



58
59
60
# File 'lib/comet/models/destination_location.rb', line 58

def s3remove_deleted
  @s3remove_deleted
end

#s3secret_keyObject

Returns the value of attribute s3secret_key.



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

def s3secret_key
  @s3secret_key
end

#s3serverObject

Returns the value of attribute s3server.



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

def s3server
  @s3server
end

#s3subdirObject

Returns the value of attribute s3subdir.



48
49
50
# File 'lib/comet/models/destination_location.rb', line 48

def s3subdir
  @s3subdir
end

#s3uses_tlsObject

Returns the value of attribute s3uses_tls.



36
37
38
# File 'lib/comet/models/destination_location.rb', line 36

def s3uses_tls
  @s3uses_tls
end

#s3uses_v2signingObject

If true, use legacy v2 signing. If false (default), use modern v4 signing



55
56
57
# File 'lib/comet/models/destination_location.rb', line 55

def s3uses_v2signing
  @s3uses_v2signing
end

#sftpauth_modeObject

One of the DESTINATION_SFTP_AUTHMODE_ constants



75
76
77
# File 'lib/comet/models/destination_location.rb', line 75

def sftpauth_mode
  @sftpauth_mode
end

#sftpcustom_auth__known_hosts_fileObject

If SFTPCustomAuth_UseKnownHostFile is true, the path to the SSH known_hosts file.



93
94
95
# File 'lib/comet/models/destination_location.rb', line 93

def sftpcustom_auth__known_hosts_file
  @sftpcustom_auth__known_hosts_file
end

#sftpcustom_auth__use_known_hosts_fileObject

If true, then the SFTPCustomAuth_KnownHostsFile will be used to verify the remote SSH server’s host key, using Trust On First Use (TOFU).



89
90
91
# File 'lib/comet/models/destination_location.rb', line 89

def sftpcustom_auth__use_known_hosts_file
  @sftpcustom_auth__use_known_hosts_file
end

#sftppasswordObject

For use with DESTINATION_SFTP_AUTHMODE_PASSWORD only: the SSH password to connect with



79
80
81
# File 'lib/comet/models/destination_location.rb', line 79

def sftppassword
  @sftppassword
end

#sftpprivate_keyObject

For use with DESTINATION_SFTP_AUTHMODE_PRIVATEKEY only: the SSH private key to connect with, in OpenSSH format.



84
85
86
# File 'lib/comet/models/destination_location.rb', line 84

def sftpprivate_key
  @sftpprivate_key
end

#sftpremote_pathObject

The directory on the SFTP server in which data is stored.



71
72
73
# File 'lib/comet/models/destination_location.rb', line 71

def sftpremote_path
  @sftpremote_path
end

#sftpserverObject

Returns the value of attribute sftpserver.



64
65
66
# File 'lib/comet/models/destination_location.rb', line 64

def sftpserver
  @sftpserver
end

#sftpusernameObject

Returns the value of attribute sftpusername.



67
68
69
# File 'lib/comet/models/destination_location.rb', line 67

def sftpusername
  @sftpusername
end

#span_targetsObject

A list of underlying destinations, that will be combined and presented as one.



175
176
177
# File 'lib/comet/models/destination_location.rb', line 175

def span_targets
  @span_targets
end

#span_use_static_slotsObject

If true, this Spanned destination will use a consistent hashing scheme to immediately find specific files on exactly one of the target destinations. In the Static Slots mode, the span targets cannot be moved or merged, and the files must always remain in their original location.

If false, the Spanned destination system will search all targets to find the requested file. This is slightly slower, but allows you to freely merge, split, and reorder the underlying destination locations.

The default option is false.



188
189
190
# File 'lib/comet/models/destination_location.rb', line 188

def span_use_static_slots
  @span_use_static_slots
end

#storjObject

Returns the value of attribute storj.



171
172
173
# File 'lib/comet/models/destination_location.rb', line 171

def storj
  @storj
end

#swiftObject

Returns the value of attribute swift.



161
162
163
# File 'lib/comet/models/destination_location.rb', line 161

def swift
  @swift
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



191
192
193
# File 'lib/comet/models/destination_location.rb', line 191

def unknown_json_fields
  @unknown_json_fields
end

#web_davObject

This field is available in Comet 23.6.9 and later.



168
169
170
# File 'lib/comet/models/destination_location.rb', line 168

def web_dav
  @web_dav
end

Instance Method Details

#clearObject



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/comet/models/destination_location.rb', line 197

def clear
  @destination_type = 0
  @comet_server = ''
  @comet_bucket = ''
  @comet_bucket_key = ''
  @s3server = ''
  @s3access_key = ''
  @s3secret_key = ''
  @s3bucket_name = ''
  @s3subdir = ''
  @s3custom_region = ''
  @s3object_lock_days = 0
  @sftpserver = ''
  @sftpusername = ''
  @sftpremote_path = ''
  @sftpauth_mode = 0
  @sftppassword = ''
  @sftpprivate_key = ''
  @sftpcustom_auth__known_hosts_file = ''
  @ftpserver = ''
  @ftpusername = ''
  @ftppassword = ''
  @ftpcustom_base_directory = ''
  @ftpsmode = 0
  @ftpport = 0
  @ftpmax_connections = 0
  @azbaccount_name = ''
  @azbaccount_key = ''
  @azbcontainer = ''
  @azbrealm = ''
  @azbprefix = ''
  @localcopy_path = ''
  @localcopy_win_smbusername = ''
  @localcopy_win_smbpassword = ''
  @localcopy_win_smbpassword_format = 0
  @swift = Comet::SwiftDestinationLocation.new
  @b2 = Comet::B2DestinationLocation.new
  @web_dav = Comet::WebDavDestinationLocation.new
  @storj = Comet::StorjDestinationLocation.new
  @span_targets = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'lib/comet/models/destination_location.rb', line 248

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 'DestinationType'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

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

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

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

      @s3server = v
    when 'S3UsesTLS'
      @s3uses_tls = v
    when 'S3AccessKey'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

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

      @s3custom_region = v
    when 'S3UsesV2Signing'
      @s3uses_v2signing = v
    when 'S3RemoveDeleted'
      @s3remove_deleted = v
    when 'S3ObjectLockDays'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

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

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

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

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

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

      @sftpprivate_key = v
    when 'SFTPCustomAuth_UseKnownHostsFile'
      @sftpcustom_auth__use_known_hosts_file = v
    when 'SFTPCustomAuth_KnownHostsFile'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

      @ftppassword = v
    when 'FTPBaseUseHomeDirectory'
      @ftpbase_use_home_directory = v
    when 'FTPCustomBaseDirectory'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

      @ftpmax_connections = v
    when 'FTPAcceptInvalidSSL'
      @ftpaccept_invalid_ssl = v
    when 'AZBAccountName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

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

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

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

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

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

      @localcopy_win_smbpassword_format = v
    when 'Swift'
      @swift = Comet::SwiftDestinationLocation.new
      @swift.from_hash(v)
    when 'B2'
      @b2 = Comet::B2DestinationLocation.new
      @b2.from_hash(v)
    when 'WebDav'
      @web_dav = Comet::WebDavDestinationLocation.new
      @web_dav.from_hash(v)
    when 'Storj'
      @storj = Comet::StorjDestinationLocation.new
      @storj.from_hash(v)
    when 'SpanTargets'
      if v.nil?
        @span_targets = []
      else
        @span_targets = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @span_targets[i1] = Comet::DestinationLocation.new
          @span_targets[i1].from_hash(v1)
        end
      end
    when 'SpanUseStaticSlots'
      @span_use_static_slots = 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)


241
242
243
244
245
# File 'lib/comet/models/destination_location.rb', line 241

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_hHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



487
488
489
# File 'lib/comet/models/destination_location.rb', line 487

def to_h
  to_hash
end

#to_hashHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'lib/comet/models/destination_location.rb', line 432

def to_hash
  ret = {}
  ret['DestinationType'] = @destination_type
  ret['CometServer'] = @comet_server
  ret['CometBucket'] = @comet_bucket
  ret['CometBucketKey'] = @comet_bucket_key
  ret['S3Server'] = @s3server
  ret['S3UsesTLS'] = @s3uses_tls
  ret['S3AccessKey'] = @s3access_key
  ret['S3SecretKey'] = @s3secret_key
  ret['S3BucketName'] = @s3bucket_name
  ret['S3Subdir'] = @s3subdir
  ret['S3CustomRegion'] = @s3custom_region
  ret['S3UsesV2Signing'] = @s3uses_v2signing
  ret['S3RemoveDeleted'] = @s3remove_deleted
  ret['S3ObjectLockDays'] = @s3object_lock_days
  ret['SFTPServer'] = @sftpserver
  ret['SFTPUsername'] = @sftpusername
  ret['SFTPRemotePath'] = @sftpremote_path
  ret['SFTPAuthMode'] = @sftpauth_mode
  ret['SFTPPassword'] = @sftppassword
  ret['SFTPPrivateKey'] = @sftpprivate_key
  ret['SFTPCustomAuth_UseKnownHostsFile'] = @sftpcustom_auth__use_known_hosts_file
  ret['SFTPCustomAuth_KnownHostsFile'] = @sftpcustom_auth__known_hosts_file
  ret['FTPServer'] = @ftpserver
  ret['FTPUsername'] = @ftpusername
  ret['FTPPassword'] = @ftppassword
  ret['FTPBaseUseHomeDirectory'] = @ftpbase_use_home_directory
  ret['FTPCustomBaseDirectory'] = @ftpcustom_base_directory
  ret['FTPSMode'] = @ftpsmode
  ret['FTPPort'] = @ftpport
  ret['FTPMaxConnections'] = @ftpmax_connections
  ret['FTPAcceptInvalidSSL'] = @ftpaccept_invalid_ssl
  ret['AZBAccountName'] = @azbaccount_name
  ret['AZBAccountKey'] = @azbaccount_key
  ret['AZBContainer'] = @azbcontainer
  ret['AZBRealm'] = @azbrealm
  ret['AZBPrefix'] = @azbprefix
  ret['LocalcopyPath'] = @localcopy_path
  ret['LocalcopyWinSMBUsername'] = @localcopy_win_smbusername
  ret['LocalcopyWinSMBPassword'] = @localcopy_win_smbpassword
  ret['LocalcopyWinSMBPasswordFormat'] = @localcopy_win_smbpassword_format
  ret['Swift'] = @swift
  ret['B2'] = @b2
  ret['WebDav'] = @web_dav
  ret['Storj'] = @storj
  ret['SpanTargets'] = @span_targets
  ret['SpanUseStaticSlots'] = @span_use_static_slots
  @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



492
493
494
# File 'lib/comet/models/destination_location.rb', line 492

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