Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update fget_object() API documentation #1075

Merged
merged 1 commit into from
Feb 1, 2021
Merged

Update fget_object() API documentation #1075

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -941,8 +941,7 @@ with client.select_object_content(

<a name="fget_object"></a>

### fget_object(bucket_name, object_name, file_path, request_headers=None, ssec=None, version_id=None, extra_query_params=None)

### fget_object(bucket_name, object_name, file_path, request_headers=None, ssec=None, version_id=None, extra_query_params=None, tmp_file_path=None)
Downloads data of an object to file.

__Parameters__
Expand All @@ -956,6 +955,7 @@ __Parameters__
| `ssec` | _SseCustomerKey_ | Server-side encryption customer key. |
| `version_id` | _str_ | Version-ID of the object. |
| `extra_query_params` | _dict_ | Extra query parameters for advanced usage. |
| `tmp_file_path` | _str_ | Path to a temporary file. |

__Return Value__

Expand Down
2 changes: 1 addition & 1 deletion minio/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1035,7 +1035,7 @@ def fget_object(self, bucket_name, object_name, file_path,
:param ssec: Server-side encryption customer key.
:param version_id: Version-ID of the object.
:param extra_query_params: Extra query parameters for advanced usage.
:param tmp_file_path: Path to a temporary file
:param tmp_file_path: Path to a temporary file.
:return: Object information.

Example::
Expand Down