StartEnvironmentReleaseRequest.md

StartEnvironmentReleaseRequest

Properties

Name	Type	Description	Notes
before_rule_id	str	Insert the newly created rule or phase rules before this rule. If omitted, append them to the end of the rule list.	[optional]
original_variation_id	UUID	ID of the variation the release starts from. The release gradually moves traffic from it to the target variation, and moves traffic back to it if the release reverts.
target_variation_id	UUID	ID of the variation being released. The release gradually moves traffic to it from the original variation, and moves traffic back to the original variation if the release reverts.
release_plan_key	str	Key of an environment release plan in this environment. The plan supplies `randomizationUnit`, `phases`, `metrics`, `advancementMode`, and `cleanupBehavior`, so omit them. Omit this field to configure the release inline.	[optional]
randomization_unit	str	Key of an existing, non-archived context kind in the project that the release randomizes on, such as `user`. Each phase's rule must include the clause `{&quot;contextKind&quot;: &quot;<unit>&quot;, &quot;attribute&quot;: &quot;kind&quot;, &quot;op&quot;: &quot;in&quot;, &quot;values&quot;: [&quot;<unit>&quot;]}`. Required unless `releasePlanKey` is set.	[optional]
advancement_mode	EnvironmentReleaseAdvancementMode	How the release moves between phases. Required when `phases` has more than one entry; a single-phase release ignores it and may omit it. Omit when `releasePlanKey` is set.	[optional]
phases	List[EnvironmentReleasePhaseInput]	Ordered phases of the release. Required unless `releasePlanKey` is set.	[optional]
metrics	List[EnvironmentReleaseMetricInput]	Metrics shared by every phase. Omit or pass an empty array for a progressive release. Metric groups cannot be listed inline; a release plan's metric groups expand into their member metrics at start. Omit when `releasePlanKey` is set.	[optional]
bypass_health_checks	List[ReleaseHealthCheckKind]	Health check kinds that do not block this request. LaunchDarkly still runs and enforces every health check kind not listed here.	[optional]
cleanup_behavior	CleanupBehavior	What happens to the release rules after the release completes. Omit for `leave_rules_in_place`. Omit when `releasePlanKey` is set.	[optional]
comment	str	Optional comment written to the flag's audit-log entry.	[optional]

Example

from launchdarkly_api.models.start_environment_release_request import StartEnvironmentReleaseRequest

# TODO update the JSON string below
json = "{}"
# create an instance of StartEnvironmentReleaseRequest from a JSON string
start_environment_release_request_instance = StartEnvironmentReleaseRequest.from_json(json)
# print the JSON string representation of the object
print(StartEnvironmentReleaseRequest.to_json())

# convert the object into a dict
start_environment_release_request_dict = start_environment_release_request_instance.to_dict()
# create an instance of StartEnvironmentReleaseRequest from a dict
start_environment_release_request_from_dict = StartEnvironmentReleaseRequest.from_dict(start_environment_release_request_dict)

[Back to Model list] [Back to API list] [Back to README]