Skip to content

prefect_gcp.models.cloud_run_v2

ExecutionV2

Bases: BaseModel

ExecutionV2 is a data model for an execution of a job that will be run on Cloud Run API v2.

Source code in prefect_gcp/models/cloud_run_v2.py 
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
class ExecutionV2(BaseModel):
    """
    ExecutionV2 is a data model for an execution of a job that will be run on
        Cloud Run API v2.
    """

    name: str
    uid: str
    generation: str
    labels: Dict[str, str]
    annotations: Dict[str, str]
    createTime: str
    startTime: Optional[str]
    completionTime: Optional[str]
    deleteTime: Optional[str]
    expireTime: Optional[str]
    launchStage: Literal[
        "ALPHA",
        "BETA",
        "GA",
        "DEPRECATED",
        "EARLY_ACCESS",
        "PRELAUNCH",
        "UNIMPLEMENTED",
        "LAUNCH_TAGE_UNSPECIFIED",
    ]
    job: str
    parallelism: int
    taskCount: int
    template: Dict
    reconciling: bool
    conditions: List[Dict]
    observedGeneration: Optional[str]
    runningCount: Optional[int]
    succeededCount: Optional[int]
    failedCount: Optional[int]
    cancelledCount: Optional[int]
    retriedCount: Optional[int]
    logUri: str
    satisfiesPzs: bool
    etag: str

    def is_running(self) -> bool:
        """
        Return whether the execution is running.

        Returns:
            Whether the execution is running.
        """
        return self.completionTime is None

    def succeeded(self):
        """Whether or not the Execution completed is a successful state."""
        completed_condition = self.condition_after_completion()
        if (
            completed_condition
            and completed_condition["state"] == "CONDITION_SUCCEEDED"
        ):
            return True

        return False

    def condition_after_completion(self) -> Dict:
        """
        Return the condition after completion.

        Returns:
            The condition after completion.
        """
        if isinstance(self.conditions, List):
            for condition in self.conditions:
                if condition["type"] == "Completed":
                    return condition

    @classmethod
    def get(
        cls,
        cr_client: Resource,
        execution_id: str,
    ):
        """
        Get an execution from Cloud Run with the V2 API.

        Args:
            cr_client: The base client needed for interacting with GCP
                Cloud Run V2 API.
            execution_id: The name of the execution to get, in the form of
                projects/{project}/locations/{location}/jobs/{job}/executions
                    /{execution}
        """
        # noinspection PyUnresolvedReferences
        request = cr_client.jobs().executions().get(name=execution_id)

        response = request.execute()

        return cls(
            name=response["name"],
            uid=response["uid"],
            generation=response["generation"],
            labels=response.get("labels", {}),
            annotations=response.get("annotations", {}),
            createTime=response["createTime"],
            startTime=response.get("startTime"),
            completionTime=response.get("completionTime"),
            deleteTime=response.get("deleteTime"),
            expireTime=response.get("expireTime"),
            launchStage=response.get("launchStage", "GA"),
            job=response["job"],
            parallelism=response["parallelism"],
            taskCount=response["taskCount"],
            template=response["template"],
            reconciling=response.get("reconciling", False),
            conditions=response.get("conditions", []),
            observedGeneration=response.get("observedGeneration"),
            runningCount=response.get("runningCount"),
            succeededCount=response.get("succeededCount"),
            failedCount=response.get("failedCount"),
            cancelledCount=response.get("cancelledCount"),
            retriedCount=response.get("retriedCount"),
            logUri=response["logUri"],
            satisfiesPzs=response.get("satisfiesPzs", False),
            etag=response["etag"],
        )

condition_after_completion()

Return the condition after completion.

Returns:

Type Description
Dict

The condition after completion.
Source code in prefect_gcp/models/cloud_run_v2.py 
320
321
322
323
324
325
326
327
328
329
330
def condition_after_completion(self) -> Dict:
    """
    Return the condition after completion.

    Returns:
        The condition after completion.
    """
    if isinstance(self.conditions, List):
        for condition in self.conditions:
            if condition["type"] == "Completed":
                return condition

get(cr_client, execution_id) classmethod

Get an execution from Cloud Run with the V2 API.

Parameters:

Name Type Description Default
cr_client Resource

The base client needed for interacting with GCP Cloud Run V2 API.

 required
execution_id str

The name of the execution to get, in the form of projects/{project}/locations/{location}/jobs/{job}/executions /{execution}

 required
Source code in prefect_gcp/models/cloud_run_v2.py 
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
@classmethod
def get(
    cls,
    cr_client: Resource,
    execution_id: str,
):
    """
    Get an execution from Cloud Run with the V2 API.

    Args:
        cr_client: The base client needed for interacting with GCP
            Cloud Run V2 API.
        execution_id: The name of the execution to get, in the form of
            projects/{project}/locations/{location}/jobs/{job}/executions
                /{execution}
    """
    # noinspection PyUnresolvedReferences
    request = cr_client.jobs().executions().get(name=execution_id)

    response = request.execute()

    return cls(
        name=response["name"],
        uid=response["uid"],
        generation=response["generation"],
        labels=response.get("labels", {}),
        annotations=response.get("annotations", {}),
        createTime=response["createTime"],
        startTime=response.get("startTime"),
        completionTime=response.get("completionTime"),
        deleteTime=response.get("deleteTime"),
        expireTime=response.get("expireTime"),
        launchStage=response.get("launchStage", "GA"),
        job=response["job"],
        parallelism=response["parallelism"],
        taskCount=response["taskCount"],
        template=response["template"],
        reconciling=response.get("reconciling", False),
        conditions=response.get("conditions", []),
        observedGeneration=response.get("observedGeneration"),
        runningCount=response.get("runningCount"),
        succeededCount=response.get("succeededCount"),
        failedCount=response.get("failedCount"),
        cancelledCount=response.get("cancelledCount"),
        retriedCount=response.get("retriedCount"),
        logUri=response["logUri"],
        satisfiesPzs=response.get("satisfiesPzs", False),
        etag=response["etag"],
    )

is_running()

Return whether the execution is running.

Returns:

Type Description
bool

Whether the execution is running.
Source code in prefect_gcp/models/cloud_run_v2.py 
300
301
302
303
304
305
306
307
def is_running(self) -> bool:
    """
    Return whether the execution is running.

    Returns:
        Whether the execution is running.
    """
    return self.completionTime is None

succeeded()

Whether or not the Execution completed is a successful state.

Source code in prefect_gcp/models/cloud_run_v2.py 
309
310
311
312
313
314
315
316
317
318
def succeeded(self):
    """Whether or not the Execution completed is a successful state."""
    completed_condition = self.condition_after_completion()
    if (
        completed_condition
        and completed_condition["state"] == "CONDITION_SUCCEEDED"
    ):
        return True

    return False

JobV2

Bases: BaseModel

JobV2 is a data model for a job that will be run on Cloud Run with the V2 API.

Source code in prefect_gcp/models/cloud_run_v2.py 
  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
class JobV2(BaseModel):
    """
    JobV2 is a data model for a job that will be run on Cloud Run with the V2 API.
    """

    name: str
    uid: str
    generation: str
    labels: Dict[str, str] = Field(default_factory=dict)
    annotations: Dict[str, str] = Field(default_factory=dict)
    createTime: str
    updateTime: str
    deleteTime: Optional[str] = Field(None)
    expireTime: Optional[str] = Field(None)
    creator: Optional[str] = Field(None)
    lastModifier: Optional[str] = Field(None)
    client: Optional[str] = Field(None)
    clientVersion: Optional[str] = Field(None)
    launchStage: Literal[
        "ALPHA",
        "BETA",
        "GA",
        "DEPRECATED",
        "EARLY_ACCESS",
        "PRELAUNCH",
        "UNIMPLEMENTED",
        "LAUNCH_TAG_UNSPECIFIED",
    ]
    binaryAuthorization: Dict = Field(default_factory=dict)
    template: Dict = Field(default_factory=dict)
    observedGeneration: Optional[str] = Field(None)
    terminalCondition: Dict = Field(default_factory=dict)
    conditions: List[Dict] = Field(default_factory=list)
    executionCount: int
    latestCreatedExecution: Dict = Field(default_factory=dict)
    reconciling: bool = Field(False)
    satisfiesPzs: bool = Field(False)
    etag: Optional[str] = Field(None)

    def is_ready(self) -> bool:
        """
        Check if the job is ready to run.

        Returns:
            Whether the job is ready to run.
        """
        ready_condition = self.get_ready_condition()

        if self._is_missing_container(ready_condition=ready_condition):
            raise Exception(f"{ready_condition.get('message')}")

        return ready_condition.get("state") == "CONDITION_SUCCEEDED"

    def get_ready_condition(self) -> Dict:
        """
        Get the ready condition for the job.

        Returns:
            The ready condition for the job.
        """
        if self.terminalCondition.get("type") == "Ready":
            return self.terminalCondition

        return {}

    @classmethod
    def get(
        cls,
        cr_client: Resource,
        project: str,
        location: str,
        job_name: str,
    ):
        """
        Get a job from Cloud Run with the V2 API.

        Args:
            cr_client: The base client needed for interacting with GCP
                Cloud Run V2 API.
            project: The GCP project ID.
            location: The GCP region.
            job_name: The name of the job to get.
        """
        # noinspection PyUnresolvedReferences
        request = cr_client.jobs().get(
            name=f"projects/{project}/locations/{location}/jobs/{job_name}",
        )

        response = request.execute()

        return cls(
            name=response["name"],
            uid=response["uid"],
            generation=response["generation"],
            labels=response.get("labels", {}),
            annotations=response.get("annotations", {}),
            createTime=response["createTime"],
            updateTime=response["updateTime"],
            deleteTime=response.get("deleteTime"),
            expireTime=response.get("expireTime"),
            creator=response.get("creator"),
            lastModifier=response.get("lastModifier"),
            client=response.get("client"),
            clientVersion=response.get("clientVersion"),
            launchStage=response.get("launchStage", "GA"),
            binaryAuthorization=response.get("binaryAuthorization", {}),
            template=response.get("template"),
            observedGeneration=response.get("observedGeneration"),
            terminalCondition=response.get("terminalCondition", {}),
            conditions=response.get("conditions", []),
            executionCount=response.get("executionCount", 0),
            latestCreatedExecution=response["latestCreatedExecution"],
            reconciling=response.get("reconciling", False),
            satisfiesPzs=response.get("satisfiesPzs", False),
            etag=response["etag"],
        )

    @staticmethod
    def create(
        cr_client: Resource,
        project: str,
        location: str,
        job_id: str,
        body: Dict,
    ) -> Dict:
        """
        Create a job on Cloud Run with the V2 API.

        Args:
            cr_client: The base client needed for interacting with GCP
                Cloud Run V2 API.
            project: The GCP project ID.
            location: The GCP region.
            job_id: The ID of the job to create.
            body: The job body.

        Returns:
            The response from the Cloud Run V2 API.
        """
        # noinspection PyUnresolvedReferences
        request = cr_client.jobs().create(
            parent=f"projects/{project}/locations/{location}",
            jobId=job_id,
            body=body,
        )

        response = request.execute()

        return response

    @staticmethod
    def delete(
        cr_client: Resource,
        project: str,
        location: str,
        job_name: str,
    ) -> Dict:
        """
        Delete a job on Cloud Run with the V2 API.

        Args:
            cr_client (Resource): The base client needed for interacting with GCP
                Cloud Run V2 API.
            project: The GCP project ID.
            location: The GCP region.
            job_name: The name of the job to delete.

        Returns:
            Dict: The response from the Cloud Run V2 API.
        """
        # noinspection PyUnresolvedReferences
        list_executions_request = (
            cr_client.jobs()
            .executions()
            .list(
                parent=f"projects/{project}/locations/{location}/jobs/{job_name}",
            )
        )
        list_executions_response = list_executions_request.execute()

        for execution_to_delete in list_executions_response.get("executions", []):
            # noinspection PyUnresolvedReferences
            delete_execution_request = (
                cr_client.jobs()
                .executions()
                .delete(
                    name=execution_to_delete["name"],
                )
            )
            delete_execution_request.execute()

            # Sleep 3 seconds so that the execution is deleted before deleting the job
            time.sleep(3)

        # noinspection PyUnresolvedReferences
        request = cr_client.jobs().delete(
            name=f"projects/{project}/locations/{location}/jobs/{job_name}",
        )

        response = request.execute()

        return response

    @staticmethod
    def run(
        cr_client: Resource,
        project: str,
        location: str,
        job_name: str,
    ):
        """
        Run a job on Cloud Run with the V2 API.

        Args:
            cr_client: The base client needed for interacting with GCP
                Cloud Run V2 API.
            project: The GCP project ID.
            location: The GCP region.
            job_name: The name of the job to run.
        """
        # noinspection PyUnresolvedReferences
        request = cr_client.jobs().run(
            name=f"projects/{project}/locations/{location}/jobs/{job_name}",
        )

        response = request.execute()

        return response

    @staticmethod
    def _is_missing_container(ready_condition: Dict) -> bool:
        """
        Check if the job is missing a container.

        Args:
            ready_condition: The ready condition for the job.

        Returns:
            Whether the job is missing a container.
        """
        if (
            ready_condition.get("state") == "CONTAINER_FAILED"
            and ready_condition.get("reason") == "ContainerMissing"
        ):
            return True

        return False

create(cr_client, project, location, job_id, body) staticmethod

Create a job on Cloud Run with the V2 API.

Parameters:

Name Type Description Default
cr_client Resource

The base client needed for interacting with GCP Cloud Run V2 API.

 required
project str

The GCP project ID.

 required
location str

The GCP region.

 required
job_id str

The ID of the job to create.

 required
body Dict

The job body.

 required

Returns:

Type Description
Dict

The response from the Cloud Run V2 API.
Source code in prefect_gcp/models/cloud_run_v2.py 
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
@staticmethod
def create(
    cr_client: Resource,
    project: str,
    location: str,
    job_id: str,
    body: Dict,
) -> Dict:
    """
    Create a job on Cloud Run with the V2 API.

    Args:
        cr_client: The base client needed for interacting with GCP
            Cloud Run V2 API.
        project: The GCP project ID.
        location: The GCP region.
        job_id: The ID of the job to create.
        body: The job body.

    Returns:
        The response from the Cloud Run V2 API.
    """
    # noinspection PyUnresolvedReferences
    request = cr_client.jobs().create(
        parent=f"projects/{project}/locations/{location}",
        jobId=job_id,
        body=body,
    )

    response = request.execute()

    return response

delete(cr_client, project, location, job_name) staticmethod

Delete a job on Cloud Run with the V2 API.

Parameters:

Name Type Description Default
cr_client Resource

The base client needed for interacting with GCP Cloud Run V2 API.

 required
project str

The GCP project ID.

 required
location str

The GCP region.

 required
job_name str

The name of the job to delete.

 required

Returns:

Name Type Description
Dict Dict

The response from the Cloud Run V2 API.
Source code in prefect_gcp/models/cloud_run_v2.py 
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
@staticmethod
def delete(
    cr_client: Resource,
    project: str,
    location: str,
    job_name: str,
) -> Dict:
    """
    Delete a job on Cloud Run with the V2 API.

    Args:
        cr_client (Resource): The base client needed for interacting with GCP
            Cloud Run V2 API.
        project: The GCP project ID.
        location: The GCP region.
        job_name: The name of the job to delete.

    Returns:
        Dict: The response from the Cloud Run V2 API.
    """
    # noinspection PyUnresolvedReferences
    list_executions_request = (
        cr_client.jobs()
        .executions()
        .list(
            parent=f"projects/{project}/locations/{location}/jobs/{job_name}",
        )
    )
    list_executions_response = list_executions_request.execute()

    for execution_to_delete in list_executions_response.get("executions", []):
        # noinspection PyUnresolvedReferences
        delete_execution_request = (
            cr_client.jobs()
            .executions()
            .delete(
                name=execution_to_delete["name"],
            )
        )
        delete_execution_request.execute()

        # Sleep 3 seconds so that the execution is deleted before deleting the job
        time.sleep(3)

    # noinspection PyUnresolvedReferences
    request = cr_client.jobs().delete(
        name=f"projects/{project}/locations/{location}/jobs/{job_name}",
    )

    response = request.execute()

    return response

get(cr_client, project, location, job_name) classmethod

Get a job from Cloud Run with the V2 API.

Parameters:

Name Type Description Default
cr_client Resource

The base client needed for interacting with GCP Cloud Run V2 API.

 required
project str

The GCP project ID.

 required
location str

The GCP region.

 required
job_name str

The name of the job to get.

 required
Source code in prefect_gcp/models/cloud_run_v2.py 
 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
@classmethod
def get(
    cls,
    cr_client: Resource,
    project: str,
    location: str,
    job_name: str,
):
    """
    Get a job from Cloud Run with the V2 API.

    Args:
        cr_client: The base client needed for interacting with GCP
            Cloud Run V2 API.
        project: The GCP project ID.
        location: The GCP region.
        job_name: The name of the job to get.
    """
    # noinspection PyUnresolvedReferences
    request = cr_client.jobs().get(
        name=f"projects/{project}/locations/{location}/jobs/{job_name}",
    )

    response = request.execute()

    return cls(
        name=response["name"],
        uid=response["uid"],
        generation=response["generation"],
        labels=response.get("labels", {}),
        annotations=response.get("annotations", {}),
        createTime=response["createTime"],
        updateTime=response["updateTime"],
        deleteTime=response.get("deleteTime"),
        expireTime=response.get("expireTime"),
        creator=response.get("creator"),
        lastModifier=response.get("lastModifier"),
        client=response.get("client"),
        clientVersion=response.get("clientVersion"),
        launchStage=response.get("launchStage", "GA"),
        binaryAuthorization=response.get("binaryAuthorization", {}),
        template=response.get("template"),
        observedGeneration=response.get("observedGeneration"),
        terminalCondition=response.get("terminalCondition", {}),
        conditions=response.get("conditions", []),
        executionCount=response.get("executionCount", 0),
        latestCreatedExecution=response["latestCreatedExecution"],
        reconciling=response.get("reconciling", False),
        satisfiesPzs=response.get("satisfiesPzs", False),
        etag=response["etag"],
    )

get_ready_condition()

Get the ready condition for the job.

Returns:

Type Description
Dict

The ready condition for the job.
Source code in prefect_gcp/models/cloud_run_v2.py 
62
63
64
65
66
67
68
69
70
71
72
def get_ready_condition(self) -> Dict:
    """
    Get the ready condition for the job.

    Returns:
        The ready condition for the job.
    """
    if self.terminalCondition.get("type") == "Ready":
        return self.terminalCondition

    return {}

is_ready()

Check if the job is ready to run.

Returns:

Type Description
bool

Whether the job is ready to run.
Source code in prefect_gcp/models/cloud_run_v2.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
def is_ready(self) -> bool:
    """
    Check if the job is ready to run.

    Returns:
        Whether the job is ready to run.
    """
    ready_condition = self.get_ready_condition()

    if self._is_missing_container(ready_condition=ready_condition):
        raise Exception(f"{ready_condition.get('message')}")

    return ready_condition.get("state") == "CONDITION_SUCCEEDED"

run(cr_client, project, location, job_name) staticmethod

Run a job on Cloud Run with the V2 API.

Parameters:

Name Type Description Default
cr_client Resource

The base client needed for interacting with GCP Cloud Run V2 API.

 required
project str

The GCP project ID.

 required
location str

The GCP region.

 required
job_name str

The name of the job to run.

 required
Source code in prefect_gcp/models/cloud_run_v2.py 
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
@staticmethod
def run(
    cr_client: Resource,
    project: str,
    location: str,
    job_name: str,
):
    """
    Run a job on Cloud Run with the V2 API.

    Args:
        cr_client: The base client needed for interacting with GCP
            Cloud Run V2 API.
        project: The GCP project ID.
        location: The GCP region.
        job_name: The name of the job to run.
    """
    # noinspection PyUnresolvedReferences
    request = cr_client.jobs().run(
        name=f"projects/{project}/locations/{location}/jobs/{job_name}",
    )

    response = request.execute()

    return response