github.com/optim-corp/cios-golang-sdk@v0.5.1/sdk/service/filestorage/README.md (about) 1 # File Storage 2 3 ## Bucket API 4 5 ### interface 6 7 ``` 8 GetBuckets(ciosctx.RequestCtx, cios.ApiGetBucketsRequest) (cios.MultipleBucket, *_nethttp.Response, error) 9 GetBucketsAll(ciosctx.RequestCtx, cios.ApiGetBucketsRequest) ([]cios.Bucket, *_nethttp.Response, error) 10 GetBucketsUnlimited(ciosctx.RequestCtx, cios.ApiGetBucketsRequest) ([]cios.Bucket, *_nethttp.Response, error) 11 GetBucket(ciosctx.RequestCtx, string) (cios.Bucket, *_nethttp.Response, error) 12 GetBucketByResourceOwnerIDAndName(ciosctx.RequestCtx, string, string) (cios.Bucket, *_nethttp.Response, error) 13 GetOrCreateBucket(ciosctx.RequestCtx, string, string) (cios.Bucket, *_nethttp.Response, error) 14 CreateBucket(ciosctx.RequestCtx, string, string) (cios.Bucket, *_nethttp.Response, error) 15 DeleteBucket(ciosctx.RequestCtx, string) (*_nethttp.Response, error) 16 UpdateBucket(ciosctx.RequestCtx, string, string) (*_nethttp.Response, error) 17 ``` 18 19 ### Usage 20 21 #### Get a Bucket 22 23 ```go 24 bucket, httpResponse, err := client.FileStorage()().GetBucketsUnlimited(ctx, "bucket_id") 25 ``` 26 27 #### Get a Bucket by ResourceOwnerID + Bucket Name 28 29 ```go 30 bucket, httpResponse, err := client.FileStorage().GetBucketByResourceOwnerIDAndName(ctx, "resource_owner_id", "name") 31 ``` 32 33 #### Get Buckets max limit 1000 34 35 ```go 36 options := srvfilestorage.MakeGetBucketsOpts 37 buckets, httpResponse, err := client.FileStorage().GetBuckets(ctx, options().Name("test")) 38 ``` 39 40 #### Get Buckets no limit 41 42 ```go 43 options := srvfilestorage.MakeGetBucketsOpts 44 buckets, httpResponse, err := client.FileStorage().GetBucketsAll(ctx, options().Name("test").Limit(2000)) 45 ``` 46 47 #### Get Buckets unlimited 48 49 ```go 50 options := srvfilestorage.MakeGetBucketsOpts 51 buckets, httpResponse, err := client.FileStorage().GetBucketsUnlimited(ctx, options().Name("test")) 52 ``` 53 54 55 #### Get or create a Bucket 56 57 ```go 58 bucket, httpResponse, err := client.FileStorage().GetOrCreateBucket(ctx, "resource_owner_id", "name") 59 ``` 60 61 #### Create a Bucket 62 63 ```go 64 bucket, httpResponse, err := client.FileStorage().CreateBucket(ctx, "resource_owner_id", "name") 65 ``` 66 67 #### Update a Bucket 68 69 ```go 70 httpResponse, err := client.FileStorage().UpdateBucket(ctx, "bucket_id", "name") 71 ``` 72 73 #### Delete a Bucket 74 75 ```go 76 httpResponse, err := client.FileStorage().DeleteBucket(ctx, "bucket_id") 77 ``` 78 79 80 ## Node API 81 82 ### interface 83 84 ``` 85 GetNodes(ciosctx.RequestCtx, string, cios.ApiGetNodesRequest) (cios.MultipleNode, *_nethttp.Response, error) 86 GetNodesAll(ciosctx.RequestCtx, string, cios.ApiGetNodesRequest) ([]cios.Node, *_nethttp.Response, error) 87 GetNodesUnlimited(ciosctx.RequestCtx, string, cios.ApiGetNodesRequest) ([]cios.Node, *_nethttp.Response, error) 88 GetNode(ciosctx.RequestCtx, string, string) (cios.Node, *_nethttp.Response, error) 89 CreateNode(ciosctx.RequestCtx, string, string, *string) (cios.Node, *_nethttp.Response, error) 90 CreateNodeOnNodeID(ciosctx.RequestCtx, string, cios.NodeRequest) (cios.Node, *_nethttp.Response, error) 91 DeleteNode(ciosctx.RequestCtx, string, string) (*_nethttp.Response, error) 92 CopyNode(ciosctx.RequestCtx, string, string, *string, *string) (cios.Node, *_nethttp.Response, error) 93 MoveNode(ciosctx.RequestCtx, string, string, *string, *string) (cios.Node, *_nethttp.Response, error) 94 RenameNode(ciosctx.RequestCtx, string, string, string) (cios.Node, *_nethttp.Response, error) 95 ``` 96 97 ### Usage 98 99 #### Get a Node 100 101 ```go 102 node, httpResponse, err := client.FileStorage().GetNode(ctx, "bucket_id", "node_id") 103 ``` 104 105 106 #### Get Nodes max limit 1000 107 108 ```go 109 options := srvfilestorage.MakeGetNodesOpts 110 nodes, httpResponse, err := client.FileStorage().GetNodes(ctx, "bucket_id", options().Limit(200).Name("sample")) 111 ``` 112 113 #### Get Nodes no limit 114 115 ```go 116 options := srvfilestorage.MakeGetNodesOpts 117 nodes, httpResponse, err := client.FileStorage().GetNodesAll(ctx, "bucket_id", options().Limit(20000).Name("sample")) 118 ``` 119 120 #### Get Nodes unlimited 121 122 ```go 123 options := srvfilestorage.MakeGetNodesOpts 124 nodes, httpResponse, err := client.FileStorage().GetNodesUnlimited(ctx, "bucket_id", options().Name("sample")) 125 ``` 126 127 128 #### Create a Directory 129 130 ```go 131 parentNodeId := "parent_node_id" 132 node, httpResponse, err := CreateNode(ciosctx.RequestCtx, "bucket_id", "node_name", &parentNodeId) 133 ``` 134 135 #### Delete a Node 136 137 ```go 138 httpResponse, err := client.FileStorage().DeleteNode(ctx, "bucket_id", "node_id") 139 ``` 140 141 #### Copy a Node 142 143 ```go 144 destBucketId := "dest_bucket_id" 145 destNodeId := "dest_node_id" 146 node, httpResponse, err := client.FileStorage().CopyNode(ctx, "bucket_id", "node_id", &destBucketId, &destNodeId) 147 ``` 148 149 #### Move a Node 150 151 ```go 152 destBucketId := "dest_bucket_id" 153 destNodeId := "dest_node_id" 154 node, httpResponse, err := client.FileStorage().MoveNode(ctx, "bucket_id", "node_id", &destBucketId, &destNodeId) 155 ``` 156 157 #### Rename a Node 158 159 ```go 160 node, httpResponse, err := client.FileStorage().MoveNode(ctx, "bucket_id", "node_id", "name") 161 ``` 162 163 ## File API 164 165 ### interface 166 167 168 ``` 169 DownloadFile(ciosctx.RequestCtx, string, string) ([]byte, *_nethttp.Response, error) 170 DownloadFileByKey(ciosctx.RequestCtx, string, string) ([]byte, *_nethttp.Response, error) 171 UploadFile(ciosctx.RequestCtx, string, []byte, cios.ApiUploadFileRequest) (*_nethttp.Response, error) 172 ``` 173 174 ### Usage 175 176 #### Download a File 177 178 ```go 179 byts, httpResponse, err := client.FileStorage().DownloadFile(ctx, "bucket_id", "node_id") 180 ``` 181 182 #### Upload a File 183 184 ```go 185 httpResponse, err := client.FileStorage().UploadFile(ctx, "bucket_id", []byte{}, srvfilestorage.MakeUploadFileOpts().NodeId("node_id")) 186 ```