Skip to content

deploymentEnvironments

DeploymentEnvironment

Bases: BitbucketCloudBase

Source code in server/vendor/atlassian/bitbucket/cloud/repositories/deploymentEnvironments.py
 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
class DeploymentEnvironment(BitbucketCloudBase):
    def __init__(self, url, data, *args, **kwargs):
        super(DeploymentEnvironment, self).__init__(
            url, *args, data=data, expected_type="deployment_environment", **kwargs
        )
        deployment_environment_url = self.get_deployment_environment_variable_url(self.url)
        self.__deployment_environment_variables = DeploymentEnvironmentVariables(
            "{}/variables".format(deployment_environment_url), **self._new_session_args
        )

    @property
    def uuid(self):
        """The deployment environment uuid"""
        return self.get_data("uuid")

    @property
    def category(self):
        """The deployment environment category"""
        return self.get_data("category")

    @property
    def deployment_gate_enabled(self):
        """The deployment environment deployment gate enabled"""
        return self.get_data("deployment_gate_enabled")

    @property
    def environment_lock_enabled(self):
        """The deployment environment environment lock enabled"""
        return self.get_data("environment_lock_enabled")

    @property
    def environment_type(self):
        """The deployment environment environment type"""
        return self.get_data("environment_type")

    @property
    def hidden(self):
        """The deployment environment hidden"""
        return self.get_data("hidden")

    @property
    def lock(self):
        """The deployment environment lock"""
        return self.get_data("lock")

    @property
    def name(self):
        """The deployment environment name"""
        return self.get_data("name")

    @property
    def rank(self):
        """The deployment environment rank"""
        return self.get_data("rank")

    @property
    def restrictions(self):
        """The deployment environment restrictions"""
        return self.get_data("restrictions")

    @property
    def slug(self):
        """The deployment environment slug"""
        return self.get_data("slug")

    @property
    def type(self):
        """The deployment environment type"""
        return self.get_data("type")

    @property
    def deployment_environment_variables(self):
        """The deployment environment variables"""
        return self.__deployment_environment_variables

    def get_deployment_environment_variable_url(self, url):
        parsed_url = urlsplit(url)
        path = parsed_url.path.split("/environments/")
        new_path = "{}/deployments_config/environments/{}".format(path[0], path[1])
        list_parsed_url = list(parsed_url[:])
        list_parsed_url[2] = new_path
        return urlunsplit(tuple(list_parsed_url))

category property

The deployment environment category

deployment_environment_variables property

The deployment environment variables

deployment_gate_enabled property

The deployment environment deployment gate enabled

environment_lock_enabled property

The deployment environment environment lock enabled

environment_type property

The deployment environment environment type

hidden property

The deployment environment hidden

lock property

The deployment environment lock

name property

The deployment environment name

rank property

The deployment environment rank

restrictions property

The deployment environment restrictions

slug property

The deployment environment slug

type property

The deployment environment type

uuid property

The deployment environment uuid

DeploymentEnvironmentVariable

Bases: BitbucketCloudBase

Source code in server/vendor/atlassian/bitbucket/cloud/repositories/deploymentEnvironments.py
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
class DeploymentEnvironmentVariable(BitbucketCloudBase):
    def __init__(self, url, data, *args, **kwargs):
        # This is needed when creating a new environment variable
        # since the API doesn't return a 'type'.
        if data.get("type") is None:
            data["type"] = "pipeline_variable"

        super(DeploymentEnvironmentVariable, self).__init__(
            url, *args, data=data, expected_type="pipeline_variable", **kwargs
        )

    def update(self, **kwargs):
        """
        Update the repository variable properties. Fields not present in the request body are ignored.

        :param kwargs: dict: The data to update.

        :return: The updated repository variable

        API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-variable-uuid-put
        """
        return self._update_data(self.put("/{}".format(self.uuid), data=kwargs))

    def delete(self):
        """
        Delete the repository variable.
        :return: The response on success
        API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-variable-uuid-delete
        """
        return super(DeploymentEnvironmentVariable, self).delete("/{}".format(self.uuid))

    @property
    def uuid(self):
        """The deployment environment variable uuid"""
        return self.get_data("uuid")

    @property
    def key(self):
        """The deployment environment variable key"""
        return self.get_data("key")

    @key.setter
    def key(self, key):
        """Setter for the deployment environment variable key"""
        return self.update(key=key)

    @property
    def secured(self):
        """The deployment environment variable is secured"""
        return self.get_data("secured")

    @property
    def type(self):
        """The deployment environment variable type"""
        return self.get_data("type")

    @property
    def value(self):
        """The deployment environment variable value"""
        return self.get_data("value")

    @value.setter
    def value(self, value):
        """Setter for the deployment environment variable value"""
        return self.update(value=value)

key property writable

The deployment environment variable key

secured property

The deployment environment variable is secured

type property

The deployment environment variable type

uuid property

The deployment environment variable uuid

value property writable

The deployment environment variable value

delete()

Delete the repository variable. :return: The response on success API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-variable-uuid-delete

Source code in server/vendor/atlassian/bitbucket/cloud/repositories/deploymentEnvironments.py
223
224
225
226
227
228
229
def delete(self):
    """
    Delete the repository variable.
    :return: The response on success
    API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-variable-uuid-delete
    """
    return super(DeploymentEnvironmentVariable, self).delete("/{}".format(self.uuid))

update(**kwargs)

Update the repository variable properties. Fields not present in the request body are ignored.

:param kwargs: dict: The data to update.

:return: The updated repository variable

API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-variable-uuid-put

Source code in server/vendor/atlassian/bitbucket/cloud/repositories/deploymentEnvironments.py
211
212
213
214
215
216
217
218
219
220
221
def update(self, **kwargs):
    """
    Update the repository variable properties. Fields not present in the request body are ignored.

    :param kwargs: dict: The data to update.

    :return: The updated repository variable

    API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-variable-uuid-put
    """
    return self._update_data(self.put("/{}".format(self.uuid), data=kwargs))

DeploymentEnvironmentVariables

Bases: BitbucketCloudBase

Source code in server/vendor/atlassian/bitbucket/cloud/repositories/deploymentEnvironments.py
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
class DeploymentEnvironmentVariables(BitbucketCloudBase):
    def __init__(self, url, *args, **kwargs):
        super(DeploymentEnvironmentVariables, self).__init__(url, *args, **kwargs)

    def __get_object(self, data):
        return DeploymentEnvironmentVariable(
            self.url,
            data,
            **self._new_session_args
        )  # fmt: skip

    def create(self, key, value, secured):
        """
        Create a new deployment environment variable for the given repository.

        :param key: string: The unique name of the variable.
        :param value: string: The value of the variable. If the variable is secured, this will be empty.
        :param secured: boolean: If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API.

        :return: The created DeploymentEnvironment object

        API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-post
        """
        data = {"key": key, "value": value, "secured": secured}
        return self.__get_object(self.post(None, data=data))

    def each(self, pagelen=10):
        """
        Returns the list of deployment environment variables in this repository.

        :param pagelen: integer: Query string to return this number of items from api.
                          See https://developer.atlassian.com/bitbucket/api/2/reference/meta/filtering for details.

        :return: A list of DeploymentEnvironmentVariable objects

        API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-get
        """
        params = {"pagelen": pagelen}

        response = super(BitbucketCloudBase, self).get(None, params=params)

        pagelen = response.get("pagelen")
        size_total = response.get("size")
        pagelen_total = response.get("pagelen")
        page = 1

        deployment_environment_variables = []

        # workaround for this issue
        # https://jira.atlassian.com/browse/BCLOUD-20796
        while True:
            for value in response.get("values", []):
                deployment_environment_variables.append(self.__get_object(value))

            if pagelen_total < size_total:
                pagelen_total = pagelen_total + response["pagelen"]
                page += 1
                response = super(BitbucketCloudBase, self).get(None, params={"pagelen": pagelen, "page": page})
            else:
                break

        return deployment_environment_variables

create(key, value, secured)

Create a new deployment environment variable for the given repository.

:param key: string: The unique name of the variable. :param value: string: The value of the variable. If the variable is secured, this will be empty. :param secured: boolean: If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API.

:return: The created DeploymentEnvironment object

API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-post

Source code in server/vendor/atlassian/bitbucket/cloud/repositories/deploymentEnvironments.py
147
148
149
150
151
152
153
154
155
156
157
158
159
160
def create(self, key, value, secured):
    """
    Create a new deployment environment variable for the given repository.

    :param key: string: The unique name of the variable.
    :param value: string: The value of the variable. If the variable is secured, this will be empty.
    :param secured: boolean: If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API.

    :return: The created DeploymentEnvironment object

    API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-post
    """
    data = {"key": key, "value": value, "secured": secured}
    return self.__get_object(self.post(None, data=data))

