Documentation

Google_Service_CloudKMS_Resource_ProjectsLocationsKeyRings extends Google_Service_Resource
in package

Application

The "keyRings" collection of methods.

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

$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_KeyRing: Create a new KeyRing in a given Project and Location. (keyRings.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_CloudKMS_KeyRing: Returns metadata for a given KeyRing. (keyRings.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. (keyRings.getIamPolicy)
listProjectsLocationsKeyRings() : Google_Service_CloudKMS_ListKeyRingsResponse: Lists KeyRings. (keyRings.listProjectsLocationsKeyRings)
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. (keyRings.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.
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 KeyRing in a given Project and Location. (keyRings.create)


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

Parameters

$parent : string: Required. The resource name of the location associated with the KeyRings, in the format projects/locations.
$postBody : Google_Service_CloudKMS_KeyRing
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_KeyRing —

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

get()

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


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

Parameters

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

Return values

Google_Service_CloudKMS_KeyRing —

getIamPolicy()

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)


    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 —

listProjectsLocationsKeyRings()

Lists KeyRings. (keyRings.listProjectsLocationsKeyRings)


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

Parameters

$parent : string: Required. The resource name of the location associated with the KeyRings, in the format projects/locations.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudKMS_ListKeyRingsResponse —

setIamPolicy()

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)


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

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —