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

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

Create a new KeyRing in a given Project and Location. (keyRings.create)

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

Returns metadata for a given KeyRing. (keyRings.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. (keyRings.getIamPolicy)

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

Lists KeyRings. (keyRings.listProjectsLocationsKeyRings)

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)

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

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

Create a new KeyRing in a given Project and Location. (keyRings.create)

Parameters

string $parent

Required. The resource name of the location associated with the KeyRings, in the format projects/locations.

KeyRing $postBody
array $optParams

Optional parameters.

Return Value

KeyRing

Exceptions

Exception

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

Returns metadata for a given KeyRing. (keyRings.get)

Parameters

string $name

Required. The name of the KeyRing to get.

array $optParams

Optional parameters.

Return Value

KeyRing

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

ListKeyRingsResponse listProjectsLocationsKeyRings(string $parent, array $optParams = [])

Lists KeyRings. (keyRings.listProjectsLocationsKeyRings)

Parameters

string $parent

Required. The resource name of the location associated with the KeyRings, in the format projects/locations.

array $optParams

Optional parameters.

Return Value

ListKeyRingsResponse

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