Skip to content

Commit 2631a25

Browse files
Sync monorepo state at "add input and output constraints to transformers" (#70)
Syncing from userclouds/userclouds@dc091b8d4723243763779923d0c66b03f70f15a6
1 parent 1126fa9 commit 2631a25

File tree

6 files changed

+667
-50
lines changed

6 files changed

+667
-50
lines changed

docs/resources/transformer.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,65 @@ Manages a Tokenizer transformer. For more details refer to the [transformer docu
2525
### Optional
2626

2727
- `description` (String)
28+
- `input_type_constraints` (Attributes) (see [below for nested schema](#nestedatt--input_type_constraints))
2829
- `output_type` (String) Valid values: `address`, `birthdate`, `boolean`, `composite`, `date`, `e164_phonenumber`, `email`, `integer`, `phonenumber`, `ssn`, `string`, `timestamp`, `uuid`
30+
- `output_type_constraints` (Attributes) (see [below for nested schema](#nestedatt--output_type_constraints))
2931
- `parameters` (String)
3032
- `reuse_existing_token` (Boolean) Specifies if the tokenizing transformer should return existing token instead of creating a new one.
3133
- `tag_ids` (List of String)
3234

3335
### Read-Only
3436

3537
- `id` (String) The ID of this resource.
38+
39+
<a id="nestedatt--input_type_constraints"></a>
40+
### Nested Schema for `input_type_constraints`
41+
42+
Optional:
43+
44+
- `fields` (Attributes List) The set of fields associated with a column of type composite. Fields cannot be specified if the column type is not composite. (see [below for nested schema](#nestedatt--input_type_constraints--fields))
45+
- `immutable_required` (Boolean) Can be enabled when unique_id_required is enabled. If true, values for the associated column cannot be modified, but can be added or removed.
46+
- `unique_id_required` (Boolean) Can be enabled for column type composite or address. If true, each value for the associated column must have a unique string ID, which can either be provided or generated by backend.
47+
- `unique_required` (Boolean) If true, each value for the associated column must be unique for the user. This is primarily useful for array columns.
48+
49+
<a id="nestedatt--input_type_constraints--fields"></a>
50+
### Nested Schema for `input_type_constraints.fields`
51+
52+
Required:
53+
54+
- `name` (String) Each part of name must be capitalized or all-caps, separated by underscores. Names may contain alphanumeric characters, and the first part must start with a letter, while other parts may start with a number. (ex. ID_Field_1)
55+
- `type` (String) Valid values: `address`, `birthdate`, `boolean`, `composite`, `date`, `e164_phonenumber`, `email`, `integer`, `phonenumber`, `ssn`, `string`, `timestamp`, `uuid`
56+
57+
Optional:
58+
59+
- `camel_case_name` (String) Read-only camel-case version of field name, with underscores stripped out. (ex. IDField1)
60+
- `ignore_for_uniqueness` (Boolean) If true, field value will be ignored when comparing two composite value for a uniqueness check.
61+
- `required` (Boolean) Whether a value must be specified for the field.
62+
- `struct_name` (String) Read-only snake-case version of field name, with all letters lowercase. (ex. id_field_1)
63+
64+
65+
66+
<a id="nestedatt--output_type_constraints"></a>
67+
### Nested Schema for `output_type_constraints`
68+
69+
Optional:
70+
71+
- `fields` (Attributes List) The set of fields associated with a column of type composite. Fields cannot be specified if the column type is not composite. (see [below for nested schema](#nestedatt--output_type_constraints--fields))
72+
- `immutable_required` (Boolean) Can be enabled when unique_id_required is enabled. If true, values for the associated column cannot be modified, but can be added or removed.
73+
- `unique_id_required` (Boolean) Can be enabled for column type composite or address. If true, each value for the associated column must have a unique string ID, which can either be provided or generated by backend.
74+
- `unique_required` (Boolean) If true, each value for the associated column must be unique for the user. This is primarily useful for array columns.
75+
76+
<a id="nestedatt--output_type_constraints--fields"></a>
77+
### Nested Schema for `output_type_constraints.fields`
78+
79+
Required:
80+
81+
- `name` (String) Each part of name must be capitalized or all-caps, separated by underscores. Names may contain alphanumeric characters, and the first part must start with a letter, while other parts may start with a number. (ex. ID_Field_1)
82+
- `type` (String) Valid values: `address`, `birthdate`, `boolean`, `composite`, `date`, `e164_phonenumber`, `email`, `integer`, `phonenumber`, `ssn`, `string`, `timestamp`, `uuid`
83+
84+
Optional:
85+
86+
- `camel_case_name` (String) Read-only camel-case version of field name, with underscores stripped out. (ex. IDField1)
87+
- `ignore_for_uniqueness` (Boolean) If true, field value will be ignored when comparing two composite value for a uniqueness check.
88+
- `required` (Boolean) Whether a value must be specified for the field.
89+
- `struct_name` (String) Read-only snake-case version of field name, with all letters lowercase. (ex. id_field_1)

docs/resources/userstore_column.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Optional:
4848
- `fields` (Attributes List) The set of fields associated with a column of type composite. Fields cannot be specified if the column type is not composite. (see [below for nested schema](#nestedatt--constraints--fields))
4949
- `immutable_required` (Boolean) Can be enabled when unique_id_required is enabled. If true, values for the associated column cannot be modified, but can be added or removed.
5050
- `unique_id_required` (Boolean) Can be enabled for column type composite or address. If true, each value for the associated column must have a unique string ID, which can either be provided or generated by backend.
51-
- `unique_required` (Boolean) If true, each value for the associated column must be unique for the user.
51+
- `unique_required` (Boolean) If true, each value for the associated column must be unique for the user. This is primarily useful for array columns.
5252

5353
<a id="nestedatt--constraints--fields"></a>
5454
### Nested Schema for `constraints.fields`
@@ -60,7 +60,7 @@ Required:
6060

6161
Optional:
6262

63-
- `camel_case_name` (String) Derived camel-case version of field name, with underscores stripped out. (ex. IDField1)
63+
- `camel_case_name` (String) Read-only camel-case version of field name, with underscores stripped out. (ex. IDField1)
6464
- `ignore_for_uniqueness` (Boolean) If true, field value will be ignored when comparing two composite value for a uniqueness check.
65-
- `optional` (Boolean) Whether a value must be specified for the field.
66-
- `struct_name` (String) Derived snake-case version of field name, with all letters lowercase. (ex. id_field_1)
65+
- `required` (Boolean) Whether a value must be specified for the field.
66+
- `struct_name` (String) Read-only snake-case version of field name, with all letters lowercase. (ex. id_field_1)

0 commit comments

Comments
 (0)