ProjectsLocationsKeyRings
class ProjectsLocationsKeyRings extends Resource (View source)
The "keyRings" collection of methods.
Typical usage is:
$cloudkmsService = new Google\Service\CloudKMS(...);
$keyRings = $cloudkmsService->projects_locations_keyRings;
Methods
Returns metadata for a given KeyRing. (keyRings.get)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (keyRings.getIamPolicy)
Lists KeyRings. (keyRings.listProjectsLocationsKeyRings)
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and
PERMISSION_DENIED
errors. (keyRings.setIamPolicy)
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
KeyRing
create(string $parent, KeyRing $postBody, array $optParams = [])
Create a new KeyRing in a given Project and Location. (keyRings.create)
KeyRing
get(string $name, array $optParams = [])
Returns metadata for a given KeyRing. (keyRings.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. (keyRings.getIamPolicy)
ListKeyRingsResponse
listProjectsLocationsKeyRings(string $parent, array $optParams = [])
Lists KeyRings. (keyRings.listProjectsLocationsKeyRings)
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. (keyRings.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.
This operation may "fail open" without warning. (keyRings.testIamPermissions)