isilon 1.0.0

Isilon rest api bindings
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
97
98
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
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
239
240
241
242
243
244
245
246
247
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
430
431
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
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# \NamespaceApi

All URIs are relative to *https://YOUR_CLUSTER_HOSTNAME_OR_NODE_IP:8080*

Method | HTTP request | Description
------------- | ------------- | -------------
[**copy_directory**]NamespaceApi.md#copy_directory | **Put** /namespace/{DirectoryCopyTarget} | 
[**copy_file**]NamespaceApi.md#copy_file | **Put** /namespace/{FileCopyTarget} | 
[**create_access_point**]NamespaceApi.md#create_access_point | **Put** /namespace/{AccessPointName} | 
[**create_directory**]NamespaceApi.md#create_directory | **Put** /namespace/{DirectoryPath} | 
[**create_file**]NamespaceApi.md#create_file | **Put** /namespace/{FilePath} | 
[**delete_access_point**]NamespaceApi.md#delete_access_point | **Delete** /namespace/{AccessPointName} | 
[**delete_directory**]NamespaceApi.md#delete_directory | **Delete** /namespace/{DirectoryPath} | 
[**delete_file**]NamespaceApi.md#delete_file | **Delete** /namespace/{FilePath} | 
[**get_acl**]NamespaceApi.md#get_acl | **Get** /namespace/{NamespacePath} | 
[**get_directory_attributes**]NamespaceApi.md#get_directory_attributes | **Head** /namespace/{DirectoryPath} | 
[**get_directory_contents**]NamespaceApi.md#get_directory_contents | **Get** /namespace/{DirectoryPath} | 
[**get_directory_metadata**]NamespaceApi.md#get_directory_metadata | **Get** /namespace/{DirectoryMetadataPath} | 
[**get_file_attributes**]NamespaceApi.md#get_file_attributes | **Head** /namespace/{FilePath} | 
[**get_file_contents**]NamespaceApi.md#get_file_contents | **Get** /namespace/{FilePath} | 
[**get_file_metadata**]NamespaceApi.md#get_file_metadata | **Get** /namespace/{FileMetadataPath} | 
[**get_worm_properties**]NamespaceApi.md#get_worm_properties | **Get** /namespace/{WormFilePath} | 
[**list_access_points**]NamespaceApi.md#list_access_points | **Get** /namespace | 
[**move_directory**]NamespaceApi.md#move_directory | **Post** /namespace/{DirectoryPath} | 
[**move_file**]NamespaceApi.md#move_file | **Post** /namespace/{FilePath} | 
[**query_directory**]NamespaceApi.md#query_directory | **Post** /namespace/{QueryPath} | 
[**set_acl**]NamespaceApi.md#set_acl | **Put** /namespace/{NamespacePath} | 
[**set_directory_metadata**]NamespaceApi.md#set_directory_metadata | **Put** /namespace/{DirectoryMetadataPath} | 
[**set_file_metadata**]NamespaceApi.md#set_file_metadata | **Put** /namespace/{FileMetadataPath} | 
[**set_worm_properties**]NamespaceApi.md#set_worm_properties | **Put** /namespace/{WormFilePath} | 


# **copy_directory**
> ::models::CopyErrors copy_directory(ctx, directory_copy_target, x_isi_ifs_copy_source, optional)


Recursively copies a directory to a specified destination path. Symbolic links are copied as regular files.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **directory_copy_target** | **String**| Directory copy destination relative to /. | 
  **x_isi_ifs_copy_source** | **String**| Specifies the full path to the source directory. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **directory_copy_target** | **String**| Directory copy destination relative to /. | 
 **x_isi_ifs_copy_source** | **String**| Specifies the full path to the source directory. | 
 **overwrite** | **bool**| Deletes and replaces the existing user attributes and ACLs of the directory with user-specified attributes and ACLS from the header, when set to true. | 
 **merge** | **bool**| Specifies if the contents of a directory should be merged with an existing directory with the same name. | 
 **_continue** | **bool**| Specifies whether to continue the copy operation on remaining objects when there is a conflict or error. | 

### Return type

[**::models::CopyErrors**](CopyErrors.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **copy_file**
> ::models::CopyErrors copy_file(ctx, file_copy_target, x_isi_ifs_copy_source, optional)


Copies a file to the specified destination path.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **file_copy_target** | **String**| File copy destination relative to /. | 
  **x_isi_ifs_copy_source** | **String**| Specifies the full path to the source file. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **file_copy_target** | **String**| File copy destination relative to /. | 
 **x_isi_ifs_copy_source** | **String**| Specifies the full path to the source file. | 
 **clone** | **bool**| You must set this parameter to true in order to clone a file. | 
 **snapshot** | **String**| Specifies a snapshot name to clone the file from. | 
 **overwrite** | **bool**| Specifies if an existing file should be overwritten by a new file with the same name. | 

### Return type

[**::models::CopyErrors**](CopyErrors.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_access_point**
> ::models::Empty create_access_point(ctx, access_point_name, access_point)


Creates a namespace access point in the file system. Only root users can create or change namespace access points.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **access_point_name** | **String**| Access point name. | 
  **access_point** | [**AccessPointCreateParams**]AccessPointCreateParams.md| Access point parameters model. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_directory**
> ::models::Empty create_directory(ctx, directory_path, x_isi_ifs_target_type, optional)


Creates a directory with a specified path.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **directory_path** | **String**| Directory path relative to /. | 
  **x_isi_ifs_target_type** | **String**| Specifies the resource type. | [default to container]
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **directory_path** | **String**| Directory path relative to /. | 
 **x_isi_ifs_target_type** | **String**| Specifies the resource type. | [default to container]
 **x_isi_ifs_access_control** | **String**| Specifies a pre-defined ACL value or POSIX mode with a string in octal string format. | [default to 0700]
 **x_isi_ifs_node_pool_name** | **String**| Specifies a pre-defined ACL value or POSIX mode with a string. | 
 **recursive** | **bool**| Specifies the OneFS node pool name. | 
 **overwrite** | **bool**| Deletes and replaces the existing user attributes and ACLs of the directory with user-specified attributes and ACLS from the header, when set to true. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_file**
> ::models::Empty create_file(ctx, file_path, x_isi_ifs_target_type, file_contents, optional)


Creates a file object with a given path. Note that file streaming is not supported.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **file_path** | **String**| File path relative to /. | 
  **x_isi_ifs_target_type** | **String**| Specifies the resource type. | [default to object]
  **file_contents** | **String**| The contents of the file object. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **file_path** | **String**| File path relative to /. | 
 **x_isi_ifs_target_type** | **String**| Specifies the resource type. | [default to object]
 **file_contents** | **String**| The contents of the file object. | 
 **x_isi_ifs_access_control** | **String**| Specifies a pre-defined ACL value or POSIX mode with a string in octal string format. | [default to 0600]
 **content_encoding** | **String**| Specifies the content encoding that was applied to the object content, so that decoding can be applied when retrieving the content. | 
 **content_type** | **String**| Specifies a standard MIME-type description of the content format. | [default to binary/octet-stream]
 **overwrite** | **bool**| Deletes and replaces the existing user attributes and ACLs of the directory with user-specified attributes and ACLS from the header, when set to true. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_access_point**
> ::models::Empty delete_access_point(ctx, access_point_name)


Deletes a namespace access point. Only root users can delete namespace access points.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **access_point_name** | **String**| Access point name. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_directory**
> ::models::Empty delete_directory(ctx, directory_path, optional)


Deletes the directory at the specified path.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **directory_path** | **String**| Directory path relative to /. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **directory_path** | **String**| Directory path relative to /. | 
 **recursive** | **bool**| Deletes directories recursively, when set to true. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_file**
> ::models::Empty delete_file(ctx, file_path)


Deletes the specified file.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **file_path** | **String**| File path relative to /. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_acl**
> ::models::NamespaceAcl get_acl(ctx, namespace_path, acl, optional)


Retrieves the access control list for a namespace object.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **namespace_path** | **String**| Namespace path relative to /. | 
  **acl** | **bool**| Show access control lists. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **namespace_path** | **String**| Namespace path relative to /. | 
 **acl** | **bool**| Show access control lists. | 
 **nsaccess** | **bool**| Indicates that the operation is on the access point instead of the store path. | 

### Return type

[**::models::NamespaceAcl**](NamespaceAcl.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_directory_attributes**
> ::models::Empty get_directory_attributes(ctx, directory_path, optional)


Retrieves the attribute information for a specified directory without transferring the contents of the directory.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **directory_path** | **String**| Directory path relative to /. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **directory_path** | **String**| Directory path relative to /. | 
 **if_modified_since** | **String**| Returns only files that were modified since the specified time. If no files were modified since this time, a 304 message is returned. | 
 **if_unmodified_since** | **String**| Returns only files that were not modified since the specified time. If there are no unmodified files since this time, a 412 message is returned to indicate that the precondition failed. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_directory_contents**
> ::models::NamespaceObjects get_directory_contents(ctx, directory_path, optional)


Retrieves a list of files and subdirectories from a directory.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **directory_path** | **String**| Directory path relative to /. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **directory_path** | **String**| Directory path relative to /. | 
 **detail** | **String**| Specifies which object attributes are displayed. | 
 **limit** | **i32**| Specifies the maximum number of objects to send to the client. | 
 **resume** | **String**| Specifies a token to return in the JSON result to indicate when there is a next page. | 
 **sort** | **String**| Specifies one or more attributes to sort on the directory entries. | 
 **dir** | **String**| Specifies the sort direction. This value can be either ascending (ASC) or descending (DESC). | 
 **_type** | **String**| Specifies the object type to return, which can be one of the following values: container, object, pipe, character_device, block_device, symbolic_link, socket, or whiteout_file. | 
 **hidden** | **bool**| Specifies if hidden objects are returned. | 

### Return type

[**::models::NamespaceObjects**](NamespaceObjects.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_directory_metadata**
> ::models::NamespaceMetadataList get_directory_metadata(ctx, directory_metadata_path, metadata)


Retrieves the attribute information for a specified directory with the metadata query argument.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **directory_metadata_path** | **String**| Directory path relative to /. | 
  **metadata** | **bool**| Show directory metadata. | 

### Return type

[**::models::NamespaceMetadataList**](NamespaceMetadataList.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_file_attributes**
> ::models::Empty get_file_attributes(ctx, file_path, optional)


Retrieves the attribute information for a specified file.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **file_path** | **String**| File path relative to /. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **file_path** | **String**| File path relative to /. | 
 **if_modified_since** | **String**| Returns only files that were modified since the specified time. If no files were modified since this time, a 304 message is returned. | 
 **if_unmodified_since** | **String**| Returns only files that were not modified since the specified time. If there are no unmodified files since this time, a 412 message is returned to indicate that the precondition failed. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_file_contents**
> ::models::Empty get_file_contents(ctx, file_path, optional)


Retrieves the contents of a file from a specified path. Note that file streaming is not supported.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **file_path** | **String**| File path relative to /. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **file_path** | **String**| File path relative to /. | 
 **range** | **String**| Returns the specified range bytes of an object.  | 
 **if_modified_since** | **String**| Returns only files that were modified since the specified time. If no files were modified since this time, a 304 message is returned. | 
 **if_unmodified_since** | **String**| Returns only files that were not modified since the specified time. If there are no unmodified files since this time, a 412 message is returned to indicate that the precondition failed. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_file_metadata**
> ::models::NamespaceMetadataList get_file_metadata(ctx, file_metadata_path, metadata)


Retrieves the attribute information for a specified file with the metadata query argument.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **file_metadata_path** | **String**| File path relative to /. | 
  **metadata** | **bool**| Show file metadata. | 

### Return type

[**::models::NamespaceMetadataList**](NamespaceMetadataList.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_worm_properties**
> ::models::WormProperties get_worm_properties(ctx, worm_file_path, worm)


Retrieves the WORM retention date and committed state of the file.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **worm_file_path** | **String**| Write once read many file path relative to /. | 
  **worm** | **bool**| View WORM properties | 

### Return type

[**::models::WormProperties**](WormProperties.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_access_points**
> ::models::NamespaceAccessPoints list_access_points(ctx, optional)


Retrieves the namespace access points available for the authenticated user.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **versions** | **bool**| Protocol versions that are supported for the current namespace access server. | 

### Return type

[**::models::NamespaceAccessPoints**](NamespaceAccessPoints.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **move_directory**
> ::models::Empty move_directory(ctx, directory_path, x_isi_ifs_set_location)


Moves a directory from an existing source to a new destination path.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **directory_path** | **String**| Directory path relative to /. | 
  **x_isi_ifs_set_location** | **String**| Specifies the full path for the destination directory. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **move_file**
> ::models::Empty move_file(ctx, file_path, x_isi_ifs_set_location)


Moves a file to a destination path that does not yet exist.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **file_path** | **String**| File path relative to /. | 
  **x_isi_ifs_set_location** | **String**| Specifies the full path for the destination file.  | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **query_directory**
> ::models::NamespaceObjects query_directory(ctx, query_path, query, directory_query, optional)


Query objects by system-defined and user-defined attributes in a directory.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **query_path** | **String**| Directory path relative to /. | 
  **query** | **bool**| Enable directory query. | 
  **directory_query** | [**DirectoryQuery**]DirectoryQuery.md| Directory query parameters model. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **query_path** | **String**| Directory path relative to /. | 
 **query** | **bool**| Enable directory query. | 
 **directory_query** | [**DirectoryQuery**]DirectoryQuery.md| Directory query parameters model. | 
 **limit** | **i32**| Specifies the maximum number of objects to send to the client. You can set the value to a negative number to retrieve all objects. | 
 **detail** | **String**| Specifies which object attributes are displayed. If the detail parameter is excluded, only the name of the object is returned. | 
 **max_depth** | **i32**| Specifies the maximum directory level depth to search for objects. | 

### Return type

[**::models::NamespaceObjects**](NamespaceObjects.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **set_acl**
> ::models::Empty set_acl(ctx, namespace_path, acl, namespace_acl, optional)


Sets the access control list for a namespace.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **namespace_path** | **String**| Namespace path relative to /. | 
  **acl** | **bool**| Update access control lists. | 
  **namespace_acl** | [**NamespaceAcl**]NamespaceAcl.md| Namespace ACL parameters model. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **namespace_path** | **String**| Namespace path relative to /. | 
 **acl** | **bool**| Update access control lists. | 
 **namespace_acl** | [**NamespaceAcl**]NamespaceAcl.md| Namespace ACL parameters model. | 
 **nsaccess** | **bool**| Indicates that the operation is on the access point instead of the store path. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **set_directory_metadata**
> ::models::Empty set_directory_metadata(ctx, directory_metadata_path, metadata, directory_metadata)


Sets attributes on a specified directory with the metadata query argument.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **directory_metadata_path** | **String**| Directory path relative to /. | 
  **metadata** | **bool**| Set directory metadata. | 
  **directory_metadata** | [**NamespaceMetadata**]NamespaceMetadata.md| Directory metadata parameters model. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **set_file_metadata**
> ::models::Empty set_file_metadata(ctx, file_metadata_path, metadata, file_metadata)


Sets attributes on a specified file with the metadata query argument through the JSON body.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **file_metadata_path** | **String**| File path relative to /. | 
  **metadata** | **bool**| Set file metadata. | 
  **file_metadata** | [**NamespaceMetadata**]NamespaceMetadata.md| File metadata parameters model. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **set_worm_properties**
> ::models::Empty set_worm_properties(ctx, worm_file_path, worm, worm_properties)


Sets the retention period and commits a file in a SmartLock directory.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  **worm_file_path** | **String**| Write once read many file path relative to /. | 
  **worm** | **bool**| View WORM properties | 
  **worm_properties** | [**WormCreateParams**]WormCreateParams.md| WORM parameters model. | 

### Return type

[**::models::Empty**](Empty.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)