Show / Hide Table of Contents

Class LocationsResource.WorkforcePoolsResource

The "workforcePools" collection of methods.

Inheritance
object
LocationsResource.WorkforcePoolsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Iam.v1
Assembly: Google.Apis.Iam.v1.dll
Syntax
public class LocationsResource.WorkforcePoolsResource

Constructors

WorkforcePoolsResource(IClientService)

Constructs a new resource.

Declaration
public WorkforcePoolsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Operations

Gets the Operations resource.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.OperationsResource Operations { get; }
Property Value
Type Description
LocationsResource.WorkforcePoolsResource.OperationsResource

Providers

Gets the Providers resource.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.ProvidersResource Providers { get; }
Property Value
Type Description
LocationsResource.WorkforcePoolsResource.ProvidersResource

Subjects

Gets the Subjects resource.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.SubjectsResource Subjects { get; }
Property Value
Type Description
LocationsResource.WorkforcePoolsResource.SubjectsResource

Methods

Create(WorkforcePool, string)

Creates a new WorkforcePool. You cannot reuse the name of a deleted pool until 30 days after deletion.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.CreateRequest Create(WorkforcePool body, string location)
Parameters
Type Name Description
WorkforcePool body

The body of the request.

string location

Optional. The location of the pool to create. Format: locations/{location}.

Returns
Type Description
LocationsResource.WorkforcePoolsResource.CreateRequest

Delete(string)

Deletes a WorkforcePool. You cannot use a deleted WorkforcePool 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.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name of the pool to delete. Format: locations/{location}/workforcePools/{workforce_pool_id}

Returns
Type Description
LocationsResource.WorkforcePoolsResource.DeleteRequest

Get(string)

Gets an individual WorkforcePool.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the pool to retrieve. Format: locations/{location}/workforcePools/{workforce_pool_id}

Returns
Type Description
LocationsResource.WorkforcePoolsResource.GetRequest

GetIamPolicy(GetIamPolicyRequest, string)

Gets IAM policies on a WorkforcePool.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.GetIamPolicyRequest GetIamPolicy(GetIamPolicyRequest body, string resource)
Parameters
Type Name Description
GetIamPolicyRequest body

The body of the request.

string resource

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

Returns
Type Description
LocationsResource.WorkforcePoolsResource.GetIamPolicyRequest

List(string)

Lists all non-deleted WorkforcePools under the specified parent. If show_deleted is set to true, then deleted pools are also listed.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.ListRequest List(string location)
Parameters
Type Name Description
string location

The location of the pool. Format: locations/{location}.

Returns
Type Description
LocationsResource.WorkforcePoolsResource.ListRequest

Patch(WorkforcePool, string)

Updates an existing WorkforcePool.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.PatchRequest Patch(WorkforcePool body, string name)
Parameters
Type Name Description
WorkforcePool body

The body of the request.

string name

Identifier. The resource name of the pool. Format: locations/{location}/workforcePools/{workforce_pool_id}

Returns
Type Description
LocationsResource.WorkforcePoolsResource.PatchRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets IAM policies on a WorkforcePool.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
LocationsResource.WorkforcePoolsResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Returns the caller's permissions on the WorkforcePool. If the pool doesn't exist, this call returns an empty set of permissions. It doesn't return a NOT_FOUND error.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

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

Returns
Type Description
LocationsResource.WorkforcePoolsResource.TestIamPermissionsRequest

Undelete(UndeleteWorkforcePoolRequest, string)

Undeletes a WorkforcePool, as long as it was deleted fewer than 30 days ago.

Declaration
public virtual LocationsResource.WorkforcePoolsResource.UndeleteRequest Undelete(UndeleteWorkforcePoolRequest body, string name)
Parameters
Type Name Description
UndeleteWorkforcePoolRequest body

The body of the request.

string name

Required. The name of the pool to undelete. Format: locations/{location}/workforcePools/{workforce_pool_id}

Returns
Type Description
LocationsResource.WorkforcePoolsResource.UndeleteRequest
In this article
Back to top Generated by DocFX