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

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

Creates a new EkmConnection in a given Project and Location.

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

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

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

Lists EkmConnections. (ekmConnections.listProjectsLocationsEkmConnections)

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

Updates an EkmConnection's metadata. (ekmConnections.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. (ekmConnections.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.

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.

Details

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

Creates a new EkmConnection in a given Project and Location.

(ekmConnections.create)

Parameters

string $parent

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

EkmConnection $postBody
array $optParams

Optional parameters.

Return Value

EkmConnection

Exceptions

Exception

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

Returns metadata for a given EkmConnection. (ekmConnections.get)

Parameters

string $name

Required. The name of the EkmConnection to get.

array $optParams

Optional parameters.

Return Value

EkmConnection

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

ListEkmConnectionsResponse listProjectsLocationsEkmConnections(string $parent, array $optParams = [])

Lists EkmConnections. (ekmConnections.listProjectsLocationsEkmConnections)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

ListEkmConnectionsResponse

Exceptions

Exception

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

Updates an EkmConnection's metadata. (ekmConnections.patch)

Parameters

string $name

Output only. The resource name for the EkmConnection in the format projects/locations/ekmConnections.

EkmConnection $postBody
array $optParams

Optional parameters.

Return Value

EkmConnection

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

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)

Parameters

string $name

Required. The name of the EkmConnection to verify.

array $optParams

Optional parameters.

Return Value

VerifyConnectivityResponse

Exceptions

Exception