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 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="clouddeploy_v1.html">Cloud Deploy API</a> . <a href="clouddeploy_v1.projects.html">projects</a> . <a href="clouddeploy_v1.projects.locations.html">locations</a> . <a href="clouddeploy_v1.projects.locations.deliveryPipelines.html">deliveryPipelines</a> . <a href="clouddeploy_v1.projects.locations.deliveryPipelines.releases.html">releases</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html">rollouts()</a></code>
</p>
<p class="firstline">Returns the rollouts Resource.</p>
<p class="toc_element">
<code><a href="#abandon">abandon(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Abandons a Release in the Delivery Pipeline.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, overrideDeployPolicy=None, releaseId=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Release in a given project and location.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Release.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Releases in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="abandon">abandon(name, body=None, x__xgafv=None)</code>
<pre>Abandons a Release in the Delivery Pipeline.
Args:
name: string, Required. Name of the Release. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. (required)
body: object, The request body.
The object takes the form of:
{ # The request object used by `AbandonRelease`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response object for `AbandonRelease`.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, overrideDeployPolicy=None, releaseId=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Creates a new Release in a given project and location.
Args:
parent: string, Required. The parent collection in which the `Release` is created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. (required)
body: object, The request body.
The object takes the form of:
{ # A `Release` resource in the Cloud Deploy API. A `Release` defines a specific Skaffold configuration instance that can be deployed.
"abandoned": True or False, # Output only. Indicates whether this is an abandoned release.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"buildArtifacts": [ # Optional. List of artifacts to pass through to Skaffold command.
{ # Description of an a image to use during Skaffold rendering.
"image": "A String", # Optional. Image name in Skaffold configuration.
"tag": "A String", # Optional. Image tag to use. This will generally be the full path to an image, such as "gcr.io/my-project/busybox:1.2.3" or "gcr.io/my-project/busybox@sha256:abc123".
},
],
"condition": { # ReleaseCondition contains all conditions relevant to a Release. # Output only. Information around the state of the Release.
"releaseReadyCondition": { # ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release. # Details around the Releases's overall status.
"status": True or False, # True if the Release is in a valid state. Otherwise at least one condition in `ReleaseCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.
},
"skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends. # Details around the support state of the release's Skaffold version.
"maintenanceModeTime": "A String", # The time at which this release's version of Skaffold will enter maintenance mode.
"skaffoldSupportState": "A String", # The Skaffold support state for this release's version of Skaffold.
"status": True or False, # True if the version of Skaffold used by this release is supported.
"supportExpirationTime": "A String", # The time at which this release's version of Skaffold will no longer be supported.
},
},
"createTime": "A String", # Output only. Time at which the `Release` was created.
"customTargetTypeSnapshots": [ # Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
{ # A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to other systems besides the supported runtimes.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
"customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Optional. Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
"deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
"includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
{ # Skaffold Config modules and their remote source.
"configs": [ # Optional. The Skaffold Config modules to use from the specified source.
"A String",
],
"git": { # Git repository containing Skaffold Config modules. # Optional. Remote git repository containing the Skaffold Config modules.
"path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
"ref": "A String", # Optional. Git branch or tag to use when cloning the repository.
"repo": "A String", # Required. Git repository the package should be cloned from.
},
"googleCloudBuildRepo": { # Cloud Build V2 Repository containing Skaffold Configs. # Optional. Cloud Build V2 repository containing the Skaffold Config modules.
"path": "A String", # Optional. Relative path from the repository root to the Skaffold Config file.
"ref": "A String", # Optional. Branch or tag to use when cloning the repository.
"repository": "A String", # Required. Name of the Cloud Build V2 Repository. Format is projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}.
},
"googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Optional. Cloud Storage bucket containing the Skaffold Config modules.
"path": "A String", # Optional. Relative path from the source to the Skaffold file.
"source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
},
},
],
"renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
},
"customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
"description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/{customTargetType}`. The `customTargetType` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
"updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
},
],
"deliveryPipelineSnapshot": { # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. # Output only. Snapshot of the parent pipeline taken at release creation time.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
},
"condition": { # PipelineCondition contains all conditions relevant to a Delivery Pipeline. # Output only. Information around the state of the Delivery Pipeline.
"pipelineReadyCondition": { # PipelineReadyCondition contains information around the status of the Pipeline. # Details around the Pipeline's overall status.
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type.
"errorDetails": "A String", # Human readable error message.
"status": True or False, # True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters.
},
},
"createTime": "A String", # Output only. Time at which the pipeline was created.
"description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"serialPipeline": { # SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. # Optional. SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.
"stages": [ # Optional. Each stage specifies configuration for a `Target`. The ordering of this list defines the promotion flow.
{ # Stage specifies a location to which to deploy.
"deployParameters": [ # Optional. The deploy parameters to use for the target in this stage.
{ # DeployParameters contains deploy parameters information.
"matchTargetLabels": { # Optional. Deploy parameters are applied to targets with match labels. If unspecified, deploy parameters are applied to all targets (including child targets of a multi-target).
"a_key": "A String",
},
"values": { # Required. Values are deploy parameters in key-value pairs.
"a_key": "A String",
},
},
],
"profiles": [ # Optional. Skaffold profiles to use when rendering the manifest for this stage's `Target`.
"A String",
],
"strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage.
"canary": { # Canary represents the canary deployment strategy. # Optional. Canary deployment strategy provides progressive percentage based deployments to a Target.
"canaryDeployment": { # CanaryDeployment represents the canary deployment configuration # Optional. Configures the progressive based deployment for a Target.
"percentages": [ # Required. The percentage based deployments that will occur as a part of a `Rollout`. List is expected in ascending order and each integer n is 0 <= n < 100. If the GatewayServiceMesh is configured for Kubernetes, then the range for n is 0 <= n <= 100.
42,
],
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Optional. Whether to run verify tests after each percentage deployment via `skaffold verify`.
},
"customCanaryDeployment": { # CustomCanaryDeployment represents the custom canary deployment configuration. # Optional. Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.
"phaseConfigs": [ # Required. Configuration for each phase in the canary deployment in the order executed.
{ # PhaseConfig represents the configuration for a phase in the custom canary deployment.
"percentage": 42, # Required. Percentage deployment for the phase.
"phaseId": "A String", # Required. The ID to assign to the `Rollout` phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of this phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"profiles": [ # Optional. Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the `DeliveryPipeline` stage.
"A String",
],
"verify": True or False, # Optional. Whether to run verify tests after the deployment via `skaffold verify`.
},
],
},
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Optional. Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Optional. Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
"canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary phase is in progress.
"A String",
],
"priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary phase is in progress.
"A String",
],
"stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision when the stable phase is applied.
"A String",
],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Optional. Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Optional. Kubernetes Gateway API service mesh configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.
"httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute.
"podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.
"routeDestinations": { # Information about route destinations for the Gateway API service mesh. # Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster.
"destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster.
"A String",
],
"propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.
},
"routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time.
"service": "A String", # Required. Name of the Kubernetes Service.
"stableCutbackDuration": "A String", # Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time.
},
"serviceNetworking": { # Information about the Kubernetes Service networking configuration. # Optional. Kubernetes Service networking configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified Service.
"disablePodOverprovisioning": True or False, # Optional. Whether to disable Pod overprovisioning. If Pod overprovisioning is disabled then Cloud Deploy will limit the number of total Pods used for the deployment strategy to the number of Pods the Deployment has on the cluster.
"podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment.
"service": "A String", # Required. Name of the Kubernetes Service.
},
},
},
},
"standard": { # Standard represents the standard deployment strategy. # Optional. Standard deployment strategy executes a single deploy and allows verifying the deployment.
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job. If this is not configured, the postdeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job. If this is not configured, the predeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Optional. Whether to verify a deployment via `skaffold verify`.
},
},
"targetId": "A String", # Optional. The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`.
},
],
},
"suspended": True or False, # Optional. When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
"uid": "A String", # Output only. Unique identifier of the `DeliveryPipeline`.
"updateTime": "A String", # Output only. Most recent time at which the pipeline was updated.
},
"deployParameters": { # Optional. The deploy parameters to use for all targets in this release.
"a_key": "A String",
},
"description": "A String", # Optional. Description of the `Release`. Max length is 255 characters.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"renderEndTime": "A String", # Output only. Time at which the render completed.
"renderStartTime": "A String", # Output only. Time at which the render began.
"renderState": "A String", # Output only. Current state of the render operation.
"skaffoldConfigPath": "A String", # Optional. Filepath of the Skaffold config inside of the config URI.
"skaffoldConfigUri": "A String", # Optional. Cloud Storage URI of tar.gz archive containing Skaffold configuration.
"skaffoldVersion": "A String", # Optional. The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.
"targetArtifacts": { # Output only. Map from target ID to the target artifacts created during the render operation.
"a_key": { # The artifacts produced by a target render operation.
"artifactUri": "A String", # Output only. URI of a directory containing the artifacts. This contains deployment configuration used by Skaffold during a rollout, and all paths are relative to this location.
"manifestPath": "A String", # Output only. File path of the rendered manifest relative to the URI for the stable phase.
"phaseArtifacts": { # Output only. Map from the phase ID to the phase artifacts for the `Target`.
"a_key": { # Contains the paths to the artifacts, relative to the URI, for a phase.
"jobManifestsPath": "A String", # Output only. File path of the directory of rendered job manifests relative to the URI. This is only set if it is applicable.
"manifestPath": "A String", # Output only. File path of the rendered manifest relative to the URI.
"skaffoldConfigPath": "A String", # Output only. File path of the resolved Skaffold configuration relative to the URI.
},
},
"skaffoldConfigPath": "A String", # Output only. File path of the resolved Skaffold configuration for the stable phase, relative to the URI.
},
},
"targetRenders": { # Output only. Map from target ID to details of the render operation for that target.
"a_key": { # Details of rendering for a single target.
"failureCause": "A String", # Output only. Reason this render failed. This will always be unspecified while the render in progress.
"failureMessage": "A String", # Output only. Additional information about the render failure, if available.
"metadata": { # RenderMetadata includes information associated with a `Release` render. # Output only. Metadata related to the `Release` render for this Target.
"cloudRun": { # CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render. # Output only. Metadata associated with rendering for Cloud Run.
"service": "A String", # Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}`.
},
"custom": { # CustomMetadata contains information from a user-defined operation. # Output only. Custom metadata provided by user-defined render operation.
"values": { # Output only. Key-value pairs provided by the user-defined operation.
"a_key": "A String",
},
},
},
"renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.
"renderingState": "A String", # Output only. Current state of the render operation for this Target.
},
},
"targetSnapshots": [ # Output only. Snapshot of the targets taken at release creation time.
{ # A `Target` resource in the Cloud Deploy API. A `Target` defines a location to which a Skaffold configuration can be deployed.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"anthosCluster": { # Information specifying an Anthos Cluster. # Optional. Information specifying an Anthos Cluster.
"membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"associatedEntities": { # Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
"a_key": { # Information about entities associated with a `Target`.
"anthosClusters": [ # Optional. Information specifying Anthos clusters as associated entities.
{ # Information specifying an Anthos Cluster.
"membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
],
"gkeClusters": [ # Optional. Information specifying GKE clusters as associated entities.
{ # Information specifying a GKE Cluster.
"cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`.
"dnsEndpoint": True or False, # Optional. If set, the cluster will be accessed using the DNS endpoint. Note that both `dns_endpoint` and `internal_ip` cannot be set to true.
"internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). Note that `internal_ip` and `dns_endpoint` cannot both be set to true.
"proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server.
},
],
},
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
"customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
"customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
},
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
"description": "A String", # Optional. Description of the `Target`. Max length is 255 characters.
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"executionConfigs": [ # Optional. Configurations for all execution that relates to this `Target`. Each `ExecutionEnvironmentUsage` value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the `RENDER` and `DEPLOY` `ExecutionEnvironmentUsage` values. When no configurations are specified, execution will use the default specified in `DefaultPool`.
{ # Configuration of the environment to use when calling Skaffold.
"artifactStorage": "A String", # Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
"defaultPool": { # Execution using the default Cloud Build pool. # Optional. Use default Cloud Build pool.
"artifactStorage": "A String", # Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
"serviceAccount": "A String", # Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) will be used.
},
"executionTimeout": "A String", # Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.
"privatePool": { # Execution using a private Cloud Build pool. # Optional. Use private Cloud Build pool.
"artifactStorage": "A String", # Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
"serviceAccount": "A String", # Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) will be used.
"workerPool": "A String", # Required. Resource name of the Cloud Build worker pool to use. The format is `projects/{project}/locations/{location}/workerPools/{pool}`.
},
"serviceAccount": "A String", # Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) is used.
"usages": [ # Required. Usages when this configuration should be applied.
"A String",
],
"verbose": True or False, # Optional. If true, additional logging will be enabled when running builds in this execution environment.
"workerPool": "A String", # Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.
},
],
"gke": { # Information specifying a GKE Cluster. # Optional. Information specifying a GKE Cluster.
"cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`.
"dnsEndpoint": True or False, # Optional. If set, the cluster will be accessed using the DNS endpoint. Note that both `dns_endpoint` and `internal_ip` cannot be set to true.
"internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). Note that `internal_ip` and `dns_endpoint` cannot both be set to true.
"proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server.
},
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"multiTarget": { # Information specifying a multiTarget. # Optional. Information specifying a multiTarget.
"targetIds": [ # Required. The target_ids of this multiTarget.
"A String",
],
},
"name": "A String", # Identifier. Name of the `Target`. Format is `projects/{project}/locations/{location}/targets/{target}`. The `target` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"requireApproval": True or False, # Optional. Whether or not the `Target` requires approval.
"run": { # Information specifying where to deploy a Cloud Run Service. # Optional. Information specifying a Cloud Run deployment target.
"location": "A String", # Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`.
},
"targetId": "A String", # Output only. Resource id of the `Target`.
"uid": "A String", # Output only. Unique identifier of the `Target`.
"updateTime": "A String", # Output only. Most recent time at which the `Target` was updated.
},
],
"uid": "A String", # Output only. Unique identifier of the `Release`.
}
overrideDeployPolicy: string, Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`. (repeated)
releaseId: string, Required. ID of the `Release`.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Release.
Args:
name: string, Required. Name of the `Release`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A `Release` resource in the Cloud Deploy API. A `Release` defines a specific Skaffold configuration instance that can be deployed.
"abandoned": True or False, # Output only. Indicates whether this is an abandoned release.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"buildArtifacts": [ # Optional. List of artifacts to pass through to Skaffold command.
{ # Description of an a image to use during Skaffold rendering.
"image": "A String", # Optional. Image name in Skaffold configuration.
"tag": "A String", # Optional. Image tag to use. This will generally be the full path to an image, such as "gcr.io/my-project/busybox:1.2.3" or "gcr.io/my-project/busybox@sha256:abc123".
},
],
"condition": { # ReleaseCondition contains all conditions relevant to a Release. # Output only. Information around the state of the Release.
"releaseReadyCondition": { # ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release. # Details around the Releases's overall status.
"status": True or False, # True if the Release is in a valid state. Otherwise at least one condition in `ReleaseCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.
},
"skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends. # Details around the support state of the release's Skaffold version.
"maintenanceModeTime": "A String", # The time at which this release's version of Skaffold will enter maintenance mode.
"skaffoldSupportState": "A String", # The Skaffold support state for this release's version of Skaffold.
"status": True or False, # True if the version of Skaffold used by this release is supported.
"supportExpirationTime": "A String", # The time at which this release's version of Skaffold will no longer be supported.
},
},
"createTime": "A String", # Output only. Time at which the `Release` was created.
"customTargetTypeSnapshots": [ # Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
{ # A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to other systems besides the supported runtimes.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
"customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Optional. Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
"deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
"includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
{ # Skaffold Config modules and their remote source.
"configs": [ # Optional. The Skaffold Config modules to use from the specified source.
"A String",
],
"git": { # Git repository containing Skaffold Config modules. # Optional. Remote git repository containing the Skaffold Config modules.
"path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
"ref": "A String", # Optional. Git branch or tag to use when cloning the repository.
"repo": "A String", # Required. Git repository the package should be cloned from.
},
"googleCloudBuildRepo": { # Cloud Build V2 Repository containing Skaffold Configs. # Optional. Cloud Build V2 repository containing the Skaffold Config modules.
"path": "A String", # Optional. Relative path from the repository root to the Skaffold Config file.
"ref": "A String", # Optional. Branch or tag to use when cloning the repository.
"repository": "A String", # Required. Name of the Cloud Build V2 Repository. Format is projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}.
},
"googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Optional. Cloud Storage bucket containing the Skaffold Config modules.
"path": "A String", # Optional. Relative path from the source to the Skaffold file.
"source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
},
},
],
"renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
},
"customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
"description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/{customTargetType}`. The `customTargetType` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
"updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
},
],
"deliveryPipelineSnapshot": { # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. # Output only. Snapshot of the parent pipeline taken at release creation time.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
},
"condition": { # PipelineCondition contains all conditions relevant to a Delivery Pipeline. # Output only. Information around the state of the Delivery Pipeline.
"pipelineReadyCondition": { # PipelineReadyCondition contains information around the status of the Pipeline. # Details around the Pipeline's overall status.
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type.
"errorDetails": "A String", # Human readable error message.
"status": True or False, # True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters.
},
},
"createTime": "A String", # Output only. Time at which the pipeline was created.
"description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"serialPipeline": { # SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. # Optional. SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.
"stages": [ # Optional. Each stage specifies configuration for a `Target`. The ordering of this list defines the promotion flow.
{ # Stage specifies a location to which to deploy.
"deployParameters": [ # Optional. The deploy parameters to use for the target in this stage.
{ # DeployParameters contains deploy parameters information.
"matchTargetLabels": { # Optional. Deploy parameters are applied to targets with match labels. If unspecified, deploy parameters are applied to all targets (including child targets of a multi-target).
"a_key": "A String",
},
"values": { # Required. Values are deploy parameters in key-value pairs.
"a_key": "A String",
},
},
],
"profiles": [ # Optional. Skaffold profiles to use when rendering the manifest for this stage's `Target`.
"A String",
],
"strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage.
"canary": { # Canary represents the canary deployment strategy. # Optional. Canary deployment strategy provides progressive percentage based deployments to a Target.
"canaryDeployment": { # CanaryDeployment represents the canary deployment configuration # Optional. Configures the progressive based deployment for a Target.
"percentages": [ # Required. The percentage based deployments that will occur as a part of a `Rollout`. List is expected in ascending order and each integer n is 0 <= n < 100. If the GatewayServiceMesh is configured for Kubernetes, then the range for n is 0 <= n <= 100.
42,
],
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Optional. Whether to run verify tests after each percentage deployment via `skaffold verify`.
},
"customCanaryDeployment": { # CustomCanaryDeployment represents the custom canary deployment configuration. # Optional. Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.
"phaseConfigs": [ # Required. Configuration for each phase in the canary deployment in the order executed.
{ # PhaseConfig represents the configuration for a phase in the custom canary deployment.
"percentage": 42, # Required. Percentage deployment for the phase.
"phaseId": "A String", # Required. The ID to assign to the `Rollout` phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of this phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"profiles": [ # Optional. Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the `DeliveryPipeline` stage.
"A String",
],
"verify": True or False, # Optional. Whether to run verify tests after the deployment via `skaffold verify`.
},
],
},
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Optional. Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Optional. Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
"canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary phase is in progress.
"A String",
],
"priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary phase is in progress.
"A String",
],
"stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision when the stable phase is applied.
"A String",
],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Optional. Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Optional. Kubernetes Gateway API service mesh configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.
"httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute.
"podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.
"routeDestinations": { # Information about route destinations for the Gateway API service mesh. # Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster.
"destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster.
"A String",
],
"propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.
},
"routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time.
"service": "A String", # Required. Name of the Kubernetes Service.
"stableCutbackDuration": "A String", # Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time.
},
"serviceNetworking": { # Information about the Kubernetes Service networking configuration. # Optional. Kubernetes Service networking configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified Service.
"disablePodOverprovisioning": True or False, # Optional. Whether to disable Pod overprovisioning. If Pod overprovisioning is disabled then Cloud Deploy will limit the number of total Pods used for the deployment strategy to the number of Pods the Deployment has on the cluster.
"podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment.
"service": "A String", # Required. Name of the Kubernetes Service.
},
},
},
},
"standard": { # Standard represents the standard deployment strategy. # Optional. Standard deployment strategy executes a single deploy and allows verifying the deployment.
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job. If this is not configured, the postdeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job. If this is not configured, the predeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Optional. Whether to verify a deployment via `skaffold verify`.
},
},
"targetId": "A String", # Optional. The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`.
},
],
},
"suspended": True or False, # Optional. When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
"uid": "A String", # Output only. Unique identifier of the `DeliveryPipeline`.
"updateTime": "A String", # Output only. Most recent time at which the pipeline was updated.
},
"deployParameters": { # Optional. The deploy parameters to use for all targets in this release.
"a_key": "A String",
},
"description": "A String", # Optional. Description of the `Release`. Max length is 255 characters.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"renderEndTime": "A String", # Output only. Time at which the render completed.
"renderStartTime": "A String", # Output only. Time at which the render began.
"renderState": "A String", # Output only. Current state of the render operation.
"skaffoldConfigPath": "A String", # Optional. Filepath of the Skaffold config inside of the config URI.
"skaffoldConfigUri": "A String", # Optional. Cloud Storage URI of tar.gz archive containing Skaffold configuration.
"skaffoldVersion": "A String", # Optional. The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.
"targetArtifacts": { # Output only. Map from target ID to the target artifacts created during the render operation.
"a_key": { # The artifacts produced by a target render operation.
"artifactUri": "A String", # Output only. URI of a directory containing the artifacts. This contains deployment configuration used by Skaffold during a rollout, and all paths are relative to this location.
"manifestPath": "A String", # Output only. File path of the rendered manifest relative to the URI for the stable phase.
"phaseArtifacts": { # Output only. Map from the phase ID to the phase artifacts for the `Target`.
"a_key": { # Contains the paths to the artifacts, relative to the URI, for a phase.
"jobManifestsPath": "A String", # Output only. File path of the directory of rendered job manifests relative to the URI. This is only set if it is applicable.
"manifestPath": "A String", # Output only. File path of the rendered manifest relative to the URI.
"skaffoldConfigPath": "A String", # Output only. File path of the resolved Skaffold configuration relative to the URI.
},
},
"skaffoldConfigPath": "A String", # Output only. File path of the resolved Skaffold configuration for the stable phase, relative to the URI.
},
},
"targetRenders": { # Output only. Map from target ID to details of the render operation for that target.
"a_key": { # Details of rendering for a single target.
"failureCause": "A String", # Output only. Reason this render failed. This will always be unspecified while the render in progress.
"failureMessage": "A String", # Output only. Additional information about the render failure, if available.
"metadata": { # RenderMetadata includes information associated with a `Release` render. # Output only. Metadata related to the `Release` render for this Target.
"cloudRun": { # CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render. # Output only. Metadata associated with rendering for Cloud Run.
"service": "A String", # Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}`.
},
"custom": { # CustomMetadata contains information from a user-defined operation. # Output only. Custom metadata provided by user-defined render operation.
"values": { # Output only. Key-value pairs provided by the user-defined operation.
"a_key": "A String",
},
},
},
"renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.
"renderingState": "A String", # Output only. Current state of the render operation for this Target.
},
},
"targetSnapshots": [ # Output only. Snapshot of the targets taken at release creation time.
{ # A `Target` resource in the Cloud Deploy API. A `Target` defines a location to which a Skaffold configuration can be deployed.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"anthosCluster": { # Information specifying an Anthos Cluster. # Optional. Information specifying an Anthos Cluster.
"membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"associatedEntities": { # Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
"a_key": { # Information about entities associated with a `Target`.
"anthosClusters": [ # Optional. Information specifying Anthos clusters as associated entities.
{ # Information specifying an Anthos Cluster.
"membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
],
"gkeClusters": [ # Optional. Information specifying GKE clusters as associated entities.
{ # Information specifying a GKE Cluster.
"cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`.
"dnsEndpoint": True or False, # Optional. If set, the cluster will be accessed using the DNS endpoint. Note that both `dns_endpoint` and `internal_ip` cannot be set to true.
"internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). Note that `internal_ip` and `dns_endpoint` cannot both be set to true.
"proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server.
},
],
},
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
"customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
"customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
},
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
"description": "A String", # Optional. Description of the `Target`. Max length is 255 characters.
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"executionConfigs": [ # Optional. Configurations for all execution that relates to this `Target`. Each `ExecutionEnvironmentUsage` value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the `RENDER` and `DEPLOY` `ExecutionEnvironmentUsage` values. When no configurations are specified, execution will use the default specified in `DefaultPool`.
{ # Configuration of the environment to use when calling Skaffold.
"artifactStorage": "A String", # Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
"defaultPool": { # Execution using the default Cloud Build pool. # Optional. Use default Cloud Build pool.
"artifactStorage": "A String", # Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
"serviceAccount": "A String", # Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) will be used.
},
"executionTimeout": "A String", # Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.
"privatePool": { # Execution using a private Cloud Build pool. # Optional. Use private Cloud Build pool.
"artifactStorage": "A String", # Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
"serviceAccount": "A String", # Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) will be used.
"workerPool": "A String", # Required. Resource name of the Cloud Build worker pool to use. The format is `projects/{project}/locations/{location}/workerPools/{pool}`.
},
"serviceAccount": "A String", # Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) is used.
"usages": [ # Required. Usages when this configuration should be applied.
"A String",
],
"verbose": True or False, # Optional. If true, additional logging will be enabled when running builds in this execution environment.
"workerPool": "A String", # Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.
},
],
"gke": { # Information specifying a GKE Cluster. # Optional. Information specifying a GKE Cluster.
"cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`.
"dnsEndpoint": True or False, # Optional. If set, the cluster will be accessed using the DNS endpoint. Note that both `dns_endpoint` and `internal_ip` cannot be set to true.
"internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). Note that `internal_ip` and `dns_endpoint` cannot both be set to true.
"proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server.
},
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"multiTarget": { # Information specifying a multiTarget. # Optional. Information specifying a multiTarget.
"targetIds": [ # Required. The target_ids of this multiTarget.
"A String",
],
},
"name": "A String", # Identifier. Name of the `Target`. Format is `projects/{project}/locations/{location}/targets/{target}`. The `target` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"requireApproval": True or False, # Optional. Whether or not the `Target` requires approval.
"run": { # Information specifying where to deploy a Cloud Run Service. # Optional. Information specifying a Cloud Run deployment target.
"location": "A String", # Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`.
},
"targetId": "A String", # Output only. Resource id of the `Target`.
"uid": "A String", # Output only. Unique identifier of the `Target`.
"updateTime": "A String", # Output only. Most recent time at which the `Target` was updated.
},
],
"uid": "A String", # Output only. Unique identifier of the `Release`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Releases in a given project and location.
Args:
parent: string, Required. The `DeliveryPipeline` which owns this collection of `Release` objects. (required)
filter: string, Optional. Filter releases to be returned. See https://google.aip.dev/160 for more details.
orderBy: string, Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageSize: integer, Optional. The maximum number of `Release` objects to return. The service may return fewer than this value. If unspecified, at most 50 `Release` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
pageToken: string, Optional. A page token, received from a previous `ListReleases` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response object from `ListReleases`.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"releases": [ # The `Release` objects.
{ # A `Release` resource in the Cloud Deploy API. A `Release` defines a specific Skaffold configuration instance that can be deployed.
"abandoned": True or False, # Output only. Indicates whether this is an abandoned release.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"buildArtifacts": [ # Optional. List of artifacts to pass through to Skaffold command.
{ # Description of an a image to use during Skaffold rendering.
"image": "A String", # Optional. Image name in Skaffold configuration.
"tag": "A String", # Optional. Image tag to use. This will generally be the full path to an image, such as "gcr.io/my-project/busybox:1.2.3" or "gcr.io/my-project/busybox@sha256:abc123".
},
],
"condition": { # ReleaseCondition contains all conditions relevant to a Release. # Output only. Information around the state of the Release.
"releaseReadyCondition": { # ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release. # Details around the Releases's overall status.
"status": True or False, # True if the Release is in a valid state. Otherwise at least one condition in `ReleaseCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.
},
"skaffoldSupportedCondition": { # SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends. # Details around the support state of the release's Skaffold version.
"maintenanceModeTime": "A String", # The time at which this release's version of Skaffold will enter maintenance mode.
"skaffoldSupportState": "A String", # The Skaffold support state for this release's version of Skaffold.
"status": True or False, # True if the version of Skaffold used by this release is supported.
"supportExpirationTime": "A String", # The time at which this release's version of Skaffold will no longer be supported.
},
},
"createTime": "A String", # Output only. Time at which the `Release` was created.
"customTargetTypeSnapshots": [ # Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
{ # A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to other systems besides the supported runtimes.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"createTime": "A String", # Output only. Time at which the `CustomTargetType` was created.
"customActions": { # CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. # Optional. Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.
"deployAction": "A String", # Required. The Skaffold custom action responsible for deploy operations.
"includeSkaffoldModules": [ # Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.
{ # Skaffold Config modules and their remote source.
"configs": [ # Optional. The Skaffold Config modules to use from the specified source.
"A String",
],
"git": { # Git repository containing Skaffold Config modules. # Optional. Remote git repository containing the Skaffold Config modules.
"path": "A String", # Optional. Relative path from the repository root to the Skaffold file.
"ref": "A String", # Optional. Git branch or tag to use when cloning the repository.
"repo": "A String", # Required. Git repository the package should be cloned from.
},
"googleCloudBuildRepo": { # Cloud Build V2 Repository containing Skaffold Configs. # Optional. Cloud Build V2 repository containing the Skaffold Config modules.
"path": "A String", # Optional. Relative path from the repository root to the Skaffold Config file.
"ref": "A String", # Optional. Branch or tag to use when cloning the repository.
"repository": "A String", # Required. Name of the Cloud Build V2 Repository. Format is projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}.
},
"googleCloudStorage": { # Cloud Storage bucket containing Skaffold Config modules. # Optional. Cloud Storage bucket containing the Skaffold Config modules.
"path": "A String", # Optional. Relative path from the source to the Skaffold file.
"source": "A String", # Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".
},
},
],
"renderAction": "A String", # Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.
},
"customTargetTypeId": "A String", # Output only. Resource id of the `CustomTargetType`.
"description": "A String", # Optional. Description of the `CustomTargetType`. Max length is 255 characters.
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/{customTargetType}`. The `customTargetType` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"uid": "A String", # Output only. Unique identifier of the `CustomTargetType`.
"updateTime": "A String", # Output only. Most recent time at which the `CustomTargetType` was updated.
},
],
"deliveryPipelineSnapshot": { # A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. # Output only. Snapshot of the parent pipeline taken at release creation time.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.
"a_key": "A String",
},
"condition": { # PipelineCondition contains all conditions relevant to a Delivery Pipeline. # Output only. Information around the state of the Delivery Pipeline.
"pipelineReadyCondition": { # PipelineReadyCondition contains information around the status of the Pipeline. # Details around the Pipeline's overall status.
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.
"updateTime": "A String", # Last time the condition was updated.
},
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type.
"errorDetails": "A String", # Human readable error message.
"status": True or False, # True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters.
},
},
"createTime": "A String", # Output only. Time at which the pipeline was created.
"description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"serialPipeline": { # SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. # Optional. SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.
"stages": [ # Optional. Each stage specifies configuration for a `Target`. The ordering of this list defines the promotion flow.
{ # Stage specifies a location to which to deploy.
"deployParameters": [ # Optional. The deploy parameters to use for the target in this stage.
{ # DeployParameters contains deploy parameters information.
"matchTargetLabels": { # Optional. Deploy parameters are applied to targets with match labels. If unspecified, deploy parameters are applied to all targets (including child targets of a multi-target).
"a_key": "A String",
},
"values": { # Required. Values are deploy parameters in key-value pairs.
"a_key": "A String",
},
},
],
"profiles": [ # Optional. Skaffold profiles to use when rendering the manifest for this stage's `Target`.
"A String",
],
"strategy": { # Strategy contains deployment strategy information. # Optional. The strategy to use for a `Rollout` to this stage.
"canary": { # Canary represents the canary deployment strategy. # Optional. Canary deployment strategy provides progressive percentage based deployments to a Target.
"canaryDeployment": { # CanaryDeployment represents the canary deployment configuration # Optional. Configures the progressive based deployment for a Target.
"percentages": [ # Required. The percentage based deployments that will occur as a part of a `Rollout`. List is expected in ascending order and each integer n is 0 <= n < 100. If the GatewayServiceMesh is configured for Kubernetes, then the range for n is 0 <= n <= 100.
42,
],
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Optional. Whether to run verify tests after each percentage deployment via `skaffold verify`.
},
"customCanaryDeployment": { # CustomCanaryDeployment represents the custom canary deployment configuration. # Optional. Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.
"phaseConfigs": [ # Required. Configuration for each phase in the canary deployment in the order executed.
{ # PhaseConfig represents the configuration for a phase in the custom canary deployment.
"percentage": 42, # Required. Percentage deployment for the phase.
"phaseId": "A String", # Required. The ID to assign to the `Rollout` phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job of this phase. If this is not configured, there will be no predeploy job for this phase.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"profiles": [ # Optional. Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the `DeliveryPipeline` stage.
"A String",
],
"verify": True or False, # Optional. Whether to run verify tests after the deployment via `skaffold verify`.
},
],
},
"runtimeConfig": { # RuntimeConfig contains the runtime specific configurations for a deployment strategy. # Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
"cloudRun": { # CloudRunConfig contains the Cloud Run runtime configuration. # Optional. Cloud Run runtime configuration.
"automaticTrafficControl": True or False, # Optional. Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.
"canaryRevisionTags": [ # Optional. A list of tags that are added to the canary revision while the canary phase is in progress.
"A String",
],
"priorRevisionTags": [ # Optional. A list of tags that are added to the prior revision while the canary phase is in progress.
"A String",
],
"stableRevisionTags": [ # Optional. A list of tags that are added to the final stable revision when the stable phase is applied.
"A String",
],
},
"kubernetes": { # KubernetesConfig contains the Kubernetes runtime configuration. # Optional. Kubernetes runtime configuration.
"gatewayServiceMesh": { # Information about the Kubernetes Gateway API service mesh configuration. # Optional. Kubernetes Gateway API service mesh configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.
"httpRoute": "A String", # Required. Name of the Gateway API HTTPRoute.
"podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.
"routeDestinations": { # Information about route destinations for the Gateway API service mesh. # Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster.
"destinationIds": [ # Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and "@self" to include the Target cluster.
"A String",
],
"propagateService": True or False, # Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.
},
"routeUpdateWaitTime": "A String", # Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time.
"service": "A String", # Required. Name of the Kubernetes Service.
"stableCutbackDuration": "A String", # Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time.
},
"serviceNetworking": { # Information about the Kubernetes Service networking configuration. # Optional. Kubernetes Service networking configuration.
"deployment": "A String", # Required. Name of the Kubernetes Deployment whose traffic is managed by the specified Service.
"disablePodOverprovisioning": True or False, # Optional. Whether to disable Pod overprovisioning. If Pod overprovisioning is disabled then Cloud Deploy will limit the number of total Pods used for the deployment strategy to the number of Pods the Deployment has on the cluster.
"podSelectorLabel": "A String", # Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment.
"service": "A String", # Required. Name of the Kubernetes Service.
},
},
},
},
"standard": { # Standard represents the standard deployment strategy. # Optional. Standard deployment strategy executes a single deploy and allows verifying the deployment.
"postdeploy": { # Postdeploy contains the postdeploy job configuration information. # Optional. Configuration for the postdeploy job. If this is not configured, the postdeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.
"A String",
],
},
"predeploy": { # Predeploy contains the predeploy job configuration information. # Optional. Configuration for the predeploy job. If this is not configured, the predeploy job will not be present.
"actions": [ # Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.
"A String",
],
},
"verify": True or False, # Optional. Whether to verify a deployment via `skaffold verify`.
},
},
"targetId": "A String", # Optional. The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`.
},
],
},
"suspended": True or False, # Optional. When suspended, no new releases or rollouts can be created, but in-progress ones will complete.
"uid": "A String", # Output only. Unique identifier of the `DeliveryPipeline`.
"updateTime": "A String", # Output only. Most recent time at which the pipeline was updated.
},
"deployParameters": { # Optional. The deploy parameters to use for all targets in this release.
"a_key": "A String",
},
"description": "A String", # Optional. Description of the `Release`. Max length is 255 characters.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"renderEndTime": "A String", # Output only. Time at which the render completed.
"renderStartTime": "A String", # Output only. Time at which the render began.
"renderState": "A String", # Output only. Current state of the render operation.
"skaffoldConfigPath": "A String", # Optional. Filepath of the Skaffold config inside of the config URI.
"skaffoldConfigUri": "A String", # Optional. Cloud Storage URI of tar.gz archive containing Skaffold configuration.
"skaffoldVersion": "A String", # Optional. The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.
"targetArtifacts": { # Output only. Map from target ID to the target artifacts created during the render operation.
"a_key": { # The artifacts produced by a target render operation.
"artifactUri": "A String", # Output only. URI of a directory containing the artifacts. This contains deployment configuration used by Skaffold during a rollout, and all paths are relative to this location.
"manifestPath": "A String", # Output only. File path of the rendered manifest relative to the URI for the stable phase.
"phaseArtifacts": { # Output only. Map from the phase ID to the phase artifacts for the `Target`.
"a_key": { # Contains the paths to the artifacts, relative to the URI, for a phase.
"jobManifestsPath": "A String", # Output only. File path of the directory of rendered job manifests relative to the URI. This is only set if it is applicable.
"manifestPath": "A String", # Output only. File path of the rendered manifest relative to the URI.
"skaffoldConfigPath": "A String", # Output only. File path of the resolved Skaffold configuration relative to the URI.
},
},
"skaffoldConfigPath": "A String", # Output only. File path of the resolved Skaffold configuration for the stable phase, relative to the URI.
},
},
"targetRenders": { # Output only. Map from target ID to details of the render operation for that target.
"a_key": { # Details of rendering for a single target.
"failureCause": "A String", # Output only. Reason this render failed. This will always be unspecified while the render in progress.
"failureMessage": "A String", # Output only. Additional information about the render failure, if available.
"metadata": { # RenderMetadata includes information associated with a `Release` render. # Output only. Metadata related to the `Release` render for this Target.
"cloudRun": { # CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render. # Output only. Metadata associated with rendering for Cloud Run.
"service": "A String", # Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}`.
},
"custom": { # CustomMetadata contains information from a user-defined operation. # Output only. Custom metadata provided by user-defined render operation.
"values": { # Output only. Key-value pairs provided by the user-defined operation.
"a_key": "A String",
},
},
},
"renderingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.
"renderingState": "A String", # Output only. Current state of the render operation for this Target.
},
},
"targetSnapshots": [ # Output only. Snapshot of the targets taken at release creation time.
{ # A `Target` resource in the Cloud Deploy API. A `Target` defines a location to which a Skaffold configuration can be deployed.
"annotations": { # Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"anthosCluster": { # Information specifying an Anthos Cluster. # Optional. Information specifying an Anthos Cluster.
"membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
"associatedEntities": { # Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
"a_key": { # Information about entities associated with a `Target`.
"anthosClusters": [ # Optional. Information specifying Anthos clusters as associated entities.
{ # Information specifying an Anthos Cluster.
"membership": "A String", # Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.
},
],
"gkeClusters": [ # Optional. Information specifying GKE clusters as associated entities.
{ # Information specifying a GKE Cluster.
"cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`.
"dnsEndpoint": True or False, # Optional. If set, the cluster will be accessed using the DNS endpoint. Note that both `dns_endpoint` and `internal_ip` cannot be set to true.
"internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). Note that `internal_ip` and `dns_endpoint` cannot both be set to true.
"proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server.
},
],
},
},
"createTime": "A String", # Output only. Time at which the `Target` was created.
"customTarget": { # Information specifying a Custom Target. # Optional. Information specifying a Custom Target.
"customTargetType": "A String", # Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.
},
"deployParameters": { # Optional. The deploy parameters to use for this target.
"a_key": "A String",
},
"description": "A String", # Optional. Description of the `Target`. Max length is 255 characters.
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"executionConfigs": [ # Optional. Configurations for all execution that relates to this `Target`. Each `ExecutionEnvironmentUsage` value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the `RENDER` and `DEPLOY` `ExecutionEnvironmentUsage` values. When no configurations are specified, execution will use the default specified in `DefaultPool`.
{ # Configuration of the environment to use when calling Skaffold.
"artifactStorage": "A String", # Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
"defaultPool": { # Execution using the default Cloud Build pool. # Optional. Use default Cloud Build pool.
"artifactStorage": "A String", # Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
"serviceAccount": "A String", # Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) will be used.
},
"executionTimeout": "A String", # Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.
"privatePool": { # Execution using a private Cloud Build pool. # Optional. Use private Cloud Build pool.
"artifactStorage": "A String", # Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
"serviceAccount": "A String", # Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) will be used.
"workerPool": "A String", # Required. Resource name of the Cloud Build worker pool to use. The format is `projects/{project}/locations/{location}/workerPools/{pool}`.
},
"serviceAccount": "A String", # Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) is used.
"usages": [ # Required. Usages when this configuration should be applied.
"A String",
],
"verbose": True or False, # Optional. If true, additional logging will be enabled when running builds in this execution environment.
"workerPool": "A String", # Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.
},
],
"gke": { # Information specifying a GKE Cluster. # Optional. Information specifying a GKE Cluster.
"cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`.
"dnsEndpoint": True or False, # Optional. If set, the cluster will be accessed using the DNS endpoint. Note that both `dns_endpoint` and `internal_ip` cannot be set to true.
"internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). Note that `internal_ip` and `dns_endpoint` cannot both be set to true.
"proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server.
},
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
"a_key": "A String",
},
"multiTarget": { # Information specifying a multiTarget. # Optional. Information specifying a multiTarget.
"targetIds": [ # Required. The target_ids of this multiTarget.
"A String",
],
},
"name": "A String", # Identifier. Name of the `Target`. Format is `projects/{project}/locations/{location}/targets/{target}`. The `target` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"requireApproval": True or False, # Optional. Whether or not the `Target` requires approval.
"run": { # Information specifying where to deploy a Cloud Run Service. # Optional. Information specifying a Cloud Run deployment target.
"location": "A String", # Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`.
},
"targetId": "A String", # Output only. Resource id of the `Target`.
"uid": "A String", # Output only. Unique identifier of the `Target`.
"updateTime": "A String", # Output only. Most recent time at which the `Target` was updated.
},
],
"uid": "A String", # Output only. Unique identifier of the `Release`.
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|