Add doc for GetObjectOptions and PutObjectOptions #851
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -383,6 +383,12 @@ __Parameters__ | |
| |`opts` | _minio.GetObjectOptions_ | Options for GET requests specifying additional options like encryption, If-Match | | ||
|
|
||
|
|
||
| __minio.GetObjectOptions__ | ||
|
|
||
| |Field | Type | Description | | ||
| |:---|:---|:---| | ||
| | `opts.Materials` | _encrypt.Materials_ | Interface provided by `encrypt` package to encrypt a stream of data (For more information see https://godoc.org/github.com/minio/minio-go) | | ||
|
|
||
| __Return Value__ | ||
|
|
||
|
|
||
|
|
@@ -524,7 +530,7 @@ __Parameters__ | |
| |`bucketName` | _string_ |Name of the bucket | | ||
| |`objectName` | _string_ |Name of the object | | ||
| |`filePath` | _string_ |Path to download object to | | ||
| |`materials` | _encrypt.Materials_ | Interface provided by `encrypt` package to encrypt a stream of data (For more information see https://godoc.org/github.com/minio/minio-go) | | ||
|
|
||
|
|
||
| __Example__ | ||
|
|
@@ -560,7 +566,19 @@ __Parameters__ | |
| |`objectName` | _string_ |Name of the object | | ||
| |`reader` | _io.Reader_ |Any Go type that implements io.Reader | | ||
| |`objectSize`| _int64_ |Size of the object being uploaded. Pass -1 if stream size is unknown | | ||
| |`opts` | _minio.PutObjectOptions_ | Allows user to set optional custom metadata, content headers, encryption keys and number of threads for multipart upload operation. | | ||
|
|
||
| __minio.PutObjectOptions__ | ||
|
|
||
| |Field | Type | Description | | ||
| |:--- |:--- | :--- | | ||
| | `opts.UserMetadata` | _map[string]string_ | Map of user metadata| | ||
| | `opts.Progress` | _io.Reader_ | Reader to fetch progress of an upload | | ||
| | `opts.ContentType` | _string_ | Content type of object, e.g "application/text" | | ||
|
There was a problem hiding this comment. Is there an exhaustive list of values that can be shown application/text, application/zip .... There was a problem hiding this comment. We can add a link here https://en.wikipedia.org/wiki/Media_type we don't need to write exhaustive list here. There was a problem hiding this comment. Basically meaning there is no restriction this ContentType field is HTTP Content-Type header with any value, we can mention that as well. There was a problem hiding this comment. can we show all exhaustive values not just eg. What all content types can the api accept application/zip, application/octet. application/zip etc. |
||
| | `opts.ContentEncoding` | _string_ | Content encoding of object, e.g "gzip" | | ||
| | `opts.ContentDisposition` | _string_ | Content disposition of object, "inline" | | ||
| | `opts.CacheControl` | _string_ | Used to specify directives for caching mechanisms in both requests and responses e.g "max-age=600"| | ||
| | `opts.EncryptMaterials` | _encrypt.Materials_ | Interface provided by `encrypt` package to encrypt a stream of data (For more information see https://godoc.org/github.com/minio/minio-go) | | ||
|
|
||
|
|
||
| __Example__ | ||
|
|
@@ -1061,7 +1079,7 @@ __Parameters__ | |
| |:---|:---| :---| | ||
| |`bucketName` | _string_ | Name of the bucket | | ||
| |`objectName` | _string_ | Name of the object | | ||
| |`encryptMaterials` | _encrypt.Materials_ | Interface provided by `encrypt` package to encrypt a stream of data (For more information see https://godoc.org/github.com/minio/minio-go) | | ||
|
|
||
|
|
||
| __Return Value__ | ||
|
|
@@ -1116,7 +1134,7 @@ __Parameters__ | |
| |`bucketName` | _string_ |Name of the bucket | | ||
| |`objectName` | _string_ |Name of the object | | ||
| |`reader` | _io.Reader_ |Any Go type that implements io.Reader | | ||
| |`encryptMaterials` | _encrypt.Materials_ | Interface provided by `encrypt` package to encrypt a stream of data (For more information see https://godoc.org/github.com/minio/minio-go) | | ||
|
|
||
| __Example__ | ||
|
|
||
|
|
@@ -1173,7 +1191,7 @@ __Parameters__ | |
| |`bucketName` | _string_ |Name of the bucket | | ||
| |`objectName` | _string_ |Name of the object | | ||
| |`filePath` | _string_ |Path to file to be uploaded | | ||
| |`encryptMaterials` | _encrypt.Materials_ | Interface provided by `encrypt` package to encrypt a stream of data (For more information see https://godoc.org/github.com/minio/minio-go)The module that encrypts data | | ||
|
|
||
| __Example__ | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to update examples to show how to use with the encrypt option.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AFAICS these are under FPutEncryptedObject() and FGetEncryptedObject.