2024-01-09
▼ ▲ storage.folders.delete
Path: b/{bucket}/folders/{folder}
HTTP Method: DELETE
Description: Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.
Parameters:
bucket
Type: string
Description: Name of the bucket in which the folder resides.
Required: Yes
Location: path
folder
Type: string
Description: Name of a folder.
Required: Yes
Location: path
ifMetagenerationMatch
Type: string
Description: If set, only deletes the folder if its metageneration matches this value.
Format: int64
Location: query
ifMetagenerationNotMatch
Type: string
Description: If set, only deletes the folder if its metageneration does not match this value.
Format: int64
Location: query
Parameter Order:
Scopes:
▼ ▲ storage.folders.get
Path: b/{bucket}/folders/{folder}
HTTP Method: GET
Description: Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.
Parameters:
bucket
Type: string
Description: Name of the bucket in which the folder resides.
Required: Yes
Location: path
folder
Type: string
Description: Name of a folder.
Required: Yes
Location: path
ifMetagenerationMatch
Type: string
Description: Makes the return of the folder metadata conditional on whether the folder's current metageneration matches the given value.
Format: int64
Location: query
ifMetagenerationNotMatch
Type: string
Description: Makes the return of the folder metadata conditional on whether the folder's current metageneration does not match the given value.
Format: int64
Location: query
Parameter Order:
Scopes:
▼ ▲ storage.folders.insert
Path: b/{bucket}/folders
HTTP Method: POST
Description: Creates a new folder. Only applicable to buckets with hierarchical namespace enabled.
Parameters:
bucket
Type: string
Description: Name of the bucket in which the folder resides.
Required: Yes
Location: path
recursive
Type: boolean
Description: If true, any parent folder which doesn’t exist will be created automatically.
Location: query
Parameter Order: bucket
Scopes:
▼ ▲ storage.folders.list
Path: b/{bucket}/folders
HTTP Method: GET
Description: Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.
Parameters:
bucket
Type: string
Description: Name of the bucket in which to look for folders.
Required: Yes
Location: path
delimiter
Type: string
Description: Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.
Location: query
endOffset
Type: string
Description: Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
Location: query
pageSize
Type: integer
Description: Maximum number of items to return in a single page of responses.
Format: int32
Minimum: 0
Location: query
pageToken
Type: string
Description: A previously-returned page token representing part of the larger set of results to view.
Location: query
prefix
Type: string
Description: Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.
Location: query
startOffset
Type: string
Description: Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
Location: query
Parameter Order: bucket
Scopes:
▼ ▲ storage.folders.rename
Path: b/{bucket}/folders/{sourceFolder}/renameTo/folders/{destinationFolder}
HTTP Method: POST
Description: Renames a source folder to a destination folder. Only applicable to buckets with hierarchical namespace enabled.
Parameters:
bucket
Type: string
Description: Name of the bucket in which the folders are in.
Required: Yes
Location: path
destinationFolder
Type: string
Description: Name of the destination folder.
Required: Yes
Location: path
ifSourceMetagenerationMatch
Type: string
Description: Makes the operation conditional on whether the source object's current metageneration matches the given value.
Format: int64
Location: query
ifSourceMetagenerationNotMatch
Type: string
Description: Makes the operation conditional on whether the source object's current metageneration does not match the given value.
Format: int64
Location: query
sourceFolder
Type: string
Description: Name of the source folder.
Required: Yes
Location: path
Parameter Order:
Scopes: