Documentation

Google_Service_SecretManager_Resource_ProjectsSecrets extends Google_Service_Resource
in package

Application

The "secrets" collection of methods.

Typical usage is: $secretmanagerService = new Google_Service_SecretManager(...); $secrets = $secretmanagerService->secrets;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
addVersion() : Google_Service_SecretManager_SecretVersion: Creates a new SecretVersion containing secret data and attaches it to an existing Secret. (secrets.addVersion)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_SecretManager_Secret: Creates a new Secret containing no SecretVersions. (secrets.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_SecretManager_SecretmanagerEmpty: Deletes a Secret. (secrets.delete)
get() : Google_Service_SecretManager_Secret: Gets metadata for a given Secret. (secrets.get)
getIamPolicy() : Google_Service_SecretManager_Policy: Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set. (secrets.getIamPolicy)
listProjectsSecrets() : Google_Service_SecretManager_ListSecretsResponse: Lists Secrets. (secrets.listProjectsSecrets)
patch() : Google_Service_SecretManager_Secret: Updates metadata of an existing Secret. (secrets.patch)
setIamPolicy() : Google_Service_SecretManager_Policy: Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret. (secrets.setIamPolicy)
testIamPermissions() : Google_Service_SecretManager_TestIamPermissionsResponse: Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns 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 —

addVersion()

Creates a new SecretVersion containing secret data and attaches it to an existing Secret. (secrets.addVersion)


    public
                addVersion(string $parent, Google_Service_SecretManager_AddSecretVersionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecretManager_SecretVersion

Parameters

$parent : string: Required. The resource name of the Secret to associate with the SecretVersion in the format projects/secrets.
$postBody : Google_Service_SecretManager_AddSecretVersionRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecretManager_SecretVersion —

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()

Creates a new Secret containing no SecretVersions. (secrets.create)


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

Parameters

$parent : string: Required. The resource name of the project to associate with the Secret, in the format projects.
$postBody : Google_Service_SecretManager_Secret
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecretManager_Secret —

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

delete()

Deletes a Secret. (secrets.delete)


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

Parameters

$name : string: Required. The resource name of the Secret to delete in the format projects/secrets.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecretManager_SecretmanagerEmpty —

get()

Gets metadata for a given Secret. (secrets.get)


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

Parameters

$name : string: Required. The resource name of the Secret, in the format projects/secrets.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecretManager_Secret —

getIamPolicy()

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


    public
                getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecretManager_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_SecretManager_Policy —

listProjectsSecrets()

Lists Secrets. (secrets.listProjectsSecrets)


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

Parameters

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

Return values

Google_Service_SecretManager_ListSecretsResponse —

patch()

Updates metadata of an existing Secret. (secrets.patch)


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

Parameters

$name : string: Output only. The resource name of the Secret in the format projects/secrets.
$postBody : Google_Service_SecretManager_Secret
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecretManager_Secret —

setIamPolicy()

Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret. (secrets.setIamPolicy)


    public
                setIamPolicy(string $resource, Google_Service_SecretManager_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecretManager_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_SecretManager_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecretManager_Policy —

testIamPermissions()

Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns 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_SecretManager_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecretManager_TestIamPermissionsResponse

This operation may "fail open" without warning. (secrets.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_SecretManager_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecretManager_TestIamPermissionsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —