ProjectsLocationsEkmConnections
class ProjectsLocationsEkmConnections extends Resource (View source)
The "ekmConnections" collection of methods.
Typical usage is:
$cloudkmsService = new Google\Service\CloudKMS(...);
$ekmConnections = $cloudkmsService->projects_locations_ekmConnections;
Methods
Creates a new EkmConnection in a given Project and Location.
Returns metadata for a given EkmConnection. (ekmConnections.get)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (ekmConnections.getIamPolicy)
Lists EkmConnections. (ekmConnections.listProjectsLocationsEkmConnections)
Updates an EkmConnection's metadata. (ekmConnections.patch)
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and
PERMISSION_DENIED
errors. (ekmConnections.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.
Verifies that Cloud KMS can successfully connect to the external key manager specified by an EkmConnection. If there is an error connecting to the EKM, this method returns a FAILED_PRECONDITION status containing structured information as described at https://cloud.google.com/kms/docs/reference/ekm_errors.
Details
EkmConnection
create(string $parent, EkmConnection $postBody, array $optParams = [])
Creates a new EkmConnection in a given Project and Location.
(ekmConnections.create)
EkmConnection
get(string $name, array $optParams = [])
Returns metadata for a given EkmConnection. (ekmConnections.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. (ekmConnections.getIamPolicy)
ListEkmConnectionsResponse
listProjectsLocationsEkmConnections(string $parent, array $optParams = [])
Lists EkmConnections. (ekmConnections.listProjectsLocationsEkmConnections)
EkmConnection
patch(string $name, EkmConnection $postBody, array $optParams = [])
Updates an EkmConnection's metadata. (ekmConnections.patch)
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. (ekmConnections.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. (ekmConnections.testIamPermissions)
VerifyConnectivityResponse
verifyConnectivity(string $name, array $optParams = [])
Verifies that Cloud KMS can successfully connect to the external key manager specified by an EkmConnection. If there is an error connecting to the EKM, this method returns a FAILED_PRECONDITION status containing structured information as described at https://cloud.google.com/kms/docs/reference/ekm_errors.
(ekmConnections.verifyConnectivity)