Skip to content

Commit f780b72

Browse files
tjprescotttjprescott
committed
[API Review] api.md for azure-storage-blob 12.31.0b1
1 parent 0a24ac1 commit f780b72

2 files changed

Lines changed: 22 additions & 29 deletions

File tree

‎sdk/storage/azure-storage-blob/api.md‎

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ namespace azure.storage.blob
5252
content_type: Optional[str] = ...,
5353
correlation_id: Optional[str] = ...,
5454
encryption_scope: Optional[str] = ...,
55+
is_directory: Optional[bool] = ...,
5556
protocol: Optional[str] = ...,
5657
request_headers: Optional[Dict[str, str]] = ...,
5758
request_query_params: Optional[Dict[str, str]] = ...,
@@ -469,7 +470,7 @@ namespace azure.storage.blob
469470
match_condition: Optional[MatchConditions] = ...,
470471
maxsize_condition: Optional[int] = ...,
471472
timeout: Optional[int] = ...,
472-
validate_content: Optional[bool] = ...,
473+
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
473474
**kwargs: Any
474475
) -> Dict[str, Union[str, datetime, int]]: ...
475476

@@ -930,7 +931,7 @@ namespace azure.storage.blob
930931
encryption_scope: Optional[str] = ...,
931932
lease: Union[BlobLeaseClient, str] = ...,
932933
timeout: Optional[int] = ...,
933-
validate_content: Optional[bool] = ...,
934+
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
934935
**kwargs: Any
935936
) -> Dict[str, Any]: ...
936937

@@ -1021,7 +1022,7 @@ namespace azure.storage.blob
10211022
standard_blob_tier: Optional[StandardBlobTier] = ...,
10221023
tags: dict(str, str) = ...,
10231024
timeout: Optional[int] = ...,
1024-
validate_content: Optional[bool] = ...,
1025+
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
10251026
**kwargs: Any
10261027
) -> Dict[str, Any]: ...
10271028

@@ -1075,7 +1076,7 @@ namespace azure.storage.blob
10751076
lease: Union[BlobLeaseClient, str] = ...,
10761077
match_condition: Optional[MatchConditions] = ...,
10771078
timeout: Optional[int] = ...,
1078-
validate_content: Optional[bool] = ...,
1079+
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
10791080
**kwargs: Any
10801081
) -> Dict[str, Union[str, datetime]]: ...
10811082

@@ -1289,6 +1290,7 @@ namespace azure.storage.blob
12891290
request_server_encrypted: Optional[bool]
12901291
server_encrypted: bool
12911292
size: int
1293+
smart_access_tier: Optional[str]
12921294
snapshot: Optional[str]
12931295
tag_count: Optional[int]
12941296
tags: Optional[Dict[str, str]]
@@ -1648,10 +1650,8 @@ namespace azure.storage.blob
16481650
lease_duration: int = -1,
16491651
lease_id: Optional[str] = None,
16501652
*,
1651-
etag: Optional[str] = ...,
16521653
if_modified_since: Optional[datetime] = ...,
16531654
if_unmodified_since: Optional[datetime] = ...,
1654-
match_condition: Optional[MatchConditions] = ...,
16551655
timeout: Optional[int] = ...,
16561656
**kwargs: Any
16571657
) -> BlobLeaseClient: ...
@@ -1704,11 +1704,9 @@ namespace azure.storage.blob
17041704
def delete_container(
17051705
self,
17061706
*,
1707-
etag: Optional[str] = ...,
17081707
if_modified_since: Optional[datetime] = ...,
17091708
if_unmodified_since: Optional[datetime] = ...,
17101709
lease: Union[BlobLeaseClient, str] = ...,
1711-
match_condition: Optional[MatchConditions] = ...,
17121710
timeout: Optional[int] = ...,
17131711
**kwargs: Any
17141712
) -> None: ...
@@ -1818,9 +1816,7 @@ namespace azure.storage.blob
18181816
self,
18191817
metadata: Optional[Dict[str, str]] = None,
18201818
*,
1821-
etag: Optional[str] = ...,
18221819
if_modified_since: Optional[datetime] = ...,
1823-
if_unmodified_since: Optional[datetime] = ...,
18241820
lease: Union[BlobLeaseClient, str] = ...,
18251821
timeout: Optional[int] = ...,
18261822
**kwargs: Any
@@ -1876,7 +1872,7 @@ namespace azure.storage.blob
18761872
progress_hook: Callable[[int, Optional[int]], None] = ...,
18771873
standard_blob_tier: Optional[StandardBlobTier] = ...,
18781874
timeout: Optional[int] = ...,
1879-
validate_content: Optional[bool] = ...,
1875+
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
18801876
**kwargs
18811877
) -> BlobClient: ...
18821878

@@ -2873,6 +2869,7 @@ namespace azure.storage.blob
28732869
COLD = "Cold"
28742870
COOL = "Cool"
28752871
HOT = "Hot"
2872+
SMART = "Smart"
28762873

28772874

28782875
class azure.storage.blob.StaticWebsite(GeneratedStaticWebsite):
@@ -3114,7 +3111,7 @@ namespace azure.storage.blob
31143111
config: StorageConfiguration = None,
31153112
start_range: Optional[int] = None,
31163113
end_range: Optional[int] = None,
3117-
validate_content: bool = None,
3114+
validate_content: CV_TYPE_PARSED = None,
31183115
encryption_options: Dict[str, Any] = None,
31193116
max_concurrency: Optional[int] = None,
31203117
name: str = None,
@@ -3128,18 +3125,18 @@ namespace azure.storage.blob
31283125

31293126
def chunks(self) -> Iterator[bytes]: ...
31303127

