Cloud Deploy API (clouddeploy:v1)

2022-09-16

3 new methods

Additions

    Methods

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.retryJob

      Description : Retries the specified Job in a Rollout.

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

      HTTP Method : POST

      Parameters :

        rollout

          Location : path

          Type : string

          Required : Yes

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

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

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

      Parameter Order : rollout

      Path : v1/{+rollout}:retryJob

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.get

      Parameters :

        name

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

          Required : Yes

          Type : string

          Location : path

          Description : Required. Name of the `JobRun`. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}.

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

      Description : Gets details of a single JobRun.

      HTTP Method : GET

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

      Parameter Order : name

      Path : v1/{+name}

  • ▼ ▲ clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.list

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

      Description : Lists JobRuns in a given project and location.

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

      Path : v1/{+parent}/jobRuns

      Parameters :

        orderBy

          Description : Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

          Location : query

          Type : string

        parent

          Type : string

          Location : path

          Description : Required. The `Rollout` which owns this collection of `JobRun` objects.

          Required : Yes

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

        pageToken

          Description : Optional. A page token, received from a previous `ListJobRuns` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.

          Location : query

          Type : string

        filter

          Location : query

          Description : Optional. Filter results to be returned. See https://google.aip.dev/160 for more details.

          Type : string

        pageSize

          Description : Optional. The maximum number of `JobRun` objects to return. The service may return fewer than this value. If unspecified, at most 50 `JobRun` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

          Format : int32

          Location : query

          Type : integer

      HTTP Method : GET

      Parameter Order : parent