com.google.api.services.cloudresourcemanager.v3

Class CloudResourceManager.Folders

java.lang.Object

com.google.api.services.cloudresourcemanager.v3.CloudResourceManager.Folders

Enclosing class:

CloudResourceManager

public class CloudResourceManager.Folders
extends Object

The "folders" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudResourceManager.Folders.Create
class	CloudResourceManager.Folders.Delete
class	CloudResourceManager.Folders.Get
class	CloudResourceManager.Folders.GetIamPolicy
class	CloudResourceManager.Folders.List
class	CloudResourceManager.Folders.Move
class	CloudResourceManager.Folders.Patch
class	CloudResourceManager.Folders.Search
class	CloudResourceManager.Folders.SetIamPolicy
class	CloudResourceManager.Folders.TestIamPermissions
class	CloudResourceManager.Folders.Undelete

Constructor Summary

Constructors

Constructor and Description
Folders()

Method Summary

Modifier and Type	Method and Description
CloudResourceManager.Folders.Create	create(Folder content) Creates a folder in the resource hierarchy.
CloudResourceManager.Folders.Delete	delete(String name) Requests deletion of a folder.
CloudResourceManager.Folders.Get	get(String name) Retrieves a folder identified by the supplied resource name.
CloudResourceManager.Folders.GetIamPolicy	getIamPolicy(String resource, GetIamPolicyRequest content) Gets the access control policy for a folder.
CloudResourceManager.Folders.List	list() Lists the folders that are direct descendants of supplied parent resource.
CloudResourceManager.Folders.Move	move(String name, MoveFolderRequest content) Moves a folder under a new resource parent.
CloudResourceManager.Folders.Patch	patch(String name, Folder content) Updates a folder, changing its `display_name`.
CloudResourceManager.Folders.Search	search() Search for folders that match specific filter criteria.
CloudResourceManager.Folders.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on a folder, replacing any existing policy.
CloudResourceManager.Folders.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified folder.
CloudResourceManager.Folders.Undelete	undelete(String name, UndeleteFolderRequest content) Cancels the deletion request for a folder.

Methods inherited from class java.lang.Object

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

Constructor Detail

Folders

public Folders()

Method Detail

create

public CloudResourceManager.Folders.Create create(Folder content)
                                           throws IOException

Creates a folder in the resource hierarchy. Returns an `Operation` which can be used to track the progress of the folder creation workflow. Upon success, the `Operation.response` field will be populated with the created Folder. In order to succeed, the addition of this new folder must not violate the folder naming, height, or fanout constraints. + The folder's `display_name` must be distinct from all other folders that share its parent. + The addition of the folder must not cause the active folder hierarchy to exceed a height of 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders. + The addition of the folder must not cause the total number of folders under its parent to exceed 300. If the operation fails due to a folder constraint violation, some errors may be returned by the `CreateFolder` request, with status code `FAILED_PRECONDITION` and an error description. Other folder constraint violations will be communicated in the `Operation`, with the specific `PreconditionFailure` returned in the details list in the `Operation.error` field. The caller must have `resourcemanager.folders.create` permission on the identified parent. Create a request for the method "folders.create". 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 Folder

Returns:

the request

Throws:

IOException

delete

public CloudResourceManager.Folders.Delete delete(String name)
                                           throws IOException

Requests deletion of a folder. The folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty folder, where a folder is empty if it doesn't contain any folders or projects in the ACTIVE state. If called on a folder in DELETE_REQUESTED state the operation will result in a no-op success. The caller must have `resourcemanager.folders.delete` permission on the identified folder. Create a request for the method "folders.delete". 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 - Required. The resource name of the folder to be deleted. Must be of the form `folders/{folder_id}`.

Returns:

the request

Throws:

IOException

get

public CloudResourceManager.Folders.Get get(String name)
                                     throws IOException

