1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CertificateAuthorityService
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsCaPoolsCertificateAuthorities

ProjectsLocationsCaPoolsCertificateAuthorities

class ProjectsLocationsCaPoolsCertificateAuthorities extends Resource (View source)

The "certificateAuthorities" collection of methods.

Typical usage is:

 $privatecaService = new Google\Service\CertificateAuthorityService(...);
 $certificateAuthorities = $privatecaService->projects_locations_caPools_certificateAuthorities;

Methods

Operation
activate(string $name, ActivateCertificateAuthorityRequest $postBody, array $optParams = [])

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. (certificateAuthorities.activate)

Operation
create(string $parent, CertificateAuthority $postBody, array $optParams = [])

Create a new CertificateAuthority in a given Project and Location.

Operation
delete(string $name, array $optParams = [])

Delete a CertificateAuthority. (certificateAuthorities.delete)

Operation
disable(string $name, DisableCertificateAuthorityRequest $postBody, array $optParams = [])

Disable a CertificateAuthority. (certificateAuthorities.disable)

Operation
enable(string $name, EnableCertificateAuthorityRequest $postBody, array $optParams = [])

Enable a CertificateAuthority. (certificateAuthorities.enable)

FetchCertificateAuthorityCsrResponse
fetch(string $name, array $optParams = [])

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.

CertificateAuthority
get(string $name, array $optParams = [])

Returns a CertificateAuthority. (certificateAuthorities.get)

ListCertificateAuthoritiesResponse
listProjectsLocationsCaPoolsCertificateAuthorities(string $parent, array $optParams = [])

Lists CertificateAuthorities.

Operation
patch(string $name, CertificateAuthority $postBody, array $optParams = [])

Update a CertificateAuthority. (certificateAuthorities.patch)

Operation
undelete(string $name, UndeleteCertificateAuthorityRequest $postBody, array $optParams = [])

Undelete a CertificateAuthority that has been deleted.

Details

at line 52
Operation activate(string $name, ActivateCertificateAuthorityRequest $postBody, array $optParams = [])

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. (certificateAuthorities.activate)

Parameters

string $name

Required. The resource name for this CertificateAuthority in the format projects/locations/caPools/certificateAuthorities.
ActivateCertificateAuthorityRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 83
Operation create(string $parent, CertificateAuthority $postBody, array $optParams = [])

Create a new CertificateAuthority in a given Project and Location.

(certificateAuthorities.create)

Parameters

string $parent

Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects/locations/caPools.
CertificateAuthority $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 121
Operation delete(string $name, array $optParams = [])

Delete a CertificateAuthority. (certificateAuthorities.delete)

Parameters

string $name

Required. The resource name for this CertificateAuthority in the format projects/locations/caPools/certificateAuthorities.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 137
Operation disable(string $name, DisableCertificateAuthorityRequest $postBody, array $optParams = [])

Disable a CertificateAuthority. (certificateAuthorities.disable)

Parameters

string $name

Required. The resource name for this CertificateAuthority in the format projects/locations/caPools/certificateAuthorities.
DisableCertificateAuthorityRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 153
Operation enable(string $name, EnableCertificateAuthorityRequest $postBody, array $optParams = [])

Enable a CertificateAuthority. (certificateAuthorities.enable)

Parameters

string $name

Required. The resource name for this CertificateAuthority in the format projects/locations/caPools/certificateAuthorities.
EnableCertificateAuthorityRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 173
FetchCertificateAuthorityCsrResponse fetch(string $name, array $optParams = [])

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.

(certificateAuthorities.fetch)

Parameters

string $name

Required. The resource name for this CertificateAuthority in the format projects/locations/caPools/certificateAuthorities.
array $optParams

Optional parameters.

Return Value

FetchCertificateAuthorityCsrResponse

Exceptions

Exception

at line 187
CertificateAuthority get(string $name, array $optParams = [])

Returns a CertificateAuthority. (certificateAuthorities.get)

Parameters

string $name

Required. The name of the CertificateAuthority to get.
array $optParams

Optional parameters.

Return Value

CertificateAuthority

Exceptions

Exception

at line 214
ListCertificateAuthoritiesResponse listProjectsLocationsCaPoolsCertificateAuthorities(string $parent, array $optParams = [])

Lists CertificateAuthorities.

(certificateAuthorities.listProjectsLocationsCaPoolsCertificateAuthorities)

Parameters

string $parent

Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects/locations/caPools.
array $optParams

Optional parameters.

Return Value

ListCertificateAuthoritiesResponse

Exceptions

Exception

at line 245
Operation patch(string $name, CertificateAuthority $postBody, array $optParams = [])

Update a CertificateAuthority. (certificateAuthorities.patch)

Parameters

string $name

Output only. The resource name for this CertificateAuthority in the format projects/locations/caPools/certificateAuthorities.
CertificateAuthority $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 262
Operation undelete(string $name, UndeleteCertificateAuthorityRequest $postBody, array $optParams = [])

Undelete a CertificateAuthority that has been deleted.

(certificateAuthorities.undelete)

Parameters

string $name

Required. The resource name for this CertificateAuthority in the format projects/locations/caPools/certificateAuthorities.
UndeleteCertificateAuthorityRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception