Cloud Deploy API (clouddeploy:v1)

2023-03-25

4 new methods

Additions

    Methods
  • clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.terminate

      Description: Terminates a Job Run in a given project and location.

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Description: Required. Name of the `JobRun`. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+/jobRuns/[^/]+$

          Type: string

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}/jobRuns/{jobRunsId}:terminate

      Path: v1/{+name}:terminate

      Parameter Order: name

  • clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.ignoreJob

      HTTP Method: POST

      Path: v1/{+rollout}:ignoreJob

      Parameter Order: rollout

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:ignoreJob

      Description: Ignores the specified Job in a Rollout.

      Parameters:

        rollout

          Location: path

          Description: Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.

          Required: Yes

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$

  • clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.advance

      Parameter Order: name

      Description: Advances a Rollout in a given project and location.

      Path: v1/{+name}:advance

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$

          Description: Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.

          Type: string

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:advance

  • clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.cancel

      HTTP Method: POST

      Parameters:

        name

          Type: string

          Required: Yes

          Description: Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$

      Parameter Order: name

      Description: Cancels a Rollout in a given project and location.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:cancel

      Path: v1/{+name}:cancel

      Scopes: https://www.googleapis.com/auth/cloud-platform