com.google.api.services.iam.v1

Class Iam.Locations.WorkforcePools.Providers

java.lang.Object

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

Enclosing class:

Iam.Locations.WorkforcePools

public class Iam.Locations.WorkforcePools.Providers
extends Object

The "providers" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Iam.Locations.WorkforcePools.Providers.Create
class	Iam.Locations.WorkforcePools.Providers.Delete
class	Iam.Locations.WorkforcePools.Providers.Get
class	Iam.Locations.WorkforcePools.Providers.Keys The "keys" collection of methods.
class	Iam.Locations.WorkforcePools.Providers.List
class	Iam.Locations.WorkforcePools.Providers.Operations The "operations" collection of methods.
class	Iam.Locations.WorkforcePools.Providers.Patch
class	Iam.Locations.WorkforcePools.Providers.Undelete

Constructor Summary

Constructors

Constructor and Description
Providers()

Method Summary

Modifier and Type	Method and Description
Iam.Locations.WorkforcePools.Providers.Create	create(String parent, WorkforcePoolProvider content) Creates a new WorkforcePoolProvider in a WorkforcePool.
Iam.Locations.WorkforcePools.Providers.Delete	delete(String name) Deletes a WorkforcePoolProvider.
Iam.Locations.WorkforcePools.Providers.Get	get(String name) Gets an individual WorkforcePoolProvider.
Iam.Locations.WorkforcePools.Providers.Keys	keys() An accessor for creating requests from the Keys collection.
Iam.Locations.WorkforcePools.Providers.List	list(String parent) Lists all non-deleted WorkforcePoolProviders in a WorkforcePool.
Iam.Locations.WorkforcePools.Providers.Operations	operations() An accessor for creating requests from the Operations collection.
Iam.Locations.WorkforcePools.Providers.Patch	patch(String name, WorkforcePoolProvider content) Updates an existing WorkforcePoolProvider.
Iam.Locations.WorkforcePools.Providers.Undelete	undelete(String name, UndeleteWorkforcePoolProviderRequest content) Undeletes a WorkforcePoolProvider, 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

Providers

public Providers()

Method Detail

create

public Iam.Locations.WorkforcePools.Providers.Create create(String parent,
                                                            WorkforcePoolProvider content)
                                                     throws IOException

Creates a new WorkforcePoolProvider in a WorkforcePool. You cannot reuse the name of a deleted provider until 30 days after deletion. Create a request for the method "providers.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:

parent - Required. The pool to create this provider in. Format: `locations/{location}/workforcePools/{workforce_pool_id}`

content - the WorkforcePoolProvider

Returns:

the request

Throws:

IOException

delete

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

Deletes a WorkforcePoolProvider. Deleting a provider does not revoke credentials that have already been\ issued; they continue to grant access. You can undelete a provider for 30 days. After 30 days, deletion is permanent. You cannot update deleted providers. However, you can view and list them. Create a request for the method "providers.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 provider to delete. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`

Returns:

the request

Throws:

IOException

get

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

Gets an individual WorkforcePoolProvider. Create a request for the method "providers.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 provider to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`

Returns:

the request

Throws:

IOException

list

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

Lists all non-deleted WorkforcePoolProviders in a WorkforcePool. If `show_deleted` is set to `true`, then deleted providers are also listed. Create a request for the method "providers.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:

parent - Required. The pool to list providers for. Format: `locations/{location}/workforcePools/{workforce_pool_id}`

Returns:

the request

Throws:

IOException

patch

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

Updates an existing WorkforcePoolProvider. Create a request for the method "providers.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 provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`

content - the WorkforcePoolProvider

Returns:

the request

Throws:

IOException

undelete

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

Undeletes a WorkforcePoolProvider, as long as it was deleted fewer than 30 days ago. Create a request for the method "providers.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 provider to undelete. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`

content - the UndeleteWorkforcePoolProviderRequest

Returns:

the request

Throws:

IOException

keys

public Iam.Locations.WorkforcePools.Providers.Keys keys()

An accessor for creating requests from the Keys collection.

The typical use is:

    Iam iam = new Iam(...);
    Iam.Keys.List request = iam.keys().list(parameters ...)
 

Returns:

the resource collection

operations

public Iam.Locations.WorkforcePools.Providers.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