Method: googleapis.cloudresourcemanager.v2.folders.patch

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 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.

Arguments

Parameters

name

string

Required. Output only. The resource name of the Folder. Its format is folders/{folder_id} , for example: "folders/1234".

updateMask

string ( FieldMask format)

Required. Fields to be updated. Only the display_name can be updated.

body

object ( Folder )

Required.

Raised exceptions

Exceptions

ConnectionError

In case of a network problem (such as DNS failure or refused connection).

HttpError

If the response status is >= 400 (excluding 429 and 503).

TimeoutError

If a long-running operation takes longer to finish than the specified timeout limit.

TypeError

If an operation or function receives an argument of the wrong type.

ValueError

If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of Folder .

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation .

YAML

 - 
  
 patch 
 : 
  
 call 
 : 
  
 googleapis.cloudresourcemanager.v2.folders.patch 
  
 args 
 : 
  
 name 
 : 
  
 ... 
  
 updateMask 
 : 
  
 ... 
  
 body 
 : 
  
 displayName 
 : 
  
 ... 
  
 parent 
 : 
  
 ... 
  
 result 
 : 
  
 patchResult

JSON

 [ 
  
 { 
  
 "patch" 
 : 
  
 { 
  
 "call" 
 : 
  
 "googleapis.cloudresourcemanager.v2.folders.patch" 
 , 
  
 "args" 
 : 
  
 { 
  
 "name" 
 : 
  
 "..." 
 , 
  
 "updateMask" 
 : 
  
 "..." 
 , 
  
 "body" 
 : 
  
 { 
  
 "displayName" 
 : 
  
 "..." 
 , 
  
 "parent" 
 : 
  
 "..." 
  
 } 
  
 }, 
  
 "result" 
 : 
  
 "patchResult" 
  
 } 
  
 } 
 ]

Method: googleapis.cloudresourcemanager.v2.folders.patch Stay organized with collections Save and categorize content based on your preferences.