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

ProjectsLocationsDeliveryPipelines

class ProjectsLocationsDeliveryPipelines extends Resource (View source)

The "deliveryPipelines" collection of methods.

Typical usage is:

 $clouddeployService = new Google\Service\CloudDeploy(...);
 $deliveryPipelines = $clouddeployService->projects_locations_deliveryPipelines;

Methods

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

Creates a new DeliveryPipeline in a given project and location.

Operation
delete(string $name, array $optParams = [])

Deletes a single DeliveryPipeline. (deliveryPipelines.delete)

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

Gets details of a single DeliveryPipeline. (deliveryPipelines.get)

Policy
getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

ListDeliveryPipelinesResponse
listProjectsLocationsDeliveryPipelines(string $parent, array $optParams = [])

Lists DeliveryPipelines in a given project and location.

Operation
patch(string $name, DeliveryPipeline $postBody, array $optParams = [])

Updates the parameters of a single DeliveryPipeline.

RollbackTargetResponse
rollbackTarget(string $name, RollbackTargetRequest $postBody, array $optParams = [])

Creates a Rollout to roll back the specified target.

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (deliveryPipelines.setIamPolicy)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

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

Creates a new DeliveryPipeline in a given project and location.

(deliveryPipelines.create)

Parameters

string $parent

Required. The parent collection in which the DeliveryPipeline must be created. The format is projects/{project_id}/locations/{location_name}.
DeliveryPipeline $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 106
Operation delete(string $name, array $optParams = [])

Deletes a single DeliveryPipeline. (deliveryPipelines.delete)

Parameters

string $name

Required. The name of the DeliveryPipeline to delete. The format is projects/{project_id}/locations/{location_name}/deliveryPipeli nes/{pipeline_name}.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 122
DeliveryPipeline get(string $name, array $optParams = [])

Gets details of a single DeliveryPipeline. (deliveryPipelines.get)

Parameters

string $name

Required. Name of the DeliveryPipeline. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_ name}.
array $optParams

Optional parameters.

Return Value

DeliveryPipeline

Exceptions

Exception

at line 154
Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

(deliveryPipelines.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 183
ListDeliveryPipelinesResponse listProjectsLocationsDeliveryPipelines(string $parent, array $optParams = [])

Lists DeliveryPipelines in a given project and location.

(deliveryPipelines.listProjectsLocationsDeliveryPipelines)

Parameters

string $parent

Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}.
array $optParams

Optional parameters.

Return Value

ListDeliveryPipelinesResponse

Exceptions

Exception

at line 224
Operation patch(string $name, DeliveryPipeline $postBody, array $optParams = [])

Updates the parameters of a single DeliveryPipeline.

(deliveryPipelines.patch)

Parameters

string $name

Optional. Name of the DeliveryPipeline. Format is proj ects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}. The deliveryPipeline component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?
DeliveryPipeline $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 242
RollbackTargetResponse rollbackTarget(string $name, RollbackTargetRequest $postBody, array $optParams = [])

Creates a Rollout to roll back the specified target.

(deliveryPipelines.rollbackTarget)

Parameters

string $name

Required. The DeliveryPipeline for which the rollback Rollout must be created. The format is projects/{project_id}/locations/{lo cation_name}/deliveryPipelines/{pipeline_name}.
RollbackTargetRequest $postBody
array $optParams

Optional parameters.

Return Value

RollbackTargetResponse

Exceptions

Exception

at line 262
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (deliveryPipelines.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 285
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (deliveryPipelines.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception