Documentation

Google_Service_SecretManager_Resource_ProjectsSecretsVersions extends Google_Service_Resource
in package

The "versions" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
access()  : Google_Service_SecretManager_AccessSecretVersionResponse
Accesses a SecretVersion. This call returns the secret data.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
destroy()  : Google_Service_SecretManager_SecretVersion
Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data. (versions.destroy)
disable()  : Google_Service_SecretManager_SecretVersion
Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.
enable()  : Google_Service_SecretManager_SecretVersion
Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.
get()  : Google_Service_SecretManager_SecretVersion
Gets metadata for a SecretVersion. `projects/secrets/versions/latest` is an alias to the `latest` SecretVersion. (versions.get)
listProjectsSecretsVersions()  : Google_Service_SecretManager_ListSecretVersionsResponse
Lists SecretVersions. This call does not return secret data.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__construct()

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

access()

Accesses a SecretVersion. This call returns the secret data.

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

projects/secrets/versions/latest is an alias to the latest SecretVersion. (versions.access)

Parameters
$name : string

Required. The resource name of the SecretVersion in the format projects/secrets/versions.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_SecretManager_AccessSecretVersionResponse

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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

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>
Tags
static
Return values
string

$requestUrl

destroy()

Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data. (versions.destroy)

public destroy(string $name, Google_Service_SecretManager_DestroySecretVersionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecretManager_SecretVersion
Parameters
$name : string

Required. The resource name of the SecretVersion to destroy in the format projects/secrets/versions.

$postBody : Google_Service_SecretManager_DestroySecretVersionRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_SecretManager_SecretVersion

disable()

Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.

public disable(string $name, Google_Service_SecretManager_DisableSecretVersionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecretManager_SecretVersion

(versions.disable)

Parameters
$name : string

Required. The resource name of the SecretVersion to disable in the format projects/secrets/versions.

$postBody : Google_Service_SecretManager_DisableSecretVersionRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_SecretManager_SecretVersion

enable()

Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.

public enable(string $name, Google_Service_SecretManager_EnableSecretVersionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecretManager_SecretVersion

(versions.enable)

Parameters
$name : string

Required. The resource name of the SecretVersion to enable in the format projects/secrets/versions.

$postBody : Google_Service_SecretManager_EnableSecretVersionRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_SecretManager_SecretVersion

get()

Gets metadata for a SecretVersion. `projects/secrets/versions/latest` is an alias to the `latest` SecretVersion. (versions.get)

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

Required. The resource name of the SecretVersion in the format projects/secrets/versions. projects/secrets/versions/latest is an alias to the latest SecretVersion.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_SecretManager_SecretVersion

listProjectsSecretsVersions()

Lists SecretVersions. This call does not return secret data.

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

(versions.listProjectsSecretsVersions)

Parameters
$parent : string

Required. The resource name of the Secret associated with the SecretVersions to list, in the format projects/secrets.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][].

opt_param

int pageSize Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.

Return values
Google_Service_SecretManager_ListSecretVersionsResponse

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results