File: //snap/google-cloud-cli/396/lib/googlecloudsdk/api_lib/clouddeploy/job_run.py
# -*- coding: utf-8 -*- #
# Copyright 2023 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Support library to handle the job run subcommands."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.clouddeploy import client_util
class JobRunsClient(object):
"""Client for job run service in the Cloud Deploy API."""
def __init__(self, client=None, messages=None):
"""Initialize a job_run.JobRunsClient.
Args:
client: base_api.BaseApiClient, the client class for Cloud Deploy.
messages: module containing the definitions of messages for Cloud Deploy.
"""
self.client = client or client_util.GetClientInstance()
self.messages = messages or client_util.GetMessagesModule(client)
self._service = (
self.client.projects_locations_deliveryPipelines_releases_rollouts_jobRuns
)
def Terminate(
self,
name,
override_deploy_policies=None,
):
"""Terminates a job run.
Args:
name: Name of the JobRun. Format is
projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.
override_deploy_policies: List of Deploy Policies to override.
Returns:
TerminateJobRunResponse message.
"""
if override_deploy_policies is None:
override_deploy_policies = []
request = self.messages.ClouddeployProjectsLocationsDeliveryPipelinesReleasesRolloutsJobRunsTerminateRequest(
name=name,
terminateJobRunRequest=self.messages.TerminateJobRunRequest(
overrideDeployPolicy=override_deploy_policies,
),
)
return self._service.Terminate(request)