class ProjectsLocationsApisDeployments extends Resource (View source)

The "deployments" collection of methods.

Typical usage is:

 $apigeeregistryService = new Google\Service\ApigeeRegistry(...);
 $deployments = $apigeeregistryService->projects_locations_apis_deployments;

Methods

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

Creates a specified deployment. (deployments.create)

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

Removes a specified deployment, all revisions, and all child resources (e.g., artifacts). (deployments.delete)

deleteRevision(string $name, array $optParams = [])

Deletes a revision of a deployment. (deployments.deleteRevision)

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

Returns a specified deployment. (deployments.get)

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. (deployments.getIamPolicy)

listProjectsLocationsApisDeployments(string $parent, array $optParams = [])

Returns matching deployments.

listRevisions(string $name, array $optParams = [])

Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time. (deployments.listRevisions)

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

Used to modify a specified deployment. (deployments.patch)

rollback(string $name, RollbackApiDeploymentRequest $postBody, array $optParams = [])

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID. (deployments.rollback)

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. (deployments.setIamPolicy)

tagRevision(string $name, TagApiDeploymentRevisionRequest $postBody, array $optParams = [])

Adds a tag to a specified revision of a deployment. (deployments.tagRevision)

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

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

Creates a specified deployment. (deployments.create)

Parameters

string $parent

Required. The parent, which owns this collection of deployments. Format: projects/locations/apis

ApiDeployment $postBody
array $optParams

Optional parameters.

Return Value

ApiDeployment

Exceptions

Exception

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

Removes a specified deployment, all revisions, and all child resources (e.g., artifacts). (deployments.delete)

Parameters

string $name

Required. The name of the deployment to delete. Format: projects/locations/apis/deployments

array $optParams

Optional parameters.

Return Value

ApigeeregistryEmpty

Exceptions

Exception

ApiDeployment deleteRevision(string $name, array $optParams = [])

Deletes a revision of a deployment. (deployments.deleteRevision)

Parameters

string $name

Required. The name of the deployment revision to be deleted, with a revision ID explicitly included. Example: projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8

array $optParams

Optional parameters.

Return Value

ApiDeployment

Exceptions

Exception

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

Returns a specified deployment. (deployments.get)

Parameters

string $name

Required. The name of the deployment to retrieve. Format: projects/locations/apis/deployments

array $optParams

Optional parameters.

Return Value

ApiDeployment

Exceptions

Exception

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. (deployments.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

ListApiDeploymentsResponse listProjectsLocationsApisDeployments(string $parent, array $optParams = [])

Returns matching deployments.

(deployments.listProjectsLocationsApisDeployments)

Parameters

string $parent

Required. The parent, which owns this collection of deployments. Format: projects/locations/apis

array $optParams

Optional parameters.

Return Value

ListApiDeploymentsResponse

Exceptions

Exception

ListApiDeploymentRevisionsResponse listRevisions(string $name, array $optParams = [])

Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time. (deployments.listRevisions)

Parameters

string $name

Required. The name of the deployment to list revisions for.

array $optParams

Optional parameters.

Return Value

ListApiDeploymentRevisionsResponse

Exceptions

Exception

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

Used to modify a specified deployment. (deployments.patch)

Parameters

string $name

Resource name.

ApiDeployment $postBody
array $optParams

Optional parameters.

Return Value

ApiDeployment

Exceptions

Exception

ApiDeployment rollback(string $name, RollbackApiDeploymentRequest $postBody, array $optParams = [])

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID. (deployments.rollback)

Parameters

string $name

Required. The deployment being rolled back.

RollbackApiDeploymentRequest $postBody
array $optParams

Optional parameters.

Return Value

ApiDeployment

Exceptions

Exception

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. (deployments.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

ApiDeployment tagRevision(string $name, TagApiDeploymentRevisionRequest $postBody, array $optParams = [])

Adds a tag to a specified revision of a deployment. (deployments.tagRevision)

Parameters

string $name

Required. The name of the deployment to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision.

TagApiDeploymentRevisionRequest $postBody
array $optParams

Optional parameters.

Return Value

ApiDeployment

Exceptions

Exception

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. (deployments.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