managed_folders

Creates, updates, deletes, gets or lists a managed_folders resource.

Overview

Name	managed_folders
Type	Resource
Id	google.storage.managed_folders

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string	The ID of the managed folder, including the bucket name and managed folder name.
name	string	The name of the managed folder. Required if not specified by URL parameter.
bucket	string	The name of the bucket containing this managed folder.
createTime	string (date-time)	The creation time of the managed folder in RFC 3339 format.
kind	string	The kind of item this is. For managed folders, this is always storage#managedFolder. (default: storage#managedFolder)
metageneration	string (int64)	The version of the metadata for this managed folder. Used for preconditions and for detecting changes in metadata.
selfLink	string	The link to this managed folder.
updateTime	string (date-time)	The last update time of the managed folder metadata in RFC 3339 format.

list

Successful response

Name	Datatype	Description
id	string	The ID of the managed folder, including the bucket name and managed folder name.
name	string	The name of the managed folder. Required if not specified by URL parameter.
bucket	string	The name of the bucket containing this managed folder.
createTime	string (date-time)	The creation time of the managed folder in RFC 3339 format.
kind	string	The kind of item this is. For managed folders, this is always storage#managedFolder. (default: storage#managedFolder)
metageneration	string (int64)	The version of the metadata for this managed folder. Used for preconditions and for detecting changes in metadata.
selfLink	string	The link to this managed folder.
updateTime	string (date-time)	The last update time of the managed folder metadata in RFC 3339 format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	bucket, managedFolder	ifMetagenerationMatch, ifMetagenerationNotMatch	Returns metadata of the specified managed folder.
list	select	bucket	pageSize, pageToken, prefix	Lists managed folders in the given bucket.
insert	insert	bucket		Creates a new managed folder.
delete	delete	bucket, managedFolder	ifMetagenerationMatch, ifMetagenerationNotMatch, allowNonEmpty	Permanently deletes a managed folder.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bucket	string
managedFolder	string
allowNonEmpty	boolean
ifMetagenerationMatch	string (int64)
ifMetagenerationNotMatch	string (int64)
pageSize	integer (int32)
pageToken	string
prefix	string

SELECT examples

get

Returns metadata of the specified managed folder.

SELECT
id,
name,
bucket,
createTime,
kind,
metageneration,
selfLink,
updateTime
FROM google.storage.managed_folders
WHERE bucket = '{{ bucket }}' -- required
AND managedFolder = '{{ managedFolder }}' -- required
AND ifMetagenerationMatch = '{{ ifMetagenerationMatch }}'
AND ifMetagenerationNotMatch = '{{ ifMetagenerationNotMatch }}';

list

Lists managed folders in the given bucket.

SELECT
id,
name,
bucket,
createTime,
kind,
metageneration,
selfLink,
updateTime
FROM google.storage.managed_folders
WHERE bucket = '{{ bucket }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND prefix = '{{ prefix }}';

INSERT examples

insert

Creates a new managed folder.

INSERT INTO google.storage.managed_folders (
data__bucket,
data__id,
data__kind,
data__metageneration,
data__name,
data__selfLink,
data__createTime,
data__updateTime,
bucket
)
SELECT 
'{{ bucket }}',
'{{ id }}',
'{{ kind }}',
'{{ metageneration }}',
'{{ name }}',
'{{ selfLink }}',
'{{ createTime }}',
'{{ updateTime }}',
'{{ bucket }}'
RETURNING
id,
name,
bucket,
createTime,
kind,
metageneration,
selfLink,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: managed_folders
  props:
    - name: bucket
      value: string
      description: Required parameter for the managed_folders resource.
    - name: bucket
      value: string
      description: >
        The name of the bucket containing this managed folder.
        
    - name: id
      value: string
      description: >
        The ID of the managed folder, including the bucket name and managed folder name.
        
    - name: kind
      value: string
      description: >
        The kind of item this is. For managed folders, this is always storage#managedFolder.
        
      default: storage#managedFolder
    - name: metageneration
      value: string
      description: >
        The version of the metadata for this managed folder. Used for preconditions and for detecting changes in metadata.
        
    - name: name
      value: string
      description: >
        The name of the managed folder. Required if not specified by URL parameter.
        
    - name: selfLink
      value: string
      description: >
        The link to this managed folder.
        
    - name: createTime
      value: string
      description: >
        The creation time of the managed folder in RFC 3339 format.
        
    - name: updateTime
      value: string
      description: >
        The last update time of the managed folder metadata in RFC 3339 format.
        

DELETE examples

delete

Permanently deletes a managed folder.

DELETE FROM google.storage.managed_folders
WHERE bucket = '{{ bucket }}' --required
AND managedFolder = '{{ managedFolder }}' --required
AND ifMetagenerationMatch = '{{ ifMetagenerationMatch }}'
AND ifMetagenerationNotMatch = '{{ ifMetagenerationNotMatch }}'
AND allowNonEmpty = '{{ allowNonEmpty }}';