Google Certificate Authority Service V1 Client - Class CertificateAuthorityServiceClient (1.3.1)

Version 1.3.1

• 2.0.0 (latest)
• 2.0.0-RC1
• 1.7.3
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.2
• 1.1.0
• 1.0.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Certificate Authority Service V1 Client class CertificateAuthorityServiceClient.

Service Description: Certificate Authority Service manages private certificate authorities and issued certificates.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

activateCertificateAuthority

Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE.

After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::activateCertificateAuthorityAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ActivateCertificateAuthorityRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createCaPool

Create a CaPool.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::createCaPoolAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\CreateCaPoolRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createCertificate

Create a new Certificate in a given Project, Location from a particular CaPool.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::createCertificateAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\CreateCertificateRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1\Certificate

createCertificateAuthority

Create a new CertificateAuthority in a given Project and Location.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::createCertificateAuthorityAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\CreateCertificateAuthorityRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createCertificateTemplate

Create a new CertificateTemplate in a given Project and Location.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::createCertificateTemplateAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\CreateCertificateTemplateRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteCaPool

Delete a CaPool.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::deleteCaPoolAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\DeleteCaPoolRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteCertificateAuthority

Delete a CertificateAuthority.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::deleteCertificateAuthorityAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\DeleteCertificateAuthorityRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteCertificateTemplate

DeleteCertificateTemplate deletes a CertificateTemplate.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::deleteCertificateTemplateAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\DeleteCertificateTemplateRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

disableCertificateAuthority

Disable a CertificateAuthority.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::disableCertificateAuthorityAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\DisableCertificateAuthorityRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

enableCertificateAuthority

Enable a CertificateAuthority.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::enableCertificateAuthorityAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\EnableCertificateAuthorityRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

fetchCaCerts

FetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all ACTIVE CertificateAuthority resources in the CaPool.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::fetchCaCertsAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\FetchCaCertsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1\FetchCaCertsResponse

fetchCertificateAuthorityCsr

Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE.

The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::fetchCertificateAuthorityCsrAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\FetchCertificateAuthorityCsrRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1\FetchCertificateAuthorityCsrResponse

getCaPool

Returns a CaPool.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::getCaPoolAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\GetCaPoolRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1\CaPool

getCertificate

Returns a Certificate.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::getCertificateAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\GetCertificateRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1\Certificate

getCertificateAuthority

Returns a CertificateAuthority.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::getCertificateAuthorityAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\GetCertificateAuthorityRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1\CertificateAuthority

getCertificateRevocationList

Returns a CertificateRevocationList.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::getCertificateRevocationListAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\GetCertificateRevocationListRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1\CertificateRevocationList

getCertificateTemplate

Returns a CertificateTemplate.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::getCertificateTemplateAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\GetCertificateTemplateRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1\CertificateTemplate

listCaPools

Lists CaPools.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::listCaPoolsAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ListCaPoolsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listCertificateAuthorities

Lists CertificateAuthorities.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::listCertificateAuthoritiesAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ListCertificateAuthoritiesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listCertificateRevocationLists

Lists CertificateRevocationLists.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::listCertificateRevocationListsAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ListCertificateRevocationListsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listCertificateTemplates

Lists CertificateTemplates.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::listCertificateTemplatesAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ListCertificateTemplatesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listCertificates

Lists Certificates.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::listCertificatesAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ListCertificatesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

revokeCertificate

Revoke a Certificate.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::revokeCertificateAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\RevokeCertificateRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1\Certificate

undeleteCertificateAuthority

Undelete a CertificateAuthority that has been deleted.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::undeleteCertificateAuthorityAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UndeleteCertificateAuthorityRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateCaPool

Update a CaPool.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::updateCaPoolAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UpdateCaPoolRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateCertificate

Update a Certificate.

Currently, the only field you can update is the labels field.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::updateCertificateAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UpdateCertificateRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Security\PrivateCA\V1\Certificate

updateCertificateAuthority

Update a CertificateAuthority.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::updateCertificateAuthorityAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UpdateCertificateAuthorityRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateCertificateRevocationList

Update a CertificateRevocationList.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::updateCertificateRevocationListAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UpdateCertificateRevocationListRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateCertificateTemplate

Update a CertificateTemplate.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::updateCertificateTemplateAsync() .

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UpdateCertificateTemplateRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

getLocation

Gets information about a location.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::getLocationAsync() .

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Location\Location

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::listLocationsAsync() .

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

getIamPolicy

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

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::getIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\Policy

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::setIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\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. This operation may "fail open" without warning.

The async variant is Google\Cloud\Security\PrivateCA\V1\Client\BaseClient\self::testIamPermissionsAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\TestIamPermissionsResponse

activateCertificateAuthorityAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ActivateCertificateAuthorityRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createCaPoolAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\CreateCaPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createCertificateAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\CreateCertificateRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createCertificateAuthorityAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\CreateCertificateAuthorityRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createCertificateTemplateAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\CreateCertificateTemplateRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteCaPoolAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\DeleteCaPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteCertificateAuthorityAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\DeleteCertificateAuthorityRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteCertificateTemplateAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\DeleteCertificateTemplateRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

disableCertificateAuthorityAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\DisableCertificateAuthorityRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

enableCertificateAuthorityAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\EnableCertificateAuthorityRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

fetchCaCertsAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\FetchCaCertsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

fetchCertificateAuthorityCsrAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\FetchCertificateAuthorityCsrRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getCaPoolAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\GetCaPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getCertificateAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\GetCertificateRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getCertificateAuthorityAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\GetCertificateAuthorityRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getCertificateRevocationListAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\GetCertificateRevocationListRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getCertificateTemplateAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\GetCertificateTemplateRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listCaPoolsAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ListCaPoolsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listCertificateAuthoritiesAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ListCertificateAuthoritiesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listCertificateRevocationListsAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ListCertificateRevocationListsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listCertificateTemplatesAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ListCertificateTemplatesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listCertificatesAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\ListCertificatesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

revokeCertificateAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\RevokeCertificateRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

undeleteCertificateAuthorityAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UndeleteCertificateAuthorityRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateCaPoolAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UpdateCaPoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateCertificateAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UpdateCertificateRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateCertificateAuthorityAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UpdateCertificateAuthorityRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateCertificateRevocationListAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UpdateCertificateRevocationListRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateCertificateTemplateAsync

Parameters
Name	Description
request	Google\Cloud\Security\PrivateCA\V1\UpdateCertificateTemplateRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getLocationAsync

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listLocationsAsync

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
operationName	string The name of the long running operation
methodName	string The name of the method used to start the operation

Returns
Type	Description
Google\ApiCore\OperationResponse

static::caPoolName

Formats a string containing the fully-qualified path to represent a ca_pool resource.

Parameters
Name	Description
project	string
location	string
caPool	string

Returns
Type	Description
string	The formatted ca_pool resource.

static::certificateName

Formats a string containing the fully-qualified path to represent a certificate resource.

Parameters
Name	Description
project	string
location	string
caPool	string
certificate	string

Returns
Type	Description
string	The formatted certificate resource.

static::certificateAuthorityName

Formats a string containing the fully-qualified path to represent a certificate_authority resource.

Parameters
Name	Description
project	string
location	string
caPool	string
certificateAuthority	string

Returns
Type	Description
string	The formatted certificate_authority resource.

static::certificateRevocationListName

Formats a string containing the fully-qualified path to represent a certificate_revocation_list resource.

Parameters
Name	Description
project	string
location	string
caPool	string
certificateAuthority	string
certificateRevocationList	string

Returns
Type	Description
string	The formatted certificate_revocation_list resource.

static::certificateTemplateName

Formats a string containing the fully-qualified path to represent a certificate_template resource.

Parameters
Name	Description
project	string
location	string
certificateTemplate	string

Returns
Type	Description
string	The formatted certificate_template resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	The formatted location resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• caPool: projects/{project}/locations/{location}/caPools/{ca_pool}
• certificate: projects/{project}/locations/{location}/caPools/{ca_pool}/certificates/{certificate}
• certificateAuthority: projects/{project}/locations/{location}/caPools/{ca_pool}/certificateAuthorities/{certificate_authority}
• certificateRevocationList: projects/{project}/locations/{location}/caPools/{ca_pool}/certificateAuthorities/{certificate_authority}/certificateRevocationLists/{certificate_revocation_list}
• certificateTemplate: projects/{project}/locations/{location}/certificateTemplates/{certificate_template}
• location: projects/{project}/locations/{location}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.