class ProjectsLocationsApisVersions extends Resource (View source)

The "versions" collection of methods.

Typical usage is:

 $apigeeregistryService = new Google\Service\ApigeeRegistry(...);
 $versions = $apigeeregistryService->projects_locations_apis_versions;

Methods

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

Creates a specified version. (versions.create)

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

Removes a specified version and all of the resources that it owns.

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

Returns a specified version. (versions.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. (versions.getIamPolicy)

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

Returns matching versions. (versions.listProjectsLocationsApisVersions)

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

Used to modify a specified version. (versions.patch)

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

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

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

Creates a specified version. (versions.create)

Parameters

string $parent

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

ApiVersion $postBody
array $optParams

Optional parameters.

Return Value

ApiVersion

Exceptions

Exception

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

Removes a specified version and all of the resources that it owns.

(versions.delete)

Parameters

string $name

Required. The name of the version to delete. Format: projects/locations/apis/versions

array $optParams

Optional parameters.

Return Value

ApigeeregistryEmpty

Exceptions

Exception

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

Returns a specified version. (versions.get)

Parameters

string $name

Required. The name of the version to retrieve. Format: projects/locations/apis/versions

array $optParams

Optional parameters.

Return Value

ApiVersion

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

ListApiVersionsResponse listProjectsLocationsApisVersions(string $parent, array $optParams = [])

Returns matching versions. (versions.listProjectsLocationsApisVersions)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

ListApiVersionsResponse

Exceptions

Exception

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

Used to modify a specified version. (versions.patch)

Parameters

string $name

Resource name.

ApiVersion $postBody
array $optParams

Optional parameters.

Return Value

ApiVersion

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

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