1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudDeploy
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsDeliveryPipelinesAutomationRuns

ProjectsLocationsDeliveryPipelinesAutomationRuns

class ProjectsLocationsDeliveryPipelinesAutomationRuns extends Resource (View source)

The "automationRuns" collection of methods.

Typical usage is:

 $clouddeployService = new Google\Service\CloudDeploy(...);
 $automationRuns = $clouddeployService->projects_locations_deliveryPipelines_automationRuns;

Methods

CancelAutomationRunResponse
cancel(string $name, CancelAutomationRunRequest $postBody, array $optParams = [])

Cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error. (automationRuns.cancel)

AutomationRun
get(string $name, array $optParams = [])

Gets details of a single AutomationRun. (automationRuns.get)

ListAutomationRunsResponse
listProjectsLocationsDeliveryPipelinesAutomationRuns(string $parent, array $optParams = [])

Lists AutomationRuns in a given project and location.

Details

at line 49
CancelAutomationRunResponse cancel(string $name, CancelAutomationRunRequest $postBody, array $optParams = [])

Cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error. (automationRuns.cancel)

Parameters

string $name

Required. Name of the AutomationRun. Format is project s/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automa tionRuns/{automation_run}.
CancelAutomationRunRequest $postBody
array $optParams

Optional parameters.

Return Value

CancelAutomationRunResponse

Exceptions

Exception

at line 65
AutomationRun get(string $name, array $optParams = [])

Gets details of a single AutomationRun. (automationRuns.get)

Parameters

string $name

Required. Name of the AutomationRun. Format must be pr ojects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/a utomationRuns/{automation_run}.
array $optParams

Optional parameters.

Return Value

AutomationRun

Exceptions

Exception

at line 94
ListAutomationRunsResponse listProjectsLocationsDeliveryPipelinesAutomationRuns(string $parent, array $optParams = [])

Lists AutomationRuns in a given project and location.

(automationRuns.listProjectsLocationsDeliveryPipelinesAutomationRuns)

Parameters

string $parent

Required. The parent Delivery Pipeline, which owns this collection of automationRuns. Format must be projects/{project}/locatio ns/{location}/deliveryPipelines/{delivery_pipeline}.
array $optParams

Optional parameters.

Return Value

ListAutomationRunsResponse

Exceptions

Exception