rule_sets

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

Overview

Name	rule_sets
Type	Resource
Id	google.contentwarehouse.rule_sets

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set.
description	string	Short description of the rule-set.
rules	array	List of rules given by the customer.
source	string	Source of the rules i.e., customer name.

list

Successful response

Name	Datatype	Description
name	string	The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set.
description	string	Short description of the rule-set.
rules	array	List of rules given by the customer.
source	string	Source of the rules i.e., customer name.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, ruleSetsId		Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.
list	select	projectsId, locationsId	pageSize, pageToken	Lists rulesets.
create	insert	projectsId, locationsId		Creates a ruleset.
patch	update	projectsId, locationsId, ruleSetsId		Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.
delete	delete	projectsId, locationsId, ruleSetsId		Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

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
locationsId	string
projectsId	string
ruleSetsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

SELECT
name,
description,
rules,
source
FROM google.contentwarehouse.rule_sets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND ruleSetsId = '{{ ruleSetsId }}' -- required;

list

Lists rulesets.

SELECT
name,
description,
rules,
source
FROM google.contentwarehouse.rule_sets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a ruleset.

INSERT INTO google.contentwarehouse.rule_sets (
data__name,
data__description,
data__source,
data__rules,
projectsId,
locationsId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ source }}',
'{{ rules }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
description,
rules,
source
;

Manifest

# Description fields are for documentation purposes
- name: rule_sets
  props:
    - name: projectsId
      value: string
      description: Required parameter for the rule_sets resource.
    - name: locationsId
      value: string
      description: Required parameter for the rule_sets resource.
    - name: name
      value: string
      description: >
        The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set.
        
    - name: description
      value: string
      description: >
        Short description of the rule-set.
        
    - name: source
      value: string
      description: >
        Source of the rules i.e., customer name.
        
    - name: rules
      value: array
      description: >
        List of rules given by the customer.
        

UPDATE examples

patch

Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

UPDATE google.contentwarehouse.rule_sets
SET 
data__ruleSet = '{{ ruleSet }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND ruleSetsId = '{{ ruleSetsId }}' --required
RETURNING
name,
description,
rules,
source;

DELETE examples

delete

Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

DELETE FROM google.contentwarehouse.rule_sets
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND ruleSetsId = '{{ ruleSetsId }}' --required;