com.google.api.services.iam.v2beta

Class Iam.Policies

java.lang.Object

com.google.api.services.iam.v2beta.Iam.Policies

Enclosing class:

Iam

public class Iam.Policies
extends Object

The "policies" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Iam.Policies.CreatePolicy
class	Iam.Policies.Delete
class	Iam.Policies.Get
class	Iam.Policies.ListPolicies
class	Iam.Policies.Operations The "operations" collection of methods.
class	Iam.Policies.Update

Constructor Summary

Constructors

Constructor and Description
Policies()

Method Summary

Modifier and Type	Method and Description
Iam.Policies.CreatePolicy	createPolicy(String parent, GoogleIamV2betaPolicy content) Creates a policy.
Iam.Policies.Delete	delete(String name) Deletes a policy.
Iam.Policies.Get	get(String name) Gets a policy.
Iam.Policies.ListPolicies	listPolicies(String parent) Retrieves the policies of the specified kind that are attached to a resource.
Iam.Policies.Operations	operations() An accessor for creating requests from the Operations collection.
Iam.Policies.Update	update(String name, GoogleIamV2betaPolicy content) Updates the specified policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

Policies

public Policies()

Method Detail

createPolicy

public Iam.Policies.CreatePolicy createPolicy(String parent,
                                              GoogleIamV2betaPolicy content)
                                       throws IOException

Creates a policy. Create a request for the method "policies.createPolicy". 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 resource that the policy is attached to, along with the kind of policy to create. Format: `policies/{attachment_point}/denypolicies` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

content - the GoogleIamV2betaPolicy

Returns:

the request

Throws:

IOException

delete

public Iam.Policies.Delete delete(String name)
                           throws IOException

Deletes a policy. This action is permanent. Create a request for the method "policies.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 resource name of the policy to delete. Format: `policies/{attachment_point}/denypolicies/{policy_id}` Use the URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy- project/denypolicies/my-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

Returns:

the request

Throws:

IOException

get

public Iam.Policies.Get get(String name)
                     throws IOException

Gets a policy. Create a request for the method "policies.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 resource name of the policy to retrieve. Format: `policies/{attachment_point}/denypolicies/{policy_id}` Use the URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy- project/denypolicies/my-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

Returns:

the request

Throws:

IOException

listPolicies

public Iam.Policies.ListPolicies listPolicies(String parent)
                                       throws IOException

Retrieves the policies of the specified kind that are attached to a resource. The response lists only policy metadata. In particular, policy rules are omitted. Create a request for the method "policies.listPolicies". 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 resource that the policy is attached to, along with the kind of policy to list. Format: `policies/{attachment_point}/denypolicies` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

Returns:

the request

Throws:

IOException

update

public Iam.Policies.Update update(String name,
                                  GoogleIamV2betaPolicy content)
                           throws IOException

Updates the specified policy. You can update only the rules and the display name for the policy. To update a policy, you should use a read-modify-write loop: 1. Use GetPolicy to read the current version of the policy. 2. Modify the policy as needed. 3. Use `UpdatePolicy` to write the updated policy. This pattern helps prevent conflicts between concurrent updates. Create a request for the method "policies.update". 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 - Immutable. The resource name of the `Policy`, which must be unique. Format: `policies/{attachment_point}/denypolicies/{policy_id}` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my- deny-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.

content - the GoogleIamV2betaPolicy

Returns:

the request

Throws:

IOException

operations

public Iam.Policies.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