features

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

Overview

Name	features
Type	Resource
Id	googleadmin.directory.features

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	The name of the feature.
etags	string	ETag of the resource.
kind	string	Kind of resource this is. (default: admin#directory#resources#features#Feature)

list

Successful response

Name	Datatype	Description
name	string	The name of the feature.
etags	string	ETag of the resource.
kind	string	Kind of resource this is. (default: admin#directory#resources#features#Feature)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	customer, featureKey		Retrieves a feature.
list	select	customer	maxResults, pageToken	Retrieves a list of features for an account.
insert	insert	customer		Inserts a feature.
patch	update	customer, featureKey		Patches a feature.
update	replace	customer, featureKey		Updates a feature.
delete	delete	customer, featureKey		Deletes a feature.
rename	exec	customer, oldName		Renames a feature.

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
customer	string
featureKey	string
oldName	string
maxResults	integer (int32)
pageToken	string

SELECT examples

get

Retrieves a feature.

SELECT
name,
etags,
kind
FROM googleadmin.directory.features
WHERE customer = '{{ customer }}' -- required
AND featureKey = '{{ featureKey }}' -- required;

list

Retrieves a list of features for an account.

SELECT
name,
etags,
kind
FROM googleadmin.directory.features
WHERE customer = '{{ customer }}' -- required
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

insert

Inserts a feature.

INSERT INTO googleadmin.directory.features (
data__etags,
data__kind,
data__name,
customer
)
SELECT 
'{{ etags }}',
'{{ kind }}',
'{{ name }}',
'{{ customer }}'
RETURNING
name,
etags,
kind
;

Manifest

# Description fields are for documentation purposes
- name: features
  props:
    - name: customer
      value: string
      description: Required parameter for the features resource.
    - name: etags
      value: string
      description: >
        ETag of the resource.
        
    - name: kind
      value: string
      description: >
        Kind of resource this is.
        
      default: admin#directory#resources#features#Feature
    - name: name
      value: string
      description: >
        The name of the feature.
        

UPDATE examples

patch

Patches a feature.

UPDATE googleadmin.directory.features
SET 
data__etags = '{{ etags }}',
data__kind = '{{ kind }}',
data__name = '{{ name }}'
WHERE 
customer = '{{ customer }}' --required
AND featureKey = '{{ featureKey }}' --required
RETURNING
name,
etags,
kind;

REPLACE examples

update

Updates a feature.

REPLACE googleadmin.directory.features
SET 
data__etags = '{{ etags }}',
data__kind = '{{ kind }}',
data__name = '{{ name }}'
WHERE 
customer = '{{ customer }}' --required
AND featureKey = '{{ featureKey }}' --required
RETURNING
name,
etags,
kind;

DELETE examples

delete

Deletes a feature.

DELETE FROM googleadmin.directory.features
WHERE customer = '{{ customer }}' --required
AND featureKey = '{{ featureKey }}' --required;

Lifecycle Methods

rename

Renames a feature.

EXEC googleadmin.directory.features.rename 
@customer='{{ customer }}' --required, 
@oldName='{{ oldName }}' --required 
@@json=
'{
"newName": "{{ newName }}"
}';