Cloud Deploy API (clouddeploy:v1)

Deletions

Methods


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

  HTTP Method: GET

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

  Parameter Order: parent

  Parameters:

  filter

  Location: query

  Type: string

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

  pageSize

  Format: int32

  Location: query

  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.

  Type: integer

  parent

  Required: Yes

  Type: string

  Location: path

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

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

  pageToken

  Location: query

  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.

  Type: string

  orderBy

  Location: query

  Type: string

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

  Path: v1/{+parent}/jobRuns

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

  Description: Lists JobRuns in a given project and location.

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

  Parameter Order: name

  HTTP Method: GET

  Path: v1/{+name}

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

  Description: Gets details of a single JobRun.

  Parameters:

  name

  Type: string

  Location: path

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

  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}.

  Required: Yes

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

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

  Parameter Order: rollout

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

  Description: Retries the specified Job in a Rollout.

  Parameters:

  rollout

  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/[^/]+$

  Type: string

  Required: Yes

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

  Path: v1/{+rollout}:retryJob

  HTTP Method: POST