com.google.api.services.iam.v1

Class Iam.Locations.WorkforcePools

java.lang.Object

com.google.api.services.iam.v1.Iam.Locations.WorkforcePools

Enclosing class:

Iam.Locations

public class Iam.Locations.WorkforcePools
extends Object

The "workforcePools" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Iam.Locations.WorkforcePools.Create
class	Iam.Locations.WorkforcePools.Delete
class	Iam.Locations.WorkforcePools.Get
class	Iam.Locations.WorkforcePools.GetIamPolicy
class	Iam.Locations.WorkforcePools.List
class	Iam.Locations.WorkforcePools.Operations The "operations" collection of methods.
class	Iam.Locations.WorkforcePools.Patch
class	Iam.Locations.WorkforcePools.Providers The "providers" collection of methods.
class	Iam.Locations.WorkforcePools.SetIamPolicy
class	Iam.Locations.WorkforcePools.Subjects The "subjects" collection of methods.
class	Iam.Locations.WorkforcePools.TestIamPermissions
class	Iam.Locations.WorkforcePools.Undelete

Constructor Summary

Constructors

Constructor and Description
WorkforcePools()

Method Summary

Modifier and Type	Method and Description
Iam.Locations.WorkforcePools.Create	create(String location, WorkforcePool content) Creates a new WorkforcePool.
Iam.Locations.WorkforcePools.Delete	delete(String name) Deletes a WorkforcePool.
Iam.Locations.WorkforcePools.Get	get(String name) Gets an individual WorkforcePool.
Iam.Locations.WorkforcePools.GetIamPolicy	getIamPolicy(String resource, GetIamPolicyRequest content) Gets IAM policies on a WorkforcePool.
Iam.Locations.WorkforcePools.List	list(String location) Lists all non-deleted WorkforcePools under the specified parent.
Iam.Locations.WorkforcePools.Operations	operations() An accessor for creating requests from the Operations collection.
Iam.Locations.WorkforcePools.Patch	patch(String name, WorkforcePool content) Updates an existing WorkforcePool.
Iam.Locations.WorkforcePools.Providers	providers() An accessor for creating requests from the Providers collection.
Iam.Locations.WorkforcePools.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets IAM policies on a WorkforcePool.
Iam.Locations.WorkforcePools.Subjects	subjects() An accessor for creating requests from the Subjects collection.
Iam.Locations.WorkforcePools.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns the caller's permissions on the WorkforcePool.
Iam.Locations.WorkforcePools.Undelete	undelete(String name, UndeleteWorkforcePoolRequest content) Undeletes a WorkforcePool, as long as it was deleted fewer than 30 days ago.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkforcePools

public WorkforcePools()

Method Detail

create

public Iam.Locations.WorkforcePools.Create create(String location,
                                                  WorkforcePool content)
                                           throws IOException

Creates a new WorkforcePool. You cannot reuse the name of a deleted pool until 30 days after deletion. Create a request for the method "workforcePools.create". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the WorkforcePool

Returns:

the request

Throws:

IOException

delete

public Iam.Locations.WorkforcePools.Delete delete(String name)
                                           throws IOException

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. Create a request for the method "workforcePools.delete". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

get

public Iam.Locations.WorkforcePools.Get get(String name)
                                     throws IOException

Gets an individual WorkforcePool. Create a request for the method "workforcePools.get". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

getIamPolicy

public Iam.Locations.WorkforcePools.GetIamPolicy getIamPolicy(String resource,
                                                              GetIamPolicyRequest content)
                                                       throws IOException

Gets IAM policies on a WorkforcePool. Create a request for the method "workforcePools.getIamPolicy". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the GetIamPolicyRequest

Returns:

the request

Throws:

IOException

list

public Iam.Locations.WorkforcePools.List list(String location)
                                       throws IOException

Lists all non-deleted WorkforcePools under the specified parent. If `show_deleted` is set to `true`, then deleted pools are also listed. Create a request for the method "workforcePools.list". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

patch

public Iam.Locations.WorkforcePools.Patch patch(String name,
                                                WorkforcePool content)
                                         throws IOException

Updates an existing WorkforcePool. Create a request for the method "workforcePools.patch". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Output only. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`

content - the WorkforcePool

Returns:

the request

Throws:

IOException

setIamPolicy

public Iam.Locations.WorkforcePools.SetIamPolicy setIamPolicy(String resource,
                                                              SetIamPolicyRequest content)
                                                       throws IOException

Sets IAM policies on a WorkforcePool. Create a request for the method "workforcePools.setIamPolicy". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public Iam.Locations.WorkforcePools.TestIamPermissions testIamPermissions(String resource,
                                                                          TestIamPermissionsRequest content)
                                                                   throws IOException

Returns the caller's permissions on the WorkforcePool. If the pool does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Create a request for the method "workforcePools.testIamPermissions". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

undelete

public Iam.Locations.WorkforcePools.Undelete undelete(String name,
                                                      UndeleteWorkforcePoolRequest content)
                                               throws IOException

Undeletes a WorkforcePool, as long as it was deleted fewer than 30 days ago. Create a request for the method "workforcePools.undelete". This request holds the parameters needed by the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the UndeleteWorkforcePoolRequest

Returns:

the request

Throws:

IOException

operations

public Iam.Locations.WorkforcePools.Operations operations()

An accessor for creating requests from the Operations collection.

The typical use is:

    Iam iam = new Iam(...);
    Iam.Operations.List request = iam.operations().list(parameters ...)
 

Returns:

the resource collection

providers

public Iam.Locations.WorkforcePools.Providers providers()

An accessor for creating requests from the Providers collection.

The typical use is:

    Iam iam = new Iam(...);
    Iam.Providers.List request = iam.providers().list(parameters ...)
 

Returns:

the resource collection

subjects

public Iam.Locations.WorkforcePools.Subjects subjects()

An accessor for creating requests from the Subjects collection.

The typical use is:

    Iam iam = new Iam(...);
    Iam.Subjects.List request = iam.subjects().list(parameters ...)
 

Returns:

the resource collection