1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
|
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
# Generated file, DO NOT EDIT
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------------------------
from msrest import Serializer, Deserializer
from ...client import Client
from . import models
class FeedClient(Client):
"""Feed
:param str base_url: Service URL
:param Authentication creds: Authenticated credentials.
"""
def __init__(self, base_url=None, creds=None):
super(FeedClient, self).__init__(base_url, creds)
client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)}
self._serialize = Serializer(client_models)
self._deserialize = Deserializer(client_models)
resource_area_identifier = '7ab4e64e-c4d8-4f50-ae73-5ef2e21642a5'
def get_badge(self, feed_id, package_id):
"""GetBadge.
[Preview API] Generate a SVG badge for the latest version of a package. The generated SVG is typically used as the image in an HTML link which takes users to the feed containing the package to accelerate discovery and consumption.
:param str feed_id: Name or Id of the feed.
:param str package_id: Id of the package (GUID Id, not name).
:rtype: str
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
if package_id is not None:
route_values['packageId'] = self._serialize.url('package_id', package_id, 'str')
response = self._send(http_method='GET',
location_id='61d885fd-10f3-4a55-82b6-476d866b673f',
version='5.0-preview.1',
route_values=route_values)
return self._deserialize('str', response)
def get_feed_change(self, feed_id):
"""GetFeedChange.
[Preview API] Query a feed to determine its current state.
:param str feed_id: Name or ID of the feed.
:rtype: :class:`<FeedChange> <azure.devops.v5_0.feed.models.FeedChange>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
response = self._send(http_method='GET',
location_id='29ba2dad-389a-4661-b5d3-de76397ca05b',
version='5.0-preview.1',
route_values=route_values)
return self._deserialize('FeedChange', response)
def get_feed_changes(self, include_deleted=None, continuation_token=None, batch_size=None):
"""GetFeedChanges.
[Preview API] Query to determine which feeds have changed since the last call, tracked through the provided continuationToken. Only changes to a feed itself are returned and impact the continuationToken, not additions or alterations to packages within the feeds.
:param bool include_deleted: If true, get changes for all feeds including deleted feeds. The default value is false.
:param long continuation_token: A continuation token which acts as a bookmark to a previously retrieved change. This token allows the user to continue retrieving changes in batches, picking up where the previous batch left off. If specified, all the changes that occur strictly after the token will be returned. If not specified or 0, iteration will start with the first change.
:param int batch_size: Number of package changes to fetch. The default value is 1000. The maximum value is 2000.
:rtype: :class:`<FeedChangesResponse> <azure.devops.v5_0.feed.models.FeedChangesResponse>`
"""
query_parameters = {}
if include_deleted is not None:
query_parameters['includeDeleted'] = self._serialize.query('include_deleted', include_deleted, 'bool')
if continuation_token is not None:
query_parameters['continuationToken'] = self._serialize.query('continuation_token', continuation_token, 'long')
if batch_size is not None:
query_parameters['batchSize'] = self._serialize.query('batch_size', batch_size, 'int')
response = self._send(http_method='GET',
location_id='29ba2dad-389a-4661-b5d3-de76397ca05b',
version='5.0-preview.1',
query_parameters=query_parameters)
return self._deserialize('FeedChangesResponse', response)
def create_feed(self, feed):
"""CreateFeed.
[Preview API] Create a feed, a container for various package types.
:param :class:`<Feed> <azure.devops.v5_0.feed.models.Feed>` feed: A JSON object containing both required and optional attributes for the feed. Name is the only required value.
:rtype: :class:`<Feed> <azure.devops.v5_0.feed.models.Feed>`
"""
content = self._serialize.body(feed, 'Feed')
response = self._send(http_method='POST',
location_id='c65009a7-474a-4ad1-8b42-7d852107ef8c',
version='5.0-preview.1',
content=content)
return self._deserialize('Feed', response)
def delete_feed(self, feed_id):
"""DeleteFeed.
[Preview API] Remove a feed and all its packages. The action does not result in packages moving to the RecycleBin and is not reversible.
:param str feed_id: Name or Id of the feed.
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
self._send(http_method='DELETE',
location_id='c65009a7-474a-4ad1-8b42-7d852107ef8c',
version='5.0-preview.1',
route_values=route_values)
def get_feed(self, feed_id, include_deleted_upstreams=None):
"""GetFeed.
[Preview API] Get the settings for a specific feed.
:param str feed_id: Name or Id of the feed.
:param bool include_deleted_upstreams: Include upstreams that have been deleted in the response.
:rtype: :class:`<Feed> <azure.devops.v5_0.feed.models.Feed>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
query_parameters = {}
if include_deleted_upstreams is not None:
query_parameters['includeDeletedUpstreams'] = self._serialize.query('include_deleted_upstreams', include_deleted_upstreams, 'bool')
response = self._send(http_method='GET',
location_id='c65009a7-474a-4ad1-8b42-7d852107ef8c',
version='5.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('Feed', response)
def get_feeds(self, feed_role=None, include_deleted_upstreams=None):
"""GetFeeds.
[Preview API] Get all feeds in an account where you have the provided role access.
:param str feed_role: Filter by this role, either Administrator(4), Contributor(3), or Reader(2) level permissions.
:param bool include_deleted_upstreams: Include upstreams that have been deleted in the response.
:rtype: [Feed]
"""
query_parameters = {}
if feed_role is not None:
query_parameters['feedRole'] = self._serialize.query('feed_role', feed_role, 'str')
if include_deleted_upstreams is not None:
query_parameters['includeDeletedUpstreams'] = self._serialize.query('include_deleted_upstreams', include_deleted_upstreams, 'bool')
response = self._send(http_method='GET',
location_id='c65009a7-474a-4ad1-8b42-7d852107ef8c',
version='5.0-preview.1',
query_parameters=query_parameters)
return self._deserialize('[Feed]', self._unwrap_collection(response))
def update_feed(self, feed, feed_id):
"""UpdateFeed.
[Preview API] Change the attributes of a feed.
:param :class:`<FeedUpdate> <azure.devops.v5_0.feed.models.FeedUpdate>` feed: A JSON object containing the feed settings to be updated.
:param str feed_id: Name or Id of the feed.
:rtype: :class:`<Feed> <azure.devops.v5_0.feed.models.Feed>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
content = self._serialize.body(feed, 'FeedUpdate')
response = self._send(http_method='PATCH',
location_id='c65009a7-474a-4ad1-8b42-7d852107ef8c',
version='5.0-preview.1',
route_values=route_values,
content=content)
return self._deserialize('Feed', response)
def get_global_permissions(self):
"""GetGlobalPermissions.
[Preview API] Get all service-wide feed creation permissions.
:rtype: [GlobalPermission]
"""
response = self._send(http_method='GET',
location_id='a74419ef-b477-43df-8758-3cd1cd5f56c6',
version='5.0-preview.1')
return self._deserialize('[GlobalPermission]', self._unwrap_collection(response))
def set_global_permissions(self, global_permissions):
"""SetGlobalPermissions.
[Preview API] Set service-wide permissions that govern feed creation.
:param [GlobalPermission] global_permissions: New permissions for the organization.
:rtype: [GlobalPermission]
"""
content = self._serialize.body(global_permissions, '[GlobalPermission]')
response = self._send(http_method='PATCH',
location_id='a74419ef-b477-43df-8758-3cd1cd5f56c6',
version='5.0-preview.1',
content=content)
return self._deserialize('[GlobalPermission]', self._unwrap_collection(response))
def get_package_changes(self, feed_id, continuation_token=None, batch_size=None):
"""GetPackageChanges.
[Preview API] Get a batch of package changes made to a feed. The changes returned are 'most recent change' so if an Add is followed by an Update before you begin enumerating, you'll only see one change in the batch. While consuming batches using the continuation token, you may see changes to the same package version multiple times if they are happening as you enumerate.
:param str feed_id: Name or Id of the feed.
:param long continuation_token: A continuation token which acts as a bookmark to a previously retrieved change. This token allows the user to continue retrieving changes in batches, picking up where the previous batch left off. If specified, all the changes that occur strictly after the token will be returned. If not specified or 0, iteration will start with the first change.
:param int batch_size: Number of package changes to fetch. The default value is 1000. The maximum value is 2000.
:rtype: :class:`<PackageChangesResponse> <azure.devops.v5_0.feed.models.PackageChangesResponse>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
query_parameters = {}
if continuation_token is not None:
query_parameters['continuationToken'] = self._serialize.query('continuation_token', continuation_token, 'long')
if batch_size is not None:
query_parameters['batchSize'] = self._serialize.query('batch_size', batch_size, 'int')
response = self._send(http_method='GET',
location_id='323a0631-d083-4005-85ae-035114dfb681',
version='5.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('PackageChangesResponse', response)
def get_package(self, feed_id, package_id, include_all_versions=None, include_urls=None, is_listed=None, is_release=None, include_deleted=None, include_description=None):
"""GetPackage.
[Preview API] Get details about a specific package.
:param str feed_id: Name or Id of the feed.
:param str package_id: The package Id (GUID Id, not the package name).
:param bool include_all_versions: True to return all versions of the package in the response. Default is false (latest version only).
:param bool include_urls: True to return REST Urls with the response. Default is True.
:param bool is_listed: Only applicable for NuGet packages, setting it for other package types will result in a 404. If false, delisted package versions will be returned. Use this to filter the response when includeAllVersions is set to true. Default is unset (do not return delisted packages).
:param bool is_release: Only applicable for Nuget packages. Use this to filter the response when includeAllVersions is set to true. Default is True (only return packages without prerelease versioning).
:param bool include_deleted: Return deleted or unpublished versions of packages in the response. Default is False.
:param bool include_description: Return the description for every version of each package in the response. Default is False.
:rtype: :class:`<Package> <azure.devops.v5_0.feed.models.Package>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
if package_id is not None:
route_values['packageId'] = self._serialize.url('package_id', package_id, 'str')
query_parameters = {}
if include_all_versions is not None:
query_parameters['includeAllVersions'] = self._serialize.query('include_all_versions', include_all_versions, 'bool')
if include_urls is not None:
query_parameters['includeUrls'] = self._serialize.query('include_urls', include_urls, 'bool')
if is_listed is not None:
query_parameters['isListed'] = self._serialize.query('is_listed', is_listed, 'bool')
if is_release is not None:
query_parameters['isRelease'] = self._serialize.query('is_release', is_release, 'bool')
if include_deleted is not None:
query_parameters['includeDeleted'] = self._serialize.query('include_deleted', include_deleted, 'bool')
if include_description is not None:
query_parameters['includeDescription'] = self._serialize.query('include_description', include_description, 'bool')
response = self._send(http_method='GET',
location_id='7a20d846-c929-4acc-9ea2-0d5a7df1b197',
version='5.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('Package', response)
def get_packages(self, feed_id, protocol_type=None, package_name_query=None, normalized_package_name=None, include_urls=None, include_all_versions=None, is_listed=None, get_top_package_versions=None, is_release=None, include_description=None, top=None, skip=None, include_deleted=None, is_cached=None, direct_upstream_id=None):
"""GetPackages.
[Preview API] Get details about all of the packages in the feed. Use the various filters to include or exclude information from the result set.
:param str feed_id: Name or Id of the feed.
:param str protocol_type: One of the supported artifact package types.
:param str package_name_query: Filter to packages that contain the provided string. Characters in the string must conform to the package name constraints.
:param str normalized_package_name: [Obsolete] Used for legacy scenarios and may be removed in future versions.
:param bool include_urls: True to return REST Urls with the response. Default is True.
:param bool include_all_versions: True to return all versions of the package in the response. Default is false (latest version only).
:param bool is_listed: Only applicable for NuGet packages, setting it for other package types will result in a 404. If false, delisted package versions will be returned. Use this to filter the response when includeAllVersions is set to true. Default is unset (do not return delisted packages).
:param bool get_top_package_versions: Changes the behavior of $top and $skip to return all versions of each package up to $top. Must be used in conjunction with includeAllVersions=true
:param bool is_release: Only applicable for Nuget packages. Use this to filter the response when includeAllVersions is set to true. Default is True (only return packages without prerelease versioning).
:param bool include_description: Return the description for every version of each package in the response. Default is False.
:param int top: Get the top N packages (or package versions where getTopPackageVersions=true)
:param int skip: Skip the first N packages (or package versions where getTopPackageVersions=true)
:param bool include_deleted: Return deleted or unpublished versions of packages in the response. Default is False.
:param bool is_cached: [Obsolete] Used for legacy scenarios and may be removed in future versions.
:param str direct_upstream_id: Filter results to return packages from a specific upstream.
:rtype: [Package]
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
query_parameters = {}
if protocol_type is not None:
query_parameters['protocolType'] = self._serialize.query('protocol_type', protocol_type, 'str')
if package_name_query is not None:
query_parameters['packageNameQuery'] = self._serialize.query('package_name_query', package_name_query, 'str')
if normalized_package_name is not None:
query_parameters['normalizedPackageName'] = self._serialize.query('normalized_package_name', normalized_package_name, 'str')
if include_urls is not None:
query_parameters['includeUrls'] = self._serialize.query('include_urls', include_urls, 'bool')
if include_all_versions is not None:
query_parameters['includeAllVersions'] = self._serialize.query('include_all_versions', include_all_versions, 'bool')
if is_listed is not None:
query_parameters['isListed'] = self._serialize.query('is_listed', is_listed, 'bool')
if get_top_package_versions is not None:
query_parameters['getTopPackageVersions'] = self._serialize.query('get_top_package_versions', get_top_package_versions, 'bool')
if is_release is not None:
query_parameters['isRelease'] = self._serialize.query('is_release', is_release, 'bool')
if include_description is not None:
query_parameters['includeDescription'] = self._serialize.query('include_description', include_description, 'bool')
if top is not None:
query_parameters['$top'] = self._serialize.query('top', top, 'int')
if skip is not None:
query_parameters['$skip'] = self._serialize.query('skip', skip, 'int')
if include_deleted is not None:
query_parameters['includeDeleted'] = self._serialize.query('include_deleted', include_deleted, 'bool')
if is_cached is not None:
query_parameters['isCached'] = self._serialize.query('is_cached', is_cached, 'bool')
if direct_upstream_id is not None:
query_parameters['directUpstreamId'] = self._serialize.query('direct_upstream_id', direct_upstream_id, 'str')
response = self._send(http_method='GET',
location_id='7a20d846-c929-4acc-9ea2-0d5a7df1b197',
version='5.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('[Package]', self._unwrap_collection(response))
def get_feed_permissions(self, feed_id, include_ids=None, exclude_inherited_permissions=None, identity_descriptor=None):
"""GetFeedPermissions.
[Preview API] Get the permissions for a feed.
:param str feed_id: Name or Id of the feed.
:param bool include_ids: True to include user Ids in the response. Default is false.
:param bool exclude_inherited_permissions: True to only return explicitly set permissions on the feed. Default is false.
:param str identity_descriptor: Filter permissions to the provided identity.
:rtype: [FeedPermission]
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
query_parameters = {}
if include_ids is not None:
query_parameters['includeIds'] = self._serialize.query('include_ids', include_ids, 'bool')
if exclude_inherited_permissions is not None:
query_parameters['excludeInheritedPermissions'] = self._serialize.query('exclude_inherited_permissions', exclude_inherited_permissions, 'bool')
if identity_descriptor is not None:
query_parameters['identityDescriptor'] = self._serialize.query('identity_descriptor', identity_descriptor, 'str')
response = self._send(http_method='GET',
location_id='be8c1476-86a7-44ed-b19d-aec0e9275cd8',
version='5.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('[FeedPermission]', self._unwrap_collection(response))
def set_feed_permissions(self, feed_permission, feed_id):
"""SetFeedPermissions.
[Preview API] Update the permissions on a feed.
:param [FeedPermission] feed_permission: Permissions to set.
:param str feed_id: Name or Id of the feed.
:rtype: [FeedPermission]
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
content = self._serialize.body(feed_permission, '[FeedPermission]')
response = self._send(http_method='PATCH',
location_id='be8c1476-86a7-44ed-b19d-aec0e9275cd8',
version='5.0-preview.1',
route_values=route_values,
content=content)
return self._deserialize('[FeedPermission]', self._unwrap_collection(response))
def get_package_version_provenance(self, feed_id, package_id, package_version_id):
"""GetPackageVersionProvenance.
[Preview API] Gets provenance for a package version.
:param str feed_id: Name or Id of the feed.
:param str package_id: Id of the package (GUID Id, not name).
:param str package_version_id: Id of the package version (GUID Id, not name).
:rtype: :class:`<PackageVersionProvenance> <azure.devops.v5_0.feed.models.PackageVersionProvenance>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
if package_id is not None:
route_values['packageId'] = self._serialize.url('package_id', package_id, 'str')
if package_version_id is not None:
route_values['packageVersionId'] = self._serialize.url('package_version_id', package_version_id, 'str')
response = self._send(http_method='GET',
location_id='0aaeabd4-85cd-4686-8a77-8d31c15690b8',
version='5.0-preview.1',
route_values=route_values)
return self._deserialize('PackageVersionProvenance', response)
def get_recycle_bin_package(self, feed_id, package_id, include_urls=None):
"""GetRecycleBinPackage.
[Preview API] Get information about a package and all its versions within the recycle bin.
:param str feed_id: Name or Id of the feed.
:param str package_id: The package Id (GUID Id, not the package name).
:param bool include_urls: True to return REST Urls with the response. Default is True.
:rtype: :class:`<Package> <azure.devops.v5_0.feed.models.Package>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
if package_id is not None:
route_values['packageId'] = self._serialize.url('package_id', package_id, 'str')
query_parameters = {}
if include_urls is not None:
query_parameters['includeUrls'] = self._serialize.query('include_urls', include_urls, 'bool')
response = self._send(http_method='GET',
location_id='2704e72c-f541-4141-99be-2004b50b05fa',
version='5.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('Package', response)
def get_recycle_bin_packages(self, feed_id, protocol_type=None, package_name_query=None, include_urls=None, top=None, skip=None, include_all_versions=None):
"""GetRecycleBinPackages.
[Preview API] Query for packages within the recycle bin.
:param str feed_id: Name or Id of the feed.
:param str protocol_type: Type of package (e.g. NuGet, npm, ...).
:param str package_name_query: Filter to packages matching this name.
:param bool include_urls: True to return REST Urls with the response. Default is True.
:param int top: Get the top N packages.
:param int skip: Skip the first N packages.
:param bool include_all_versions: True to return all versions of the package in the response. Default is false (latest version only).
:rtype: [Package]
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
query_parameters = {}
if protocol_type is not None:
query_parameters['protocolType'] = self._serialize.query('protocol_type', protocol_type, 'str')
if package_name_query is not None:
query_parameters['packageNameQuery'] = self._serialize.query('package_name_query', package_name_query, 'str')
if include_urls is not None:
query_parameters['includeUrls'] = self._serialize.query('include_urls', include_urls, 'bool')
if top is not None:
query_parameters['$top'] = self._serialize.query('top', top, 'int')
if skip is not None:
query_parameters['$skip'] = self._serialize.query('skip', skip, 'int')
if include_all_versions is not None:
query_parameters['includeAllVersions'] = self._serialize.query('include_all_versions', include_all_versions, 'bool')
response = self._send(http_method='GET',
location_id='2704e72c-f541-4141-99be-2004b50b05fa',
version='5.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('[Package]', self._unwrap_collection(response))
def get_recycle_bin_package_version(self, feed_id, package_id, package_version_id, include_urls=None):
"""GetRecycleBinPackageVersion.
[Preview API] Get information about a package version within the recycle bin.
:param str feed_id: Name or Id of the feed.
:param str package_id: The package Id (GUID Id, not the package name).
:param str package_version_id: The package version Id 9guid Id, not the version string).
:param bool include_urls: True to return REST Urls with the response. Default is True.
:rtype: :class:`<RecycleBinPackageVersion> <azure.devops.v5_0.feed.models.RecycleBinPackageVersion>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
if package_id is not None:
route_values['packageId'] = self._serialize.url('package_id', package_id, 'str')
if package_version_id is not None:
route_values['packageVersionId'] = self._serialize.url('package_version_id', package_version_id, 'str')
query_parameters = {}
if include_urls is not None:
query_parameters['includeUrls'] = self._serialize.query('include_urls', include_urls, 'bool')
response = self._send(http_method='GET',
location_id='aceb4be7-8737-4820-834c-4c549e10fdc7',
version='5.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('RecycleBinPackageVersion', response)
def get_recycle_bin_package_versions(self, feed_id, package_id, include_urls=None):
"""GetRecycleBinPackageVersions.
[Preview API] Get a list of package versions within the recycle bin.
:param str feed_id: Name or Id of the feed.
:param str package_id: The package Id (GUID Id, not the package name).
:param bool include_urls: True to return REST Urls with the response. Default is True.
:rtype: [RecycleBinPackageVersion]
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
if package_id is not None:
route_values['packageId'] = self._serialize.url('package_id', package_id, 'str')
query_parameters = {}
if include_urls is not None:
query_parameters['includeUrls'] = self._serialize.query('include_urls', include_urls, 'bool')
response = self._send(http_method='GET',
location_id='aceb4be7-8737-4820-834c-4c549e10fdc7',
version='5.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('[RecycleBinPackageVersion]', self._unwrap_collection(response))
def delete_feed_retention_policies(self, feed_id):
"""DeleteFeedRetentionPolicies.
[Preview API] Delete the retention policy for a feed.
:param str feed_id: Name or ID of the feed.
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
self._send(http_method='DELETE',
location_id='ed52a011-0112-45b5-9f9e-e14efffb3193',
version='5.0-preview.1',
route_values=route_values)
def get_feed_retention_policies(self, feed_id):
"""GetFeedRetentionPolicies.
[Preview API] Get the retention policy for a feed.
:param str feed_id: Name or ID of the feed.
:rtype: :class:`<FeedRetentionPolicy> <azure.devops.v5_0.feed.models.FeedRetentionPolicy>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
response = self._send(http_method='GET',
location_id='ed52a011-0112-45b5-9f9e-e14efffb3193',
version='5.0-preview.1',
route_values=route_values)
return self._deserialize('FeedRetentionPolicy', response)
def set_feed_retention_policies(self, policy, feed_id):
"""SetFeedRetentionPolicies.
[Preview API] Set the retention policy for a feed.
:param :class:`<FeedRetentionPolicy> <azure.devops.v5_0.feed.models.FeedRetentionPolicy>` policy: Feed retention policy.
:param str feed_id: Name or ID of the feed.
:rtype: :class:`<FeedRetentionPolicy> <azure.devops.v5_0.feed.models.FeedRetentionPolicy>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
content = self._serialize.body(policy, 'FeedRetentionPolicy')
response = self._send(http_method='PUT',
location_id='ed52a011-0112-45b5-9f9e-e14efffb3193',
version='5.0-preview.1',
route_values=route_values,
content=content)
return self._deserialize('FeedRetentionPolicy', response)
def get_package_version(self, feed_id, package_id, package_version_id, include_urls=None, is_listed=None, is_deleted=None):
"""GetPackageVersion.
[Preview API] Get details about a specific package version.
:param str feed_id: Name or Id of the feed.
:param str package_id: Id of the package (GUID Id, not name).
:param str package_version_id: Id of the package version (GUID Id, not name).
:param bool include_urls: True to include urls for each version. Default is true.
:param bool is_listed: Only applicable for NuGet packages. If false, delisted package versions will be returned.
:param bool is_deleted: Return deleted or unpublished versions of packages in the response. Default is unset (do not return deleted versions).
:rtype: :class:`<PackageVersion> <azure.devops.v5_0.feed.models.PackageVersion>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
if package_id is not None:
route_values['packageId'] = self._serialize.url('package_id', package_id, 'str')
if package_version_id is not None:
route_values['packageVersionId'] = self._serialize.url('package_version_id', package_version_id, 'str')
query_parameters = {}
if include_urls is not None:
query_parameters['includeUrls'] = self._serialize.query('include_urls', include_urls, 'bool')
if is_listed is not None:
query_parameters['isListed'] = self._serialize.query('is_listed', is_listed, 'bool')
if is_deleted is not None:
query_parameters['isDeleted'] = self._serialize.query('is_deleted', is_deleted, 'bool')
response = self._send(http_method='GET',
location_id='3b331909-6a86-44cc-b9ec-c1834c35498f',
version='5.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('PackageVersion', response)
def get_package_versions(self, feed_id, package_id, include_urls=None, is_listed=None, is_deleted=None):
"""GetPackageVersions.
[Preview API] Get a list of package versions, optionally filtering by state.
:param str feed_id: Name or Id of the feed.
:param str package_id: Id of the package (GUID Id, not name).
:param bool include_urls: True to include urls for each version. Default is true.
:param bool is_listed: Only applicable for NuGet packages. If false, delisted package versions will be returned.
:param bool is_deleted: Return deleted or unpublished versions of packages in the response. Default is unset (do not return deleted versions).
:rtype: [PackageVersion]
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
if package_id is not None:
route_values['packageId'] = self._serialize.url('package_id', package_id, 'str')
query_parameters = {}
if include_urls is not None:
query_parameters['includeUrls'] = self._serialize.query('include_urls', include_urls, 'bool')
if is_listed is not None:
query_parameters['isListed'] = self._serialize.query('is_listed', is_listed, 'bool')
if is_deleted is not None:
query_parameters['isDeleted'] = self._serialize.query('is_deleted', is_deleted, 'bool')
response = self._send(http_method='GET',
location_id='3b331909-6a86-44cc-b9ec-c1834c35498f',
version='5.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('[PackageVersion]', self._unwrap_collection(response))
def create_feed_view(self, view, feed_id):
"""CreateFeedView.
[Preview API] Create a new view on the referenced feed.
:param :class:`<FeedView> <azure.devops.v5_0.feed.models.FeedView>` view: View to be created.
:param str feed_id: Name or Id of the feed.
:rtype: :class:`<FeedView> <azure.devops.v5_0.feed.models.FeedView>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
content = self._serialize.body(view, 'FeedView')
response = self._send(http_method='POST',
location_id='42a8502a-6785-41bc-8c16-89477d930877',
version='5.0-preview.1',
route_values=route_values,
content=content)
return self._deserialize('FeedView', response)
def delete_feed_view(self, feed_id, view_id):
"""DeleteFeedView.
[Preview API] Delete a feed view.
:param str feed_id: Name or Id of the feed.
:param str view_id: Name or Id of the view.
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
if view_id is not None:
route_values['viewId'] = self._serialize.url('view_id', view_id, 'str')
self._send(http_method='DELETE',
location_id='42a8502a-6785-41bc-8c16-89477d930877',
version='5.0-preview.1',
route_values=route_values)
def get_feed_view(self, feed_id, view_id):
"""GetFeedView.
[Preview API] Get a view by Id.
:param str feed_id: Name or Id of the feed.
:param str view_id: Name or Id of the view.
:rtype: :class:`<FeedView> <azure.devops.v5_0.feed.models.FeedView>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
if view_id is not None:
route_values['viewId'] = self._serialize.url('view_id', view_id, 'str')
response = self._send(http_method='GET',
location_id='42a8502a-6785-41bc-8c16-89477d930877',
version='5.0-preview.1',
route_values=route_values)
return self._deserialize('FeedView', response)
def get_feed_views(self, feed_id):
"""GetFeedViews.
[Preview API] Get all views for a feed.
:param str feed_id: Name or Id of the feed.
:rtype: [FeedView]
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
response = self._send(http_method='GET',
location_id='42a8502a-6785-41bc-8c16-89477d930877',
version='5.0-preview.1',
route_values=route_values)
return self._deserialize('[FeedView]', self._unwrap_collection(response))
def update_feed_view(self, view, feed_id, view_id):
"""UpdateFeedView.
[Preview API] Update a view.
:param :class:`<FeedView> <azure.devops.v5_0.feed.models.FeedView>` view: New settings to apply to the specified view.
:param str feed_id: Name or Id of the feed.
:param str view_id: Name or Id of the view.
:rtype: :class:`<FeedView> <azure.devops.v5_0.feed.models.FeedView>`
"""
route_values = {}
if feed_id is not None:
route_values['feedId'] = self._serialize.url('feed_id', feed_id, 'str')
if view_id is not None:
route_values['viewId'] = self._serialize.url('view_id', view_id, 'str')
content = self._serialize.body(view, 'FeedView')
response = self._send(http_method='PATCH',
location_id='42a8502a-6785-41bc-8c16-89477d930877',
version='5.0-preview.1',
route_values=route_values,
content=content)
return self._deserialize('FeedView', response)
|