each(pagelen=10)

Returns the list of deployment environment variables in this repository.

:param pagelen: integer: Query string to return this number of items from api. See https://developer.atlassian.com/bitbucket/api/2/reference/meta/filtering for details.

:return: A list of DeploymentEnvironmentVariable objects

API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-get

Source code in server/vendor/atlassian/bitbucket/cloud/repositories/deploymentEnvironments.py
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
def each(self, pagelen=10):
    """
    Returns the list of deployment environment variables in this repository.

    :param pagelen: integer: Query string to return this number of items from api.
                      See https://developer.atlassian.com/bitbucket/api/2/reference/meta/filtering for details.

    :return: A list of DeploymentEnvironmentVariable objects

    API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/#api-repositories-workspace-repo-slug-deployments-config-environments-environment-uuid-variables-get
    """
    params = {"pagelen": pagelen}

    response = super(BitbucketCloudBase, self).get(None, params=params)

    pagelen = response.get("pagelen")
    size_total = response.get("size")
    pagelen_total = response.get("pagelen")
    page = 1

    deployment_environment_variables = []

    # workaround for this issue
    # https://jira.atlassian.com/browse/BCLOUD-20796
    while True:
        for value in response.get("values", []):
            deployment_environment_variables.append(self.__get_object(value))

        if pagelen_total < size_total:
            pagelen_total = pagelen_total + response["pagelen"]
            page += 1
            response = super(BitbucketCloudBase, self).get(None, params={"pagelen": pagelen, "page": page})
        else:
            break

    return deployment_environment_variables

DeploymentEnvironments

Bases: BitbucketCloudBase

Source code in server/vendor/atlassian/bitbucket/cloud/repositories/deploymentEnvironments.py
 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
class DeploymentEnvironments(BitbucketCloudBase):
    def __init__(self, url, *args, **kwargs):
        super(DeploymentEnvironments, self).__init__(url, *args, **kwargs)

    def __get_object(self, data):
        return DeploymentEnvironment(
            self.url_joiner(self.url, data["uuid"]),
            data,
            **self._new_session_args
        )  # fmt: skip

    def each(self):
        """
        Returns the list of environments in this repository.

        :return: A list of the DeploymentEnvironment objects

        API docs: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/environments/#get
        """

        # workaround for this issue
        # https://jira.atlassian.com/browse/BCLOUD-20796
        response = super(BitbucketCloudBase, self).get(None)

        deployment_environments = []

        for value in response.get("values", []):
            deployment_environments.append(self.__get_object(value))

        return deployment_environments

    def get(self, uuid):
        """
        Returns the environment with the uuid in this repository.

        :param uuid: string: The requested environment uuid

        :return: The requested DeploymentEnvironment objects

        API docs: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/environments/%7Benvironment_uuid%7D#get
        """
        return self.__get_object(super(DeploymentEnvironments, self).get(uuid))

each()

Returns the list of environments in this repository.

:return: A list of the DeploymentEnvironment objects

API docs: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/environments/#get

Source code in server/vendor/atlassian/bitbucket/cloud/repositories/deploymentEnvironments.py
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def each(self):
    """
    Returns the list of environments in this repository.

    :return: A list of the DeploymentEnvironment objects

    API docs: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/environments/#get
    """

    # workaround for this issue
    # https://jira.atlassian.com/browse/BCLOUD-20796
    response = super(BitbucketCloudBase, self).get(None)

    deployment_environments = []

    for value in response.get("values", []):
        deployment_environments.append(self.__get_object(value))

    return deployment_environments

get(uuid)

Returns the environment with the uuid in this repository.

:param uuid: string: The requested environment uuid

:return: The requested DeploymentEnvironment objects

API docs: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/environments/%7Benvironment_uuid%7D#get

Source code in server/vendor/atlassian/bitbucket/cloud/repositories/deploymentEnvironments.py
39
40
41
42
43
44
45
46
47
48
49
def get(self, uuid):
    """
    Returns the environment with the uuid in this repository.

    :param uuid: string: The requested environment uuid

    :return: The requested DeploymentEnvironment objects

    API docs: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/environments/%7Benvironment_uuid%7D#get
    """
    return self.__get_object(super(DeploymentEnvironments, self).get(uuid))