Retrieves a folder identified by the supplied resource name. Valid folder resource names have the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have `resourcemanager.folders.get` permission on the identified folder. Create a request for the method "folders.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 - Required. The resource name of the folder to retrieve. Must be of the form `folders/{folder_id}`.

Returns:

the request

Throws:

IOException

getIamPolicy

public CloudResourceManager.Folders.GetIamPolicy getIamPolicy(String resource,
                                                              GetIamPolicyRequest content)
                                                       throws IOException

Gets the access control policy for a folder. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the folder's resource name, for example: "folders/1234". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder. Create a request for the method "folders.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 [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 CloudResourceManager.Folders.List list()
                                       throws IOException

Lists the folders that are direct descendants of supplied parent resource. `list()` provides a strongly consistent view of the folders underneath the specified parent resource. `list()` returns folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent. Create a request for the method "folders.list". 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.

Returns:

the request

Throws:

IOException

move

public CloudResourceManager.Folders.Move move(String name,
                                              MoveFolderRequest content)
                                       throws IOException

Moves a folder under a new resource parent. Returns an `Operation` which can be used to track the progress of the folder move workflow. Upon success, the `Operation.response` field will be populated with the moved folder. Upon failure, a `FolderOperationError` categorizing the failure cause will be returned - if the failure occurs synchronously then the `FolderOperationError` will be returned in the `Status.details` field. If it occurs asynchronously, then the FolderOperation will be returned in the `Operation.error` field. In addition, the `Operation.metadata` field will be populated with a `FolderOperation` message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height, or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent. Create a request for the method "folders.move". 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 - Required. The resource name of the Folder to move. Must be of the form folders/{folder_id}

content - the MoveFolderRequest

Returns:

the request

Throws:

IOException

patch

public CloudResourceManager.Folders.Patch patch(String name,
                                                Folder content)
                                         throws IOException

Updates a folder, changing its `display_name`. Changes to the folder `display_name` will be rejected if they violate either the `display_name` formatting rules or the naming constraints described in the CreateFolder documentation. The folder's `display_name` must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: `\p{L}\p{N}{1,28}[\p{L}\p{N}]`. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a `PreconditionFailure` explaining this violation will be returned in the Status.details field. Create a request for the method "folders.patch". 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 - Output only. The resource name of the folder. Its format is `folders/{folder_id}`, for example: "folders/1234".

content - the Folder

Returns:

the request

Throws:

IOException

search

public CloudResourceManager.Folders.Search search()
                                           throws IOException

Search for folders that match specific filter criteria. `search()` provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`. Create a request for the method "folders.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.

Returns:

the request

Throws:

IOException

setIamPolicy

public CloudResourceManager.Folders.SetIamPolicy setIamPolicy(String resource,
                                                              SetIamPolicyRequest content)
                                                       throws IOException

Sets the access control policy on a folder, replacing any existing policy. The `resource` field should be the folder's resource name, for example: "folders/1234". The caller must have `resourcemanager.folders.setIamPolicy` permission on the identified folder. Create a request for the method "folders.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 [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 CloudResourceManager.Folders.TestIamPermissions testIamPermissions(String resource,
                                                                          TestIamPermissionsRequest content)
                                                                   throws IOException

Returns permissions that a caller has on the specified folder. The `resource` field should be the folder's resource name, for example: "folders/1234". There are no permissions required for making this API call. Create a request for the method "folders.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 [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 CloudResourceManager.Folders.Undelete undelete(String name,
                                                      UndeleteFolderRequest content)
                                               throws IOException

Cancels the deletion request for a folder. This method may be called on a folder in any state. If the folder is in the ACTIVE state the result will be a no-op success. In order to succeed, the folder's parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height, and fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.undelete` permission on the identified folder. Create a request for the method "folders.undelete". 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 - Required. The resource name of the folder to undelete. Must be of the form `folders/{folder_id}`.

content - the UndeleteFolderRequest

Returns:

the request

Throws:

IOException