class ProjectsLocationsWorkloadIdentityPools extends Resource (View source)

The "workloadIdentityPools" collection of methods.

Typical usage is:

 $iamService = new Google\Service\Iam(...);
 $workloadIdentityPools = $iamService->projects_locations_workloadIdentityPools;

Methods

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

Creates a new WorkloadIdentityPool. You cannot reuse the name of a deleted pool until 30 days after deletion. (workloadIdentityPools.create)

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

Deletes a WorkloadIdentityPool. You cannot use a deleted pool to exchange external credentials for Google Cloud credentials. However, deletion does not revoke credentials that have already been issued. Credentials issued for a deleted pool do not grant access to resources. If the pool is undeleted, and the credentials are not expired, they grant access again. You can undelete a pool for 30 days. After 30 days, deletion is permanent. You cannot update deleted pools. However, you can view and list them.

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

Gets an individual WorkloadIdentityPool. (workloadIdentityPools.get)

listProjectsLocationsWorkloadIdentityPools(string $parent, array $optParams = [])

Lists all non-deleted WorkloadIdentityPools in a project. If show_deleted is set to true, then deleted pools are also listed.

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

Updates an existing WorkloadIdentityPool. (workloadIdentityPools.patch)

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

Undeletes a WorkloadIdentityPool, as long as it was deleted fewer than 30 days ago. (workloadIdentityPools.undelete)

Details

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

Creates a new WorkloadIdentityPool. You cannot reuse the name of a deleted pool until 30 days after deletion. (workloadIdentityPools.create)

Parameters

string $parent

Required. The parent resource to create the pool in. The only supported location is global.

WorkloadIdentityPool $postBody
array $optParams

Optional parameters.

Return Value

Operation

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

Deletes a WorkloadIdentityPool. You cannot use a deleted pool to exchange external credentials for Google Cloud credentials. However, deletion does not revoke credentials that have already been issued. Credentials issued for a deleted pool do not grant access to resources. If the pool is undeleted, and the credentials are not expired, they grant access again. You can undelete a pool for 30 days. After 30 days, deletion is permanent. You cannot update deleted pools. However, you can view and list them.

(workloadIdentityPools.delete)

Parameters

string $name

Required. The name of the pool to delete.

array $optParams

Optional parameters.

Return Value

Operation

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

Gets an individual WorkloadIdentityPool. (workloadIdentityPools.get)

Parameters

string $name

Required. The name of the pool to retrieve.

array $optParams

Optional parameters.

Return Value

WorkloadIdentityPool

ListWorkloadIdentityPoolsResponse listProjectsLocationsWorkloadIdentityPools(string $parent, array $optParams = [])

Lists all non-deleted WorkloadIdentityPools in a project. If show_deleted is set to true, then deleted pools are also listed.

(workloadIdentityPools.listProjectsLocationsWorkloadIdentityPools)

Parameters

string $parent

Required. The parent resource to list pools for.

array $optParams

Optional parameters.

Return Value

ListWorkloadIdentityPoolsResponse

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

Updates an existing WorkloadIdentityPool. (workloadIdentityPools.patch)

Parameters

string $name

Output only. The resource name of the pool.

WorkloadIdentityPool $postBody
array $optParams

Optional parameters.

Return Value

Operation

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

Undeletes a WorkloadIdentityPool, as long as it was deleted fewer than 30 days ago. (workloadIdentityPools.undelete)

Parameters

string $name

Required. The name of the pool to undelete.

UndeleteWorkloadIdentityPoolRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation