• Home
• com.google.apis
• google-api-services-cloudresourcemanager
• v1-rev20200608-1.30.9
• source code
• CloudResourceManager.Organizations.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.cloudresourcemanager.CloudResourceManager.Organizations.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.cloudresourcemanager
Class CloudResourceManager.Organizations



java.lang.Object


com.google.api.services.cloudresourcemanager.CloudResourceManager.Organizations







Enclosing class:
CloudResourceManager




public class CloudResourceManager.Organizations
extends Object
The "organizations" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
CloudResourceManager.Organizations.ClearOrgPolicy 


class 
CloudResourceManager.Organizations.Get 


class 
CloudResourceManager.Organizations.GetEffectiveOrgPolicy 


class 
CloudResourceManager.Organizations.GetIamPolicy 


class 
CloudResourceManager.Organizations.GetOrgPolicy 


class 
CloudResourceManager.Organizations.ListAvailableOrgPolicyConstraints 


class 
CloudResourceManager.Organizations.ListOrgPolicies 


class 
CloudResourceManager.Organizations.Search 


class 
CloudResourceManager.Organizations.SetIamPolicy 


class 
CloudResourceManager.Organizations.SetOrgPolicy 


class 
CloudResourceManager.Organizations.TestIamPermissions 









Constructor Summary

Constructors 

Constructor and Description


Organizations() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CloudResourceManager.Organizations.ClearOrgPolicy
clearOrgPolicy(String resource,
              ClearOrgPolicyRequest content)
Clears a `Policy` from a resource.



CloudResourceManager.Organizations.Get
get(String name)
Fetches an Organization resource identified by the specified resource name.



CloudResourceManager.Organizations.GetEffectiveOrgPolicy
getEffectiveOrgPolicy(String resource,
                     GetEffectiveOrgPolicyRequest content)
Gets the effective `Policy` on a resource.



CloudResourceManager.Organizations.GetIamPolicy
getIamPolicy(String resource,
            GetIamPolicyRequest content)
Gets the access control policy for an Organization resource.



CloudResourceManager.Organizations.GetOrgPolicy
getOrgPolicy(String resource,
            GetOrgPolicyRequest content)
Gets a `Policy` on a resource.



CloudResourceManager.Organizations.ListAvailableOrgPolicyConstraints
listAvailableOrgPolicyConstraints(String resource,
                                 ListAvailableOrgPolicyConstraintsRequest content)
Lists `Constraints` that could be applied on the specified resource.



CloudResourceManager.Organizations.ListOrgPolicies
listOrgPolicies(String resource,
               ListOrgPoliciesRequest content)
Lists all the `Policies` set for a particular resource.



CloudResourceManager.Organizations.Search
search(SearchOrganizationsRequest content)
Searches Organization resources that are visible to the user and satisfy the specified filter.



CloudResourceManager.Organizations.SetIamPolicy
setIamPolicy(String resource,
            SetIamPolicyRequest content)
Sets the access control policy on an Organization resource.



CloudResourceManager.Organizations.SetOrgPolicy
setOrgPolicy(String resource,
            SetOrgPolicyRequest content)
Updates the specified `Policy` on the resource.



CloudResourceManager.Organizations.TestIamPermissions
testIamPermissions(String resource,
                  TestIamPermissionsRequest content)
Returns permissions that a caller has on the specified Organization.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Organizations
public Organizations()









Method Detail





clearOrgPolicy
public CloudResourceManager.Organizations.ClearOrgPolicy clearOrgPolicy(String resource,
                                                                        ClearOrgPolicyRequest content)
                                                                 throws IOException
Clears a `Policy` from a resource.

 Create a request for the method "organizations.clearOrgPolicy".

 This request holds the parameters needed by the cloudresourcemanager server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
resource - Name of the resource for the `Policy` to clear.
content - the ClearOrgPolicyRequest
Returns:
the request
Throws:
IOException








get
public CloudResourceManager.Organizations.Get get(String name)
                                           throws IOException
Fetches an Organization resource identified by the specified resource name.

 Create a request for the method "organizations.get".

 This request holds the parameters needed by the cloudresourcemanager server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - The resource name of the Organization to fetch. This is the organization's
    relative path in the API,
        formatted as "organizations/[organizationId]".
    For example, "organizations/1234".
Returns:
the request
Throws:
IOException








getEffectiveOrgPolicy
public CloudResourceManager.Organizations.GetEffectiveOrgPolicy getEffectiveOrgPolicy(String resource,
                                                                                      GetEffectiveOrgPolicyRequest content)
                                                                               throws IOException
Gets the effective `Policy` on a resource. This is the result of merging `Policies` in the
 resource hierarchy. The returned `Policy` will not have an `etag`set because it is a computed
 `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:'
 prefix will not be expanded.

 Create a request for the method "organizations.getEffectiveOrgPolicy".

 This request holds the parameters needed by the cloudresourcemanager server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
resource - The name of the resource to start computing the effective `Policy`.
content - the GetEffectiveOrgPolicyRequest
Returns:
the request
Throws:
IOException








getIamPolicy
public CloudResourceManager.Organizations.GetIamPolicy getIamPolicy(String resource,
                                                                    GetIamPolicyRequest content)
                                                             throws IOException
Gets the access control policy for an Organization resource. May be empty if no such policy or
 resource exists. The `resource` field should be the organization's resource name, e.g.
 "organizations/123".

 Authorization requires the Google IAM permission `resourcemanager.organizations.getIamPolicy` on
 the specified organization

 Create a request for the method "organizations.getIamPolicy".

 This request holds the parameters needed by the cloudresourcemanager 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 the operation documentation for
        the appropriate value for this field.
content - the GetIamPolicyRequest
Returns:
the request
Throws:
IOException








getOrgPolicy
public CloudResourceManager.Organizations.GetOrgPolicy getOrgPolicy(String resource,
                                                                    GetOrgPolicyRequest content)
                                                             throws IOException
Gets a `Policy` on a resource.

 If no `Policy` is set on the resource, a `Policy` is returned with default values including
 `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can be used with
 `SetOrgPolicy()` to create or update a `Policy` during read-modify-write.

 Create a request for the method "organizations.getOrgPolicy".

 This request holds the parameters needed by the cloudresourcemanager server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
resource - Name of the resource the `Policy` is set on.
content - the GetOrgPolicyRequest
Returns:
the request
Throws:
IOException








listAvailableOrgPolicyConstraints
public CloudResourceManager.Organizations.ListAvailableOrgPolicyConstraints listAvailableOrgPolicyConstraints(String resource,
                                                                                                              ListAvailableOrgPolicyConstraintsRequest content)
                                                                                                       throws IOException
Lists `Constraints` that could be applied on the specified resource.

 Create a request for the method "organizations.listAvailableOrgPolicyConstraints".

 This request holds the parameters needed by the cloudresourcemanager server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to
 invoke the remote operation.

Parameters:
resource - Name of the resource to list `Constraints` for.
content - the ListAvailableOrgPolicyConstraintsRequest
Returns:
the request
Throws:
IOException








listOrgPolicies
public CloudResourceManager.Organizations.ListOrgPolicies listOrgPolicies(String resource,
                                                                          ListOrgPoliciesRequest content)
                                                                   throws IOException
Lists all the `Policies` set for a particular resource.

 Create a request for the method "organizations.listOrgPolicies".

 This request holds the parameters needed by the cloudresourcemanager server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
resource - Name of the resource to list Policies for.
content - the ListOrgPoliciesRequest
Returns:
the request
Throws:
IOException








search
public CloudResourceManager.Organizations.Search search(SearchOrganizationsRequest content)
                                                 throws IOException
Searches Organization resources that are visible to the user and satisfy the specified filter.
 This method returns Organizations in an unspecified order. New Organizations do not necessarily
 appear at the end of the results.

 Search will only return organizations on which the user has the permission
 `resourcemanager.organizations.get`

 Create a request for the method "organizations.search".

 This request holds the parameters needed by the cloudresourcemanager server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
content - the SearchOrganizationsRequest
Returns:
the request
Throws:
IOException








setIamPolicy
public CloudResourceManager.Organizations.SetIamPolicy setIamPolicy(String resource,
                                                                    SetIamPolicyRequest content)
                                                             throws IOException
Sets the access control policy on an Organization resource. Replaces any existing policy. The
 `resource` field should be the organization's resource name, e.g. "organizations/123".

 Authorization requires the Google IAM permission `resourcemanager.organizations.setIamPolicy` on
 the specified organization

 Create a request for the method "organizations.setIamPolicy".

 This request holds the parameters needed by the cloudresourcemanager 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 the operation documentation for
        the appropriate value for this field.
content - the SetIamPolicyRequest
Returns:
the request
Throws:
IOException








setOrgPolicy
public CloudResourceManager.Organizations.SetOrgPolicy setOrgPolicy(String resource,
                                                                    SetOrgPolicyRequest content)
                                                             throws IOException
Updates the specified `Policy` on the resource. Creates a new `Policy` for that `Constraint` on
 the resource if one does not exist.

 Not supplying an `etag` on the request `Policy` results in an unconditional write of the
 `Policy`.

 Create a request for the method "organizations.setOrgPolicy".

 This request holds the parameters needed by the cloudresourcemanager server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
resource - Resource name of the resource to attach the `Policy`.
content - the SetOrgPolicyRequest
Returns:
the request
Throws:
IOException








testIamPermissions
public CloudResourceManager.Organizations.TestIamPermissions testIamPermissions(String resource,
                                                                                TestIamPermissionsRequest content)
                                                                         throws IOException
Returns permissions that a caller has on the specified Organization. The `resource` field should
 be the organization's resource name, e.g. "organizations/123".

 There are no permissions required for making this API call.

 Create a request for the method "organizations.testIamPermissions".

 This request holds the parameters needed by the cloudresourcemanager 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 the operation
        documentation for the appropriate value for this field.
content - the TestIamPermissionsRequest
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.