3131-
def content_as_bytes(self, max_concurrency: int = None) -> bytes: ...
3128+
def content_as_bytes(self, max_concurrency: Optional[int] = None) -> bytes: ...
31323129

31333130
def content_as_text(
31343131
self,
3135-
max_concurrency: int = None,
3132+
max_concurrency: Optional[int] = None,
31363133
encoding: str = "UTF-8"
31373134
) -> str: ...
31383135

31393136
def download_to_stream(
31403137
self,
31413138
stream: IO[T],
3142-
max_concurrency: int = None
3139+
max_concurrency: Optional[int] = None
31433140
) -> Any: ...
31443141

31453142
@overload
@@ -3298,7 +3295,7 @@ namespace azure.storage.blob.aio
32983295
match_condition: Optional[MatchConditions] = ...,
32993296
maxsize_condition: Optional[int] = ...,
33003297
timeout: Optional[int] = ...,
3301-
validate_content: Optional[bool] = ...,
3298+
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
33023299
**kwargs: Any
33033300
) -> Dict[str, Union[str, datetime, int]]: ...
33043301

@@ -3758,7 +3755,7 @@ namespace azure.storage.blob.aio
37583755
encryption_scope: Optional[str] = ...,
37593756
lease: Union[BlobLeaseClient, str] = ...,
37603757
timeout: Optional[int] = ...,
3761-
validate_content: Optional[bool] = ...,
3758+
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
37623759
**kwargs: Any
37633760
) -> Dict[str, Any]: ...
37643761

@@ -3850,7 +3847,7 @@ namespace azure.storage.blob.aio
38503847
standard_blob_tier: Optional[StandardBlobTier] = ...,
38513848
tags: dict(str, str) = ...,
38523849
timeout: Optional[int] = ...,
3853-
validate_content: Optional[bool] = ...,
3850+
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
38543851
**kwargs: Any
38553852
) -> Dict[str, Any]: ...
38563853

@@ -3904,7 +3901,7 @@ namespace azure.storage.blob.aio
39043901
lease: Union[BlobLeaseClient, str] = ...,
39053902
match_condition: Optional[MatchConditions] = ...,
39063903
timeout: Optional[int] = ...,
3907-
validate_content: Optional[bool] = ...,
3904+
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
39083905
**kwargs: Any
39093906
) -> Dict[str, Union[str, datetime]]: ...
39103907

@@ -4299,10 +4296,8 @@ namespace azure.storage.blob.aio
42994296
lease_duration: int = -1,
43004297
lease_id: Optional[str] = None,
43014298
*,
4302-
etag: Optional[str] = ...,
43034299
if_modified_since: Optional[datetime] = ...,
43044300
if_unmodified_since: Optional[datetime] = ...,
4305-
match_condition: Optional[MatchConditions] = ...,
43064301
timeout: Optional[int] = ...,
43074302
**kwargs: Any
43084303
) -> BlobLeaseClient: ...
@@ -4355,11 +4350,9 @@ namespace azure.storage.blob.aio
43554350
async def delete_container(
43564351
self,
43574352
*,
4358-
etag: Optional[str] = ...,
43594353
if_modified_since: Optional[datetime] = ...,
43604354
if_unmodified_since: Optional[datetime] = ...,
43614355
lease: Union[BlobLeaseClient, str] = ...,
4362-
match_condition: Optional[MatchConditions] = ...,
43634356
timeout: Optional[int] = ...,
43644357
**kwargs: Any
43654358
) -> None: ...
@@ -4525,7 +4518,7 @@ namespace azure.storage.blob.aio
45254518
progress_hook: Callable[[int, Optional[int]], Awaitable[None]] = ...,
45264519
standard_blob_tier: Optional[StandardBlobTier] = ...,
45274520
timeout: Optional[int] = ...,
4528-
validate_content: Optional[bool] = ...,
4521+
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
45294522
**kwargs
45304523
) -> BlobClient: ...
45314524

@@ -4624,7 +4617,7 @@ namespace azure.storage.blob.aio
46244617
config: StorageConfiguration = None,
46254618
start_range: Optional[int] = None,
46264619
end_range: Optional[int] = None,
4627-
validate_content: bool = None,
4620+
validate_content: CV_TYPE_PARSED = None,
46284621
encryption_options: Dict[str, Any] = None,
46294622
max_concurrency: Optional[int] = None,
46304623
name: str = None,
@@ -4638,18 +4631,18 @@ namespace azure.storage.blob.aio
46384631

46394632
def chunks(self) -> AsyncIterator[bytes]: ...
46404633

4641-
async def content_as_bytes(self, max_concurrency: int = None) -> bytes: ...
4634+
async def content_as_bytes(self, max_concurrency: Optional[int] = None) -> bytes: ...
46424635

46434636
async def content_as_text(
46444637
self,
4645-
max_concurrency: int = None,
4638+
max_concurrency: Optional[int] = None,
46464639
encoding: str = "UTF-8"
46474640
) -> str: ...
46484641

46494642
async def download_to_stream(
46504643
self,
46514644
stream: IO[T],
4652-
max_concurrency: int = None
4645+
max_concurrency: Optional[int] = None
46534646
) -> Any: ...
46544647

46554648
@overload

‎sdk/storage/azure-storage-blob/api.metadata.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
apiMdSha256: 9010619c987cb7f6cd5a839bd39fe61f7efbdc22a09e86ec39757adeff28fd93
1+
apiMdSha256: 38a660f5d55527fe389aaf9017736875f51f1f564acd4ea8aaaa547552b820b2
22
parserVersion: 0.3.28
33
pythonVersion: 3.12.9

0 commit comments

Comments
 (0)