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

ProjectsLocationsCaPools

class ProjectsLocationsCaPools extends Resource (View source)

The "caPools" collection of methods.

Typical usage is:

 $privatecaService = new Google\Service\CertificateAuthorityService(...);
 $caPools = $privatecaService->projects_locations_caPools;

Methods

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

Create a CaPool. (caPools.create)

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

Delete a CaPool. (caPools.delete)

FetchCaCertsResponse
fetchCaCerts(string $caPool, FetchCaCertsRequest $postBody, array $optParams = [])

FetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all certificate authorities in the ENABLED, DISABLED, or STAGED states. (caPools.fetchCaCerts)

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

Returns a CaPool. (caPools.get)

Policy
getIamPolicy(string $resource, array $optParams = [])

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

ListCaPoolsResponse
listProjectsLocationsCaPools(string $parent, array $optParams = [])

Lists CaPools. (caPools.listProjectsLocationsCaPools)

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

Update a CaPool. (caPools.patch)

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (caPools.setIamPolicy)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

Details

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

Create a CaPool. (caPools.create)

Parameters

string $parent

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Delete a CaPool. (caPools.delete)

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 114
FetchCaCertsResponse fetchCaCerts(string $caPool, FetchCaCertsRequest $postBody, array $optParams = [])

FetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all certificate authorities in the ENABLED, DISABLED, or STAGED states. (caPools.fetchCaCerts)

Parameters

string $caPool

Required. The resource name for the CaPool in the format projects/locations/caPools.
FetchCaCertsRequest $postBody
array $optParams

Optional parameters.

Return Value

FetchCaCertsResponse

Exceptions

Exception

at line 128
CaPool get(string $name, array $optParams = [])

Returns a CaPool. (caPools.get)

Parameters

string $name

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

Optional parameters.

Return Value

CaPool

Exceptions

Exception

at line 159
Policy getIamPolicy(string $resource, array $optParams = [])

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

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 184
ListCaPoolsResponse listProjectsLocationsCaPools(string $parent, array $optParams = [])

Lists CaPools. (caPools.listProjectsLocationsCaPools)

Parameters

string $parent

Required. The resource name of the location associated with the CaPools, in the format projects/locations.
array $optParams

Optional parameters.

Return Value

ListCaPoolsResponse

Exceptions

Exception

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

Update a CaPool. (caPools.patch)

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 234
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (caPools.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 256
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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. (caPools.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception