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

ProjectsLocationsDeliveryPipelinesReleasesRollouts

class ProjectsLocationsDeliveryPipelinesReleasesRollouts extends Resource (View source)

The "rollouts" collection of methods.

Typical usage is:

 $clouddeployService = new Google\Service\CloudDeploy(...);
 $rollouts = $clouddeployService->projects_locations_deliveryPipelines_releases_rollouts;

Methods

AdvanceRolloutResponse
advance(string $name, AdvanceRolloutRequest $postBody, array $optParams = [])

Advances a Rollout in a given project and location. (rollouts.advance)

ApproveRolloutResponse
approve(string $name, ApproveRolloutRequest $postBody, array $optParams = [])

Approves a Rollout. (rollouts.approve)

CancelRolloutResponse
cancel(string $name, CancelRolloutRequest $postBody, array $optParams = [])

Cancels a Rollout in a given project and location. (rollouts.cancel)

Operation
create(string $parent, Rollout $postBody, array $optParams = [])

Creates a new Rollout in a given project and location. (rollouts.create)

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

Gets details of a single Rollout. (rollouts.get)

IgnoreJobResponse
ignoreJob(string $rollout, IgnoreJobRequest $postBody, array $optParams = [])

Ignores the specified Job in a Rollout. (rollouts.ignoreJob)

ListRolloutsResponse
listProjectsLocationsDeliveryPipelinesReleasesRollouts(string $parent, array $optParams = [])

Lists Rollouts in a given project and location.

RetryJobResponse
retryJob(string $rollout, RetryJobRequest $postBody, array $optParams = [])

Retries the specified Job in a Rollout. (rollouts.retryJob)

Details

at line 55
AdvanceRolloutResponse advance(string $name, AdvanceRolloutRequest $postBody, array $optParams = [])

Advances a Rollout in a given project and location. (rollouts.advance)

Parameters

string $name

Required. Name of the Rollout. Format is projects/{proje ct}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{relea se}/rollouts/{rollout}.
AdvanceRolloutRequest $postBody
array $optParams

Optional parameters.

Return Value

AdvanceRolloutResponse

Exceptions

Exception

at line 72
ApproveRolloutResponse approve(string $name, ApproveRolloutRequest $postBody, array $optParams = [])

Approves a Rollout. (rollouts.approve)

Parameters

string $name

Required. Name of the Rollout. Format is projects/{proje ct}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{relea se}/rollouts/{rollout}.
ApproveRolloutRequest $postBody
array $optParams

Optional parameters.

Return Value

ApproveRolloutResponse

Exceptions

Exception

at line 89
CancelRolloutResponse cancel(string $name, CancelRolloutRequest $postBody, array $optParams = [])

Cancels a Rollout in a given project and location. (rollouts.cancel)

Parameters

string $name

Required. Name of the Rollout. Format is projects/{proje ct}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{relea se}/rollouts/{rollout}.
CancelRolloutRequest $postBody
array $optParams

Optional parameters.

Return Value

CancelRolloutResponse

Exceptions

Exception

at line 124
Operation create(string $parent, Rollout $postBody, array $optParams = [])

Creates a new Rollout in a given project and location. (rollouts.create)

Parameters

string $parent

Required. The parent collection in which the Rollout must be created. The format is projects/{project_id}/locations/{location_nam e}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
Rollout $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 140
Rollout get(string $name, array $optParams = [])

Gets details of a single Rollout. (rollouts.get)

Parameters

string $name

Required. Name of the Rollout. Format must be projects /{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/rel eases/{release_name}/rollouts/{rollout_name}.
array $optParams

Optional parameters.

Return Value

Rollout

Exceptions

Exception

at line 157
IgnoreJobResponse ignoreJob(string $rollout, IgnoreJobRequest $postBody, array $optParams = [])

Ignores the specified Job in a Rollout. (rollouts.ignoreJob)

Parameters

string $rollout

Required. Name of the Rollout. Format is projects/{pr oject}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{re lease}/rollouts/{rollout}.
IgnoreJobRequest $postBody
array $optParams

Optional parameters.

Return Value

IgnoreJobResponse

Exceptions

Exception

at line 186
ListRolloutsResponse listProjectsLocationsDeliveryPipelinesReleasesRollouts(string $parent, array $optParams = [])

Lists Rollouts in a given project and location.

(rollouts.listProjectsLocationsDeliveryPipelinesReleasesRollouts)

Parameters

string $parent

Required. The Release which owns this collection of Rollout objects.
array $optParams

Optional parameters.

Return Value

ListRolloutsResponse

Exceptions

Exception

at line 203
RetryJobResponse retryJob(string $rollout, RetryJobRequest $postBody, array $optParams = [])

Retries the specified Job in a Rollout. (rollouts.retryJob)

Parameters

string $rollout

Required. Name of the Rollout. Format is projects/{pr oject}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{re lease}/rollouts/{rollout}.
RetryJobRequest $postBody
array $optParams

Optional parameters.

Return Value

RetryJobResponse

Exceptions

Exception