ProjectsLocationsApisVersionsSpecs
class ProjectsLocationsApisVersionsSpecs extends Resource (View source)
The "specs" collection of methods.
Typical usage is:
$apigeeregistryService = new Google\Service\ApigeeRegistry(...);
$specs = $apigeeregistryService->projects_locations_apis_versions_specs;
Methods
Removes a specified spec, all revisions, and all child resources (e.g., artifacts). (specs.delete)
Deletes a revision of a spec. (specs.deleteRevision)
Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (specs.getIamPolicy)
Returns matching specs. (specs.listProjectsLocationsApisVersionsSpecs)
Lists all revisions of a spec. Revisions are returned in descending order of revision creation time. (specs.listRevisions)
Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID. (specs.rollback)
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and
PERMISSION_DENIED
errors. (specs.setIamPolicy)
Adds a tag to a specified revision of a spec. (specs.tagRevision)
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
ApiSpec
create(string $parent, ApiSpec $postBody, array $optParams = [])
Creates a specified spec. (specs.create)
ApigeeregistryEmpty
delete(string $name, array $optParams = [])
Removes a specified spec, all revisions, and all child resources (e.g., artifacts). (specs.delete)
ApiSpec
deleteRevision(string $name, array $optParams = [])
Deletes a revision of a spec. (specs.deleteRevision)
ApiSpec
get(string $name, array $optParams = [])
Returns a specified spec. (specs.get)
HttpBody
getContents(string $name, array $optParams = [])
Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).
(specs.getContents)
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. (specs.getIamPolicy)
ListApiSpecsResponse
listProjectsLocationsApisVersionsSpecs(string $parent, array $optParams = [])
Returns matching specs. (specs.listProjectsLocationsApisVersionsSpecs)
ListApiSpecRevisionsResponse
listRevisions(string $name, array $optParams = [])
Lists all revisions of a spec. Revisions are returned in descending order of revision creation time. (specs.listRevisions)
ApiSpec
patch(string $name, ApiSpec $postBody, array $optParams = [])
Used to modify a specified spec. (specs.patch)
ApiSpec
rollback(string $name, RollbackApiSpecRequest $postBody, array $optParams = [])
Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID. (specs.rollback)
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. (specs.setIamPolicy)
ApiSpec
tagRevision(string $name, TagApiSpecRevisionRequest $postBody, array $optParams = [])
Adds a tag to a specified revision of a spec. (specs.tagRevision)
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. (specs.testIamPermissions)