Documentation

Google_Service_CloudKMS_Resource_ProjectsLocationsKeyRingsCryptoKeys extends Google_Service_Resource
in package

Application

The "cryptoKeys" collection of methods.

Typical usage is: $cloudkmsService = new Google_Service_CloudKMS(...); $cryptoKeys = $cloudkmsService->cryptoKeys;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_CloudKMS_CryptoKey: Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required. (cryptoKeys.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
decrypt() : Google_Service_CloudKMS_DecryptResponse: Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. (cryptoKeys.decrypt)
encrypt() : Google_Service_CloudKMS_EncryptResponse: Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. (cryptoKeys.encrypt)
get() : Google_Service_CloudKMS_CryptoKey: Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion. (cryptoKeys.get)
getIamPolicy() : Google_Service_CloudKMS_Policy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (cryptoKeys.getIamPolicy)
listProjectsLocationsKeyRingsCryptoKeys() : Google_Service_CloudKMS_ListCryptoKeysResponse: Lists CryptoKeys. (cryptoKeys.listProjectsLocationsKeyRingsCryptoKeys)
patch() : Google_Service_CloudKMS_CryptoKey: Update a CryptoKey. (cryptoKeys.patch)
setIamPolicy() : Google_Service_CloudKMS_Policy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (cryptoKeys.setIamPolicy)
testIamPermissions() : Google_Service_CloudKMS_TestIamPermissionsResponse: 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.
updatePrimaryVersion() : Google_Service_CloudKMS_CryptoKey: Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on an asymmetric key. (cryptoKeys.updatePrimaryVersion)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required. (cryptoKeys.create)


    public
                create(string $parent, Google_Service_CloudKMS_CryptoKey $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudKMS_CryptoKey

Parameters

$parent : string: Required. The name of the KeyRing associated with the CryptoKeys.
$postBody : Google_Service_CloudKMS_CryptoKey
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_CryptoKey —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

decrypt()

Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. (cryptoKeys.decrypt)


    public
                decrypt(string $name, Google_Service_CloudKMS_DecryptRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudKMS_DecryptResponse

Parameters

$name : string: Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.
$postBody : Google_Service_CloudKMS_DecryptRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_DecryptResponse —

encrypt()

Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. (cryptoKeys.encrypt)


    public
                encrypt(string $name, Google_Service_CloudKMS_EncryptRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudKMS_EncryptResponse

Parameters

$name : string: Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version.
$postBody : Google_Service_CloudKMS_EncryptRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_EncryptResponse —

get()

Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion. (cryptoKeys.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudKMS_CryptoKey

Parameters

$name : string: Required. The name of the CryptoKey to get.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_CryptoKey —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (cryptoKeys.getIamPolicy)


    public
                getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudKMS_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_Policy —

listProjectsLocationsKeyRingsCryptoKeys()

Lists CryptoKeys. (cryptoKeys.listProjectsLocationsKeyRingsCryptoKeys)


    public
                listProjectsLocationsKeyRingsCryptoKeys(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudKMS_ListCryptoKeysResponse

Parameters

$parent : string: Required. The resource name of the KeyRing to list, in the format projects/locations/keyRings.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_ListCryptoKeysResponse —

patch()

Update a CryptoKey. (cryptoKeys.patch)


    public
                patch(string $name, Google_Service_CloudKMS_CryptoKey $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudKMS_CryptoKey

Parameters

$name : string: Output only. The resource name for this CryptoKey in the format projects/locations/keyRings/cryptoKeys.
$postBody : Google_Service_CloudKMS_CryptoKey
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_CryptoKey —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (cryptoKeys.setIamPolicy)


    public
                setIamPolicy(string $resource, Google_Service_CloudKMS_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudKMS_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudKMS_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_Policy —

testIamPermissions()

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.


    public
                testIamPermissions(string $resource, Google_Service_CloudKMS_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudKMS_TestIamPermissionsResponse

This operation may "fail open" without warning. (cryptoKeys.testIamPermissions)

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudKMS_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_TestIamPermissionsResponse —

updatePrimaryVersion()

Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on an asymmetric key. (cryptoKeys.updatePrimaryVersion)


    public
                updatePrimaryVersion(string $name, Google_Service_CloudKMS_UpdateCryptoKeyPrimaryVersionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudKMS_CryptoKey

Parameters

$name : string: Required. The resource name of the CryptoKey to update.
$postBody : Google_Service_CloudKMS_UpdateCryptoKeyPrimaryVersionRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_CryptoKey —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —