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.

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

fix: expose num_retries parameter for blob upload methods #353

Merged
merged 2 commits into from Feb 10, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 22 additions & 0 deletions google/cloud/storage/blob.py
Expand Up @@ -2362,6 +2362,7 @@ def upload_from_filename(
self,
filename,
content_type=None,
num_retries=None,
client=None,
predefined_acl=None,
if_generation_match=None,
Expand Down Expand Up @@ -2406,6 +2407,15 @@ def upload_from_filename(
(Optional) The client to use. If not passed, falls back to the
``client`` stored on the blob's bucket.

:type num_retries: int
:param num_retries:
Number of upload retries. By default, only uploads with
if_metageneration_match set will be retried, as uploads without the
argument are not guaranteed to be idempotent. Setting num_retries
will override this default behavior and guarantee retries even when
if_metageneration_match is not set. (Deprecated: This argument
will be removed in a future release.)

:type predefined_acl: str
:param predefined_acl: (Optional) Predefined access control list

Expand Down Expand Up @@ -2460,6 +2470,7 @@ def upload_from_filename(
self.upload_from_file(
file_obj,
content_type=content_type,
num_retries=num_retries,
client=client,
size=total_bytes,
predefined_acl=predefined_acl,
Expand All @@ -2475,6 +2486,7 @@ def upload_from_string(
self,
data,
content_type="text/plain",
num_retries=None,
client=None,
predefined_acl=None,
if_generation_match=None,
Expand Down Expand Up @@ -2510,6 +2522,15 @@ def upload_from_string(
(Optional) Type of content being uploaded. Defaults to
``'text/plain'``.

:type num_retries: int
:param num_retries:
Number of upload retries. By default, only uploads with
if_metageneration_match set will be retried, as uploads without the
argument are not guaranteed to be idempotent. Setting num_retries
will override this default behavior and guarantee retries even when
if_metageneration_match is not set. (Deprecated: This argument
will be removed in a future release.)

:type client: :class:`~google.cloud.storage.client.Client`
:param client:
(Optional) The client to use. If not passed, falls back to the
Expand Down Expand Up @@ -2568,6 +2589,7 @@ def upload_from_string(
file_obj=string_buffer,
size=len(data),
content_type=content_type,
num_retries=num_retries,
client=client,
predefined_acl=predefined_acl,
if_generation_match=if_generation_match,
Expand Down