Skip to content

Commit

Permalink
[Storage] Fix documentation for timeout in all Storage packages (Az…
Browse files Browse the repository at this point in the history
  • Loading branch information
jalauzon-msft authored Jan 28, 2023
1 parent c3c3ad5 commit e4edec7
Show file tree
Hide file tree
Showing 34 changed files with 2,057 additions and 428 deletions.
232 changes: 189 additions & 43 deletions sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,11 @@ def get_user_delegation_key(self, key_start_time, # type: datetime
:param ~datetime.datetime key_expiry_time:
A DateTime value. Indicates when the key stops being valid.
:keyword int timeout:
The timeout parameter is expressed in seconds.
Sets the server-side timeout for the operation in seconds. For more details see
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
:return: The user delegation key.
:rtype: ~azure.storage.blob.UserDelegationKey
"""
Expand Down Expand Up @@ -258,7 +262,11 @@ def get_service_stats(self, **kwargs):
replication is enabled for your storage account.
:keyword int timeout:
The timeout parameter is expressed in seconds.
Sets the server-side timeout for the operation in seconds. For more details see
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
:return: The blob service stats.
:rtype: Dict[str, Any]
Expand Down Expand Up @@ -286,7 +294,11 @@ def get_service_properties(self, **kwargs):
Azure Storage Analytics.
:keyword int timeout:
The timeout parameter is expressed in seconds.
Sets the server-side timeout for the operation in seconds. For more details see
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
:returns: An object containing blob service properties such as
analytics logging, hour/minute metrics, cors rules, etc.
:rtype: Dict[str, Any]
Expand Down Expand Up @@ -353,7 +365,11 @@ def set_service_properties(
and if yes, indicates the index document and 404 error document to use.
:type static_website: ~azure.storage.blob.StaticWebsite
:keyword int timeout:
The timeout parameter is expressed in seconds.
Sets the server-side timeout for the operation in seconds. For more details see
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
:rtype: None
.. admonition:: Example:
Expand Down Expand Up @@ -414,7 +430,11 @@ def list_containers(
The maximum number of container names to retrieve per API
call. If the request does not specify the server will return up to 5,000 items.
:keyword int timeout:
The timeout parameter is expressed in seconds.
Sets the server-side timeout for the operation in seconds. For more details see
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
:returns: An iterable (auto-paging) of ContainerProperties.
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.ContainerProperties]
Expand Down Expand Up @@ -465,7 +485,11 @@ def find_blobs_by_tags(self, filter_expression, **kwargs):
:keyword int results_per_page:
The max result per page when paginating.
:keyword int timeout:
The timeout parameter is expressed in seconds.
Sets the server-side timeout for the operation in seconds. For more details see
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
:returns: An iterable (auto-paging) response of BlobProperties.
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.FilteredBlob]
"""
Expand Down Expand Up @@ -511,7 +535,11 @@ def create_container(
:paramtype container_encryption_scope: dict or ~azure.storage.blob.ContainerEncryptionScope
:keyword int timeout:
The timeout parameter is expressed in seconds.
Sets the server-side timeout for the operation in seconds. For more details see
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
:rtype: ~azure.storage.blob.ContainerClient
.. admonition:: Example:
Expand Down Expand Up @@ -569,7 +597,11 @@ def delete_container(
:keyword ~azure.core.MatchConditions match_condition:
The match condition to use upon the etag.
:keyword int timeout:
The timeout parameter is expressed in seconds.
Sets the server-side timeout for the operation in seconds. For more details see
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
:rtype: None
.. admonition:: Example:
Expand Down Expand Up @@ -605,7 +637,11 @@ def _rename_container(self, name, new_name, **kwargs):
matches the active lease ID of the source container.
:paramtype lease: ~azure.storage.blob.BlobLeaseClient or str
:keyword int timeout:
The timeout parameter is expressed in seconds.
Sets the server-side timeout for the operation in seconds. For more details see
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
:rtype: ~azure.storage.blob.ContainerClient
"""
renamed_container = self.get_container_client(new_name)
Expand Down Expand Up @@ -636,7 +672,11 @@ def undelete_container(self, deleted_container_name, deleted_container_version,
:param str deleted_container_version:
Specifies the version of the deleted container to restore.
:keyword int timeout:
The timeout parameter is expressed in seconds.
Sets the server-side timeout for the operation in seconds. For more details see
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
:rtype: ~azure.storage.blob.ContainerClient
"""
new_name = kwargs.pop('new_name', None)
Expand Down
Loading

0 comments on commit e4edec7

Please sign in to comment.