pulumi-snowflake 1.2.0a1743575514__py3-none-any.whl → 1.2.0a1744183688__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of pulumi-snowflake might be problematic. Click here for more details.

Files changed (147) hide show
  1. pulumi_snowflake/__init__.py +1 -0
  2. pulumi_snowflake/_inputs.py +12288 -12287
  3. pulumi_snowflake/account.py +186 -185
  4. pulumi_snowflake/account_authentication_policy_attachment.py +15 -14
  5. pulumi_snowflake/account_parameter.py +29 -28
  6. pulumi_snowflake/account_password_policy_attachment.py +15 -14
  7. pulumi_snowflake/account_role.py +32 -31
  8. pulumi_snowflake/alert.py +120 -119
  9. pulumi_snowflake/api_authentication_integration_with_authorization_code_grant.py +158 -157
  10. pulumi_snowflake/api_authentication_integration_with_client_credentials.py +144 -143
  11. pulumi_snowflake/api_authentication_integration_with_jwt_bearer.py +154 -153
  12. pulumi_snowflake/api_integration.py +203 -202
  13. pulumi_snowflake/authentication_policy.py +134 -133
  14. pulumi_snowflake/config/__init__.py +1 -0
  15. pulumi_snowflake/config/__init__.pyi +1 -0
  16. pulumi_snowflake/config/outputs.py +16 -15
  17. pulumi_snowflake/config/vars.py +1 -0
  18. pulumi_snowflake/cortex_search_service.py +141 -140
  19. pulumi_snowflake/database.py +288 -287
  20. pulumi_snowflake/database_role.py +50 -49
  21. pulumi_snowflake/dynamic_table.py +218 -217
  22. pulumi_snowflake/email_notification_integration.py +56 -55
  23. pulumi_snowflake/execute.py +50 -49
  24. pulumi_snowflake/external_function.py +225 -224
  25. pulumi_snowflake/external_oauth_integration.py +232 -231
  26. pulumi_snowflake/external_table.py +197 -196
  27. pulumi_snowflake/external_volume.py +50 -49
  28. pulumi_snowflake/failover_group.py +106 -105
  29. pulumi_snowflake/file_format.py +512 -511
  30. pulumi_snowflake/function_java.py +249 -248
  31. pulumi_snowflake/function_javascript.py +193 -192
  32. pulumi_snowflake/function_python.py +263 -262
  33. pulumi_snowflake/function_scala.py +249 -248
  34. pulumi_snowflake/function_sql.py +179 -178
  35. pulumi_snowflake/get_account_roles.py +12 -11
  36. pulumi_snowflake/get_accounts.py +12 -11
  37. pulumi_snowflake/get_alerts.py +17 -16
  38. pulumi_snowflake/get_connections.py +7 -6
  39. pulumi_snowflake/get_cortex_search_services.py +12 -11
  40. pulumi_snowflake/get_current_account.py +5 -4
  41. pulumi_snowflake/get_current_role.py +3 -2
  42. pulumi_snowflake/get_database.py +15 -14
  43. pulumi_snowflake/get_database_role.py +14 -13
  44. pulumi_snowflake/get_database_roles.py +12 -11
  45. pulumi_snowflake/get_databases.py +22 -21
  46. pulumi_snowflake/get_dynamic_tables.py +7 -6
  47. pulumi_snowflake/get_external_functions.py +12 -11
  48. pulumi_snowflake/get_external_tables.py +12 -11
  49. pulumi_snowflake/get_failover_groups.py +7 -6
  50. pulumi_snowflake/get_file_formats.py +12 -11
  51. pulumi_snowflake/get_functions.py +12 -11
  52. pulumi_snowflake/get_grants.py +2 -1
  53. pulumi_snowflake/get_masking_policies.py +12 -11
  54. pulumi_snowflake/get_materialized_views.py +12 -11
  55. pulumi_snowflake/get_network_policies.py +12 -11
  56. pulumi_snowflake/get_parameters.py +27 -26
  57. pulumi_snowflake/get_pipes.py +12 -11
  58. pulumi_snowflake/get_procedures.py +12 -11
  59. pulumi_snowflake/get_resource_monitors.py +7 -6
  60. pulumi_snowflake/get_row_access_policies.py +12 -11
  61. pulumi_snowflake/get_schemas.py +22 -21
  62. pulumi_snowflake/get_secrets.py +12 -11
  63. pulumi_snowflake/get_security_integrations.py +12 -11
  64. pulumi_snowflake/get_sequences.py +12 -11
  65. pulumi_snowflake/get_shares.py +7 -6
  66. pulumi_snowflake/get_stages.py +12 -11
  67. pulumi_snowflake/get_storage_integrations.py +2 -1
  68. pulumi_snowflake/get_streamlits.py +12 -11
  69. pulumi_snowflake/get_streams.py +17 -16
  70. pulumi_snowflake/get_system_generate_scim_access_token.py +8 -7
  71. pulumi_snowflake/get_system_get_aws_sns_iam_policy.py +8 -7
  72. pulumi_snowflake/get_system_get_private_link_config.py +11 -10
  73. pulumi_snowflake/get_system_get_snowflake_platform_info.py +4 -3
  74. pulumi_snowflake/get_tables.py +12 -11
  75. pulumi_snowflake/get_tags.py +7 -6
  76. pulumi_snowflake/get_tasks.py +22 -21
  77. pulumi_snowflake/get_users.py +22 -21
  78. pulumi_snowflake/get_views.py +17 -16
  79. pulumi_snowflake/get_warehouses.py +17 -16
  80. pulumi_snowflake/grant_account_role.py +43 -42
  81. pulumi_snowflake/grant_application_role.py +43 -42
  82. pulumi_snowflake/grant_database_role.py +57 -56
  83. pulumi_snowflake/grant_ownership.py +43 -42
  84. pulumi_snowflake/grant_privileges_to_account_role.py +95 -94
  85. pulumi_snowflake/grant_privileges_to_database_role.py +95 -94
  86. pulumi_snowflake/grant_privileges_to_share.py +127 -126
  87. pulumi_snowflake/legacy_service_user.py +1039 -1038
  88. pulumi_snowflake/managed_account.py +113 -112
  89. pulumi_snowflake/masking_policy.py +106 -105
  90. pulumi_snowflake/materialized_view.py +120 -119
  91. pulumi_snowflake/network_policy.py +92 -91
  92. pulumi_snowflake/network_policy_attachment.py +43 -42
  93. pulumi_snowflake/network_rule.py +106 -105
  94. pulumi_snowflake/notification_integration.py +238 -237
  95. pulumi_snowflake/oauth_integration_for_custom_clients.py +210 -209
  96. pulumi_snowflake/oauth_integration_for_partner_applications.py +134 -133
  97. pulumi_snowflake/object_parameter.py +57 -56
  98. pulumi_snowflake/outputs.py +9273 -9272
  99. pulumi_snowflake/password_policy.py +246 -245
  100. pulumi_snowflake/pipe.py +148 -147
  101. pulumi_snowflake/primary_connection.py +55 -54
  102. pulumi_snowflake/procedure_java.py +267 -266
  103. pulumi_snowflake/procedure_javascript.py +197 -196
  104. pulumi_snowflake/procedure_python.py +267 -266
  105. pulumi_snowflake/procedure_scala.py +267 -266
  106. pulumi_snowflake/procedure_sql.py +197 -196
  107. pulumi_snowflake/provider.py +303 -302
  108. pulumi_snowflake/pulumi-plugin.json +1 -1
  109. pulumi_snowflake/resource_monitor.py +134 -133
  110. pulumi_snowflake/row_access_policy.py +78 -77
  111. pulumi_snowflake/saml2_integration.py +246 -245
  112. pulumi_snowflake/schema.py +316 -315
  113. pulumi_snowflake/scim_integration.py +106 -105
  114. pulumi_snowflake/secondary_connection.py +57 -56
  115. pulumi_snowflake/secondary_database.py +288 -287
  116. pulumi_snowflake/secret_with_authorization_code_grant.py +109 -108
  117. pulumi_snowflake/secret_with_basic_authentication.py +95 -94
  118. pulumi_snowflake/secret_with_client_credentials.py +99 -98
  119. pulumi_snowflake/secret_with_generic_string.py +81 -80
  120. pulumi_snowflake/sequence.py +99 -98
  121. pulumi_snowflake/service_user.py +1015 -1014
  122. pulumi_snowflake/share.py +50 -49
  123. pulumi_snowflake/shared_database.py +246 -245
  124. pulumi_snowflake/stage.py +190 -189
  125. pulumi_snowflake/storage_integration.py +166 -165
  126. pulumi_snowflake/stream_on_directory_table.py +100 -99
  127. pulumi_snowflake/stream_on_external_table.py +114 -113
  128. pulumi_snowflake/stream_on_table.py +124 -123
  129. pulumi_snowflake/stream_on_view.py +124 -123
  130. pulumi_snowflake/streamlit.py +148 -147
  131. pulumi_snowflake/table.py +113 -112
  132. pulumi_snowflake/table_column_masking_policy_application.py +43 -42
  133. pulumi_snowflake/table_constraint.py +155 -154
  134. pulumi_snowflake/tag.py +92 -91
  135. pulumi_snowflake/tag_association.py +71 -70
  136. pulumi_snowflake/task.py +1002 -1001
  137. pulumi_snowflake/user.py +1101 -1100
  138. pulumi_snowflake/user_authentication_policy_attachment.py +29 -28
  139. pulumi_snowflake/user_password_policy_attachment.py +29 -28
  140. pulumi_snowflake/user_public_keys.py +43 -42
  141. pulumi_snowflake/view.py +136 -135
  142. pulumi_snowflake/warehouse.py +232 -231
  143. {pulumi_snowflake-1.2.0a1743575514.dist-info → pulumi_snowflake-1.2.0a1744183688.dist-info}/METADATA +1 -1
  144. pulumi_snowflake-1.2.0a1744183688.dist-info/RECORD +148 -0
  145. pulumi_snowflake-1.2.0a1743575514.dist-info/RECORD +0 -148
  146. {pulumi_snowflake-1.2.0a1743575514.dist-info → pulumi_snowflake-1.2.0a1744183688.dist-info}/WHEEL +0 -0
  147. {pulumi_snowflake-1.2.0a1743575514.dist-info → pulumi_snowflake-1.2.0a1744183688.dist-info}/top_level.txt +0 -0
pulumi_snowflake/stream_on_table.py CHANGED
@@ -2,6 +2,7 @@
2
2
  # *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
3
3
  # *** Do not edit by hand unless you're certain you know what you are doing! ***
4
4
 
5
+ import builtins
5
6
  import copy
6
7
  import warnings
7
8
  import sys
@@ -21,24 +22,24 @@ __all__ = ['StreamOnTableArgs', 'StreamOnTable']
21
22
  @pulumi.input_type
22
23
  class StreamOnTableArgs:
23
24
  def __init__(__self__, *,
24
- database: pulumi.Input[str],
25
- schema: pulumi.Input[str],
26
- table: pulumi.Input[str],
27
- append_only: Optional[pulumi.Input[str]] = None,
25
+ database: pulumi.Input[builtins.str],
26
+ schema: pulumi.Input[builtins.str],
27
+ table: pulumi.Input[builtins.str],
28
+ append_only: Optional[pulumi.Input[builtins.str]] = None,
28
29
  at: Optional[pulumi.Input['StreamOnTableAtArgs']] = None,
29
30
  before: Optional[pulumi.Input['StreamOnTableBeforeArgs']] = None,
30
- comment: Optional[pulumi.Input[str]] = None,
31
- copy_grants: Optional[pulumi.Input[bool]] = None,
32
- name: Optional[pulumi.Input[str]] = None,
33
- show_initial_rows: Optional[pulumi.Input[str]] = None):
31
+ comment: Optional[pulumi.Input[builtins.str]] = None,
32
+ copy_grants: Optional[pulumi.Input[builtins.bool]] = None,
33
+ name: Optional[pulumi.Input[builtins.str]] = None,
34
+ show_initial_rows: Optional[pulumi.Input[builtins.str]] = None):
34
35
  """
35
36
  The set of arguments for constructing a StreamOnTable resource.
36
- :param pulumi.Input[str] database: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
37
- :param pulumi.Input[str] schema: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
38
- :param pulumi.Input[str] table: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`. For more information about this resource, see docs.
39
- :param pulumi.Input[str] append_only: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
40
- :param pulumi.Input[str] comment: Specifies a comment for the stream.
41
- :param pulumi.Input[str] name: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
37
+ :param pulumi.Input[builtins.str] database: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
38
+ :param pulumi.Input[builtins.str] schema: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
39
+ :param pulumi.Input[builtins.str] table: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`. For more information about this resource, see docs.
40
+ :param pulumi.Input[builtins.str] append_only: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
41
+ :param pulumi.Input[builtins.str] comment: Specifies a comment for the stream.
42
+ :param pulumi.Input[builtins.str] name: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
42
43
  """
43
44
  pulumi.set(__self__, "database", database)
44
45
  pulumi.set(__self__, "schema", schema)
@@ -60,50 +61,50 @@ class StreamOnTableArgs:
60
61
 
61
62
  @property
62
63
  @pulumi.getter
63
- def database(self) -> pulumi.Input[str]:
64
+ def database(self) -> pulumi.Input[builtins.str]:
64
65
  """
65
66
  The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
66
67
  """
67
68
  return pulumi.get(self, "database")
68
69
 
69
70
  @database.setter
70
- def database(self, value: pulumi.Input[str]):
71
+ def database(self, value: pulumi.Input[builtins.str]):
71
72
  pulumi.set(self, "database", value)
72
73
 
73
74
  @property
74
75
  @pulumi.getter
75
- def schema(self) -> pulumi.Input[str]:
76
+ def schema(self) -> pulumi.Input[builtins.str]:
76
77
  """
77
78
  The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
78
79
  """
79
80
  return pulumi.get(self, "schema")
80
81
 
81
82
  @schema.setter
82
- def schema(self, value: pulumi.Input[str]):
83
+ def schema(self, value: pulumi.Input[builtins.str]):
83
84
  pulumi.set(self, "schema", value)
84
85
 
85
86
  @property
86
87
  @pulumi.getter
87
- def table(self) -> pulumi.Input[str]:
88
+ def table(self) -> pulumi.Input[builtins.str]:
88
89
  """
89
90
  Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`. For more information about this resource, see docs.
90
91
  """
91
92
  return pulumi.get(self, "table")
92
93
 
93
94
  @table.setter
94
- def table(self, value: pulumi.Input[str]):
95
+ def table(self, value: pulumi.Input[builtins.str]):
95
96
  pulumi.set(self, "table", value)
96
97
 
97
98
  @property
98
99
  @pulumi.getter(name="appendOnly")
99
- def append_only(self) -> Optional[pulumi.Input[str]]:
100
+ def append_only(self) -> Optional[pulumi.Input[builtins.str]]:
100
101
  """
101
102
  Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
102
103
  """
103
104
  return pulumi.get(self, "append_only")
104
105
 
105
106
  @append_only.setter
106
- def append_only(self, value: Optional[pulumi.Input[str]]):
107
+ def append_only(self, value: Optional[pulumi.Input[builtins.str]]):
107
108
  pulumi.set(self, "append_only", value)
108
109
 
109
110
  @property
@@ -126,77 +127,77 @@ class StreamOnTableArgs:
126
127
 
127
128
  @property
128
129
  @pulumi.getter
129
- def comment(self) -> Optional[pulumi.Input[str]]:
130
+ def comment(self) -> Optional[pulumi.Input[builtins.str]]:
130
131
  """
131
132
  Specifies a comment for the stream.
132
133
  """
133
134
  return pulumi.get(self, "comment")
134
135
 
135
136
  @comment.setter
136
- def comment(self, value: Optional[pulumi.Input[str]]):
137
+ def comment(self, value: Optional[pulumi.Input[builtins.str]]):
137
138
  pulumi.set(self, "comment", value)
138
139
 
139
140
  @property
140
141
  @pulumi.getter(name="copyGrants")
141
- def copy_grants(self) -> Optional[pulumi.Input[bool]]:
142
+ def copy_grants(self) -> Optional[pulumi.Input[builtins.bool]]:
142
143
  return pulumi.get(self, "copy_grants")
143
144
 
144
145
  @copy_grants.setter
145
- def copy_grants(self, value: Optional[pulumi.Input[bool]]):
146
+ def copy_grants(self, value: Optional[pulumi.Input[builtins.bool]]):
146
147
  pulumi.set(self, "copy_grants", value)
147
148
 
148
149
  @property
149
150
  @pulumi.getter
150
- def name(self) -> Optional[pulumi.Input[str]]:
151
+ def name(self) -> Optional[pulumi.Input[builtins.str]]:
151
152
  """
152
153
  Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
153
154
  """
154
155
  return pulumi.get(self, "name")
155
156
 
156
157
  @name.setter
157
- def name(self, value: Optional[pulumi.Input[str]]):
158
+ def name(self, value: Optional[pulumi.Input[builtins.str]]):
158
159
  pulumi.set(self, "name", value)
159
160
 
160
161
  @property
161
162
  @pulumi.getter(name="showInitialRows")
162
- def show_initial_rows(self) -> Optional[pulumi.Input[str]]:
163
+ def show_initial_rows(self) -> Optional[pulumi.Input[builtins.str]]:
163
164
  return pulumi.get(self, "show_initial_rows")
164
165
 
165
166
  @show_initial_rows.setter
166
- def show_initial_rows(self, value: Optional[pulumi.Input[str]]):
167
+ def show_initial_rows(self, value: Optional[pulumi.Input[builtins.str]]):
167
168
  pulumi.set(self, "show_initial_rows", value)
168
169
 
169
170
 
170
171
  @pulumi.input_type
171
172
  class _StreamOnTableState:
172
173
  def __init__(__self__, *,
173
- append_only: Optional[pulumi.Input[str]] = None,
174
+ append_only: Optional[pulumi.Input[builtins.str]] = None,
174
175
  at: Optional[pulumi.Input['StreamOnTableAtArgs']] = None,
175
176
  before: Optional[pulumi.Input['StreamOnTableBeforeArgs']] = None,
176
- comment: Optional[pulumi.Input[str]] = None,
177
- copy_grants: Optional[pulumi.Input[bool]] = None,
178
- database: Optional[pulumi.Input[str]] = None,
177
+ comment: Optional[pulumi.Input[builtins.str]] = None,
178
+ copy_grants: Optional[pulumi.Input[builtins.bool]] = None,
179
+ database: Optional[pulumi.Input[builtins.str]] = None,
179
180
  describe_outputs: Optional[pulumi.Input[Sequence[pulumi.Input['StreamOnTableDescribeOutputArgs']]]] = None,
180
- fully_qualified_name: Optional[pulumi.Input[str]] = None,
181
- name: Optional[pulumi.Input[str]] = None,
182
- schema: Optional[pulumi.Input[str]] = None,
183
- show_initial_rows: Optional[pulumi.Input[str]] = None,
181
+ fully_qualified_name: Optional[pulumi.Input[builtins.str]] = None,
182
+ name: Optional[pulumi.Input[builtins.str]] = None,
183
+ schema: Optional[pulumi.Input[builtins.str]] = None,
184
+ show_initial_rows: Optional[pulumi.Input[builtins.str]] = None,
184
185
  show_outputs: Optional[pulumi.Input[Sequence[pulumi.Input['StreamOnTableShowOutputArgs']]]] = None,
185
- stale: Optional[pulumi.Input[bool]] = None,
186
- stream_type: Optional[pulumi.Input[str]] = None,
187
- table: Optional[pulumi.Input[str]] = None):
186
+ stale: Optional[pulumi.Input[builtins.bool]] = None,
187
+ stream_type: Optional[pulumi.Input[builtins.str]] = None,
188
+ table: Optional[pulumi.Input[builtins.str]] = None):
188
189
  """
189
190
  Input properties used for looking up and filtering StreamOnTable resources.
190
- :param pulumi.Input[str] append_only: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
191
- :param pulumi.Input[str] comment: Specifies a comment for the stream.
192
- :param pulumi.Input[str] database: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
191
+ :param pulumi.Input[builtins.str] append_only: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
192
+ :param pulumi.Input[builtins.str] comment: Specifies a comment for the stream.
193
+ :param pulumi.Input[builtins.str] database: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
193
194
  :param pulumi.Input[Sequence[pulumi.Input['StreamOnTableDescribeOutputArgs']]] describe_outputs: Outputs the result of `DESCRIBE STREAM` for the given stream.
194
- :param pulumi.Input[str] fully_qualified_name: Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
195
- :param pulumi.Input[str] name: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
196
- :param pulumi.Input[str] schema: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
195
+ :param pulumi.Input[builtins.str] fully_qualified_name: Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
196
+ :param pulumi.Input[builtins.str] name: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
197
+ :param pulumi.Input[builtins.str] schema: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
197
198
  :param pulumi.Input[Sequence[pulumi.Input['StreamOnTableShowOutputArgs']]] show_outputs: Outputs the result of `SHOW STREAMS` for the given stream.
198
- :param pulumi.Input[str] stream_type: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
199
- :param pulumi.Input[str] table: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`. For more information about this resource, see docs.
199
+ :param pulumi.Input[builtins.str] stream_type: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
200
+ :param pulumi.Input[builtins.str] table: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`. For more information about this resource, see docs.
200
201
  """
201
202
  if append_only is not None:
202
203
  pulumi.set(__self__, "append_only", append_only)
@@ -231,14 +232,14 @@ class _StreamOnTableState:
231
232
 
232
233
  @property
233
234
  @pulumi.getter(name="appendOnly")
234
- def append_only(self) -> Optional[pulumi.Input[str]]:
235
+ def append_only(self) -> Optional[pulumi.Input[builtins.str]]:
235
236
  """
236
237
  Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
237
238
  """
238
239
  return pulumi.get(self, "append_only")
239
240
 
240
241
  @append_only.setter
241
- def append_only(self, value: Optional[pulumi.Input[str]]):
242
+ def append_only(self, value: Optional[pulumi.Input[builtins.str]]):
242
243
  pulumi.set(self, "append_only", value)
243
244
 
244
245
  @property
@@ -261,35 +262,35 @@ class _StreamOnTableState:
261
262
 
262
263
  @property
263
264
  @pulumi.getter
264
- def comment(self) -> Optional[pulumi.Input[str]]:
265
+ def comment(self) -> Optional[pulumi.Input[builtins.str]]:
265
266
  """
266
267
  Specifies a comment for the stream.
267
268
  """
268
269
  return pulumi.get(self, "comment")
269
270
 
270
271
  @comment.setter
271
- def comment(self, value: Optional[pulumi.Input[str]]):
272
+ def comment(self, value: Optional[pulumi.Input[builtins.str]]):
272
273
  pulumi.set(self, "comment", value)
273
274
 
274
275
  @property
275
276
  @pulumi.getter(name="copyGrants")
276
- def copy_grants(self) -> Optional[pulumi.Input[bool]]:
277
+ def copy_grants(self) -> Optional[pulumi.Input[builtins.bool]]:
277
278
  return pulumi.get(self, "copy_grants")
278
279
 
279
280
  @copy_grants.setter
280
- def copy_grants(self, value: Optional[pulumi.Input[bool]]):
281
+ def copy_grants(self, value: Optional[pulumi.Input[builtins.bool]]):
281
282
  pulumi.set(self, "copy_grants", value)
282
283
 
283
284
  @property
284
285
  @pulumi.getter
285
- def database(self) -> Optional[pulumi.Input[str]]:
286
+ def database(self) -> Optional[pulumi.Input[builtins.str]]:
286
287
  """
287
288
  The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
288
289
  """
289
290
  return pulumi.get(self, "database")
290
291
 
291
292
  @database.setter
292
- def database(self, value: Optional[pulumi.Input[str]]):
293
+ def database(self, value: Optional[pulumi.Input[builtins.str]]):
293
294
  pulumi.set(self, "database", value)
294
295
 
295
296
  @property
@@ -306,47 +307,47 @@ class _StreamOnTableState:
306
307
 
307
308
  @property
308
309
  @pulumi.getter(name="fullyQualifiedName")
309
- def fully_qualified_name(self) -> Optional[pulumi.Input[str]]:
310
+ def fully_qualified_name(self) -> Optional[pulumi.Input[builtins.str]]:
310
311
  """
311
312
  Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
312
313
  """
313
314
  return pulumi.get(self, "fully_qualified_name")
314
315
 
315
316
  @fully_qualified_name.setter
316
- def fully_qualified_name(self, value: Optional[pulumi.Input[str]]):
317
+ def fully_qualified_name(self, value: Optional[pulumi.Input[builtins.str]]):
317
318
  pulumi.set(self, "fully_qualified_name", value)
318
319
 
319
320
  @property
320
321
  @pulumi.getter
321
- def name(self) -> Optional[pulumi.Input[str]]:
322
+ def name(self) -> Optional[pulumi.Input[builtins.str]]:
322
323
  """
323
324
  Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
324
325
  """
325
326
  return pulumi.get(self, "name")
326
327
 
327
328
  @name.setter
328
- def name(self, value: Optional[pulumi.Input[str]]):
329
+ def name(self, value: Optional[pulumi.Input[builtins.str]]):
329
330
  pulumi.set(self, "name", value)
330
331
 
331
332
  @property
332
333
  @pulumi.getter
333
- def schema(self) -> Optional[pulumi.Input[str]]:
334
+ def schema(self) -> Optional[pulumi.Input[builtins.str]]:
334
335
  """
335
336
  The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
336
337
  """
337
338
  return pulumi.get(self, "schema")
338
339
 
339
340
  @schema.setter
340
- def schema(self, value: Optional[pulumi.Input[str]]):
341
+ def schema(self, value: Optional[pulumi.Input[builtins.str]]):
341
342
  pulumi.set(self, "schema", value)
342
343
 
343
344
  @property
344
345
  @pulumi.getter(name="showInitialRows")
345
- def show_initial_rows(self) -> Optional[pulumi.Input[str]]:
346
+ def show_initial_rows(self) -> Optional[pulumi.Input[builtins.str]]:
346
347
  return pulumi.get(self, "show_initial_rows")
347
348
 
348
349
  @show_initial_rows.setter
349
- def show_initial_rows(self, value: Optional[pulumi.Input[str]]):
350
+ def show_initial_rows(self, value: Optional[pulumi.Input[builtins.str]]):
350
351
  pulumi.set(self, "show_initial_rows", value)
351
352
 
352
353
  @property
@@ -363,35 +364,35 @@ class _StreamOnTableState:
363
364
 
364
365
  @property
365
366
  @pulumi.getter
366
- def stale(self) -> Optional[pulumi.Input[bool]]:
367
+ def stale(self) -> Optional[pulumi.Input[builtins.bool]]:
367
368
  return pulumi.get(self, "stale")
368
369
 
369
370
  @stale.setter
370
- def stale(self, value: Optional[pulumi.Input[bool]]):
371
+ def stale(self, value: Optional[pulumi.Input[builtins.bool]]):
371
372
  pulumi.set(self, "stale", value)
372
373
 
373
374
  @property
374
375
  @pulumi.getter(name="streamType")
375
- def stream_type(self) -> Optional[pulumi.Input[str]]:
376
+ def stream_type(self) -> Optional[pulumi.Input[builtins.str]]:
376
377
  """
377
378
  Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
378
379
  """
379
380
  return pulumi.get(self, "stream_type")
380
381
 
381
382
  @stream_type.setter
382
- def stream_type(self, value: Optional[pulumi.Input[str]]):
383
+ def stream_type(self, value: Optional[pulumi.Input[builtins.str]]):
383
384
  pulumi.set(self, "stream_type", value)
384
385
 
385
386
  @property
386
387
  @pulumi.getter
387
- def table(self) -> Optional[pulumi.Input[str]]:
388
+ def table(self) -> Optional[pulumi.Input[builtins.str]]:
388
389
  """
389
390
  Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`. For more information about this resource, see docs.
390
391
  """
391
392
  return pulumi.get(self, "table")
392
393
 
393
394
  @table.setter
394
- def table(self, value: Optional[pulumi.Input[str]]):
395
+ def table(self, value: Optional[pulumi.Input[builtins.str]]):
395
396
  pulumi.set(self, "table", value)
396
397
 
397
398
 
@@ -400,16 +401,16 @@ class StreamOnTable(pulumi.CustomResource):
400
401
  def __init__(__self__,
401
402
  resource_name: str,
402
403
  opts: Optional[pulumi.ResourceOptions] = None,
403
- append_only: Optional[pulumi.Input[str]] = None,
404
+ append_only: Optional[pulumi.Input[builtins.str]] = None,
404
405
  at: Optional[pulumi.Input[Union['StreamOnTableAtArgs', 'StreamOnTableAtArgsDict']]] = None,
405
406
  before: Optional[pulumi.Input[Union['StreamOnTableBeforeArgs', 'StreamOnTableBeforeArgsDict']]] = None,
406
- comment: Optional[pulumi.Input[str]] = None,
407
- copy_grants: Optional[pulumi.Input[bool]] = None,
408
- database: Optional[pulumi.Input[str]] = None,
409
- name: Optional[pulumi.Input[str]] = None,
410
- schema: Optional[pulumi.Input[str]] = None,
411
- show_initial_rows: Optional[pulumi.Input[str]] = None,
412
- table: Optional[pulumi.Input[str]] = None,
407
+ comment: Optional[pulumi.Input[builtins.str]] = None,
408
+ copy_grants: Optional[pulumi.Input[builtins.bool]] = None,
409
+ database: Optional[pulumi.Input[builtins.str]] = None,
410
+ name: Optional[pulumi.Input[builtins.str]] = None,
411
+ schema: Optional[pulumi.Input[builtins.str]] = None,
412
+ show_initial_rows: Optional[pulumi.Input[builtins.str]] = None,
413
+ table: Optional[pulumi.Input[builtins.str]] = None,
413
414
  __props__=None):
414
415
  """
415
416
  ## Import
@@ -420,12 +421,12 @@ class StreamOnTable(pulumi.CustomResource):
420
421
 
421
422
  :param str resource_name: The name of the resource.
422
423
  :param pulumi.ResourceOptions opts: Options for the resource.
423
- :param pulumi.Input[str] append_only: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
424
- :param pulumi.Input[str] comment: Specifies a comment for the stream.
425
- :param pulumi.Input[str] database: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
426
- :param pulumi.Input[str] name: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
427
- :param pulumi.Input[str] schema: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
428
- :param pulumi.Input[str] table: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`. For more information about this resource, see docs.
424
+ :param pulumi.Input[builtins.str] append_only: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
425
+ :param pulumi.Input[builtins.str] comment: Specifies a comment for the stream.
426
+ :param pulumi.Input[builtins.str] database: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
427
+ :param pulumi.Input[builtins.str] name: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
428
+ :param pulumi.Input[builtins.str] schema: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
429
+ :param pulumi.Input[builtins.str] table: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`. For more information about this resource, see docs.
429
430
  """
430
431
  ...
431
432
  @overload
@@ -455,16 +456,16 @@ class StreamOnTable(pulumi.CustomResource):
455
456
  def _internal_init(__self__,
456
457
  resource_name: str,
457
458
  opts: Optional[pulumi.ResourceOptions] = None,
458
- append_only: Optional[pulumi.Input[str]] = None,
459
+ append_only: Optional[pulumi.Input[builtins.str]] = None,
459
460
  at: Optional[pulumi.Input[Union['StreamOnTableAtArgs', 'StreamOnTableAtArgsDict']]] = None,
460
461
  before: Optional[pulumi.Input[Union['StreamOnTableBeforeArgs', 'StreamOnTableBeforeArgsDict']]] = None,
461
- comment: Optional[pulumi.Input[str]] = None,
462
- copy_grants: Optional[pulumi.Input[bool]] = None,
463
- database: Optional[pulumi.Input[str]] = None,
464
- name: Optional[pulumi.Input[str]] = None,
465
- schema: Optional[pulumi.Input[str]] = None,
466
- show_initial_rows: Optional[pulumi.Input[str]] = None,
467
- table: Optional[pulumi.Input[str]] = None,
462
+ comment: Optional[pulumi.Input[builtins.str]] = None,
463
+ copy_grants: Optional[pulumi.Input[builtins.bool]] = None,
464
+ database: Optional[pulumi.Input[builtins.str]] = None,
465
+ name: Optional[pulumi.Input[builtins.str]] = None,
466
+ schema: Optional[pulumi.Input[builtins.str]] = None,
467
+ show_initial_rows: Optional[pulumi.Input[builtins.str]] = None,
468
+ table: Optional[pulumi.Input[builtins.str]] = None,
468
469
  __props__=None):
469
470
  opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
470
471
  if not isinstance(opts, pulumi.ResourceOptions):
@@ -505,21 +506,21 @@ class StreamOnTable(pulumi.CustomResource):
505
506
  def get(resource_name: str,
506
507
  id: pulumi.Input[str],
507
508
  opts: Optional[pulumi.ResourceOptions] = None,
508
- append_only: Optional[pulumi.Input[str]] = None,
509
+ append_only: Optional[pulumi.Input[builtins.str]] = None,
509
510
  at: Optional[pulumi.Input[Union['StreamOnTableAtArgs', 'StreamOnTableAtArgsDict']]] = None,
510
511
  before: Optional[pulumi.Input[Union['StreamOnTableBeforeArgs', 'StreamOnTableBeforeArgsDict']]] = None,
511
- comment: Optional[pulumi.Input[str]] = None,
512
- copy_grants: Optional[pulumi.Input[bool]] = None,
513
- database: Optional[pulumi.Input[str]] = None,
512
+ comment: Optional[pulumi.Input[builtins.str]] = None,
513
+ copy_grants: Optional[pulumi.Input[builtins.bool]] = None,
514
+ database: Optional[pulumi.Input[builtins.str]] = None,
514
515
  describe_outputs: Optional[pulumi.Input[Sequence[pulumi.Input[Union['StreamOnTableDescribeOutputArgs', 'StreamOnTableDescribeOutputArgsDict']]]]] = None,
515
- fully_qualified_name: Optional[pulumi.Input[str]] = None,
516
- name: Optional[pulumi.Input[str]] = None,
517
- schema: Optional[pulumi.Input[str]] = None,
518
- show_initial_rows: Optional[pulumi.Input[str]] = None,
516
+ fully_qualified_name: Optional[pulumi.Input[builtins.str]] = None,
517
+ name: Optional[pulumi.Input[builtins.str]] = None,
518
+ schema: Optional[pulumi.Input[builtins.str]] = None,
519
+ show_initial_rows: Optional[pulumi.Input[builtins.str]] = None,
519
520
  show_outputs: Optional[pulumi.Input[Sequence[pulumi.Input[Union['StreamOnTableShowOutputArgs', 'StreamOnTableShowOutputArgsDict']]]]] = None,
520
- stale: Optional[pulumi.Input[bool]] = None,
521
- stream_type: Optional[pulumi.Input[str]] = None,
522
- table: Optional[pulumi.Input[str]] = None) -> 'StreamOnTable':
521
+ stale: Optional[pulumi.Input[builtins.bool]] = None,
522
+ stream_type: Optional[pulumi.Input[builtins.str]] = None,
523
+ table: Optional[pulumi.Input[builtins.str]] = None) -> 'StreamOnTable':
523
524
  """
524
525
  Get an existing StreamOnTable resource's state with the given name, id, and optional extra
525
526
  properties used to qualify the lookup.
@@ -527,16 +528,16 @@ class StreamOnTable(pulumi.CustomResource):
527
528
  :param str resource_name: The unique name of the resulting resource.
528
529
  :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
529
530
  :param pulumi.ResourceOptions opts: Options for the resource.
530
- :param pulumi.Input[str] append_only: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
531
- :param pulumi.Input[str] comment: Specifies a comment for the stream.
532
- :param pulumi.Input[str] database: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
531
+ :param pulumi.Input[builtins.str] append_only: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
532
+ :param pulumi.Input[builtins.str] comment: Specifies a comment for the stream.
533
+ :param pulumi.Input[builtins.str] database: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
533
534
  :param pulumi.Input[Sequence[pulumi.Input[Union['StreamOnTableDescribeOutputArgs', 'StreamOnTableDescribeOutputArgsDict']]]] describe_outputs: Outputs the result of `DESCRIBE STREAM` for the given stream.
534
- :param pulumi.Input[str] fully_qualified_name: Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
535
- :param pulumi.Input[str] name: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
536
- :param pulumi.Input[str] schema: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
535
+ :param pulumi.Input[builtins.str] fully_qualified_name: Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
536
+ :param pulumi.Input[builtins.str] name: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
537
+ :param pulumi.Input[builtins.str] schema: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
537
538
  :param pulumi.Input[Sequence[pulumi.Input[Union['StreamOnTableShowOutputArgs', 'StreamOnTableShowOutputArgsDict']]]] show_outputs: Outputs the result of `SHOW STREAMS` for the given stream.
538
- :param pulumi.Input[str] stream_type: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
539
- :param pulumi.Input[str] table: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`. For more information about this resource, see docs.
539
+ :param pulumi.Input[builtins.str] stream_type: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
540
+ :param pulumi.Input[builtins.str] table: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`. For more information about this resource, see docs.
540
541
  """
541
542
  opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
542
543
 
@@ -561,7 +562,7 @@ class StreamOnTable(pulumi.CustomResource):
561
562
 
562
563
  @property
563
564
  @pulumi.getter(name="appendOnly")
564
- def append_only(self) -> pulumi.Output[Optional[str]]:
565
+ def append_only(self) -> pulumi.Output[Optional[builtins.str]]:
565
566
  """
566
567
  Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
567
568
  """
@@ -579,7 +580,7 @@ class StreamOnTable(pulumi.CustomResource):
579
580
 
580
581
  @property
581
582
  @pulumi.getter
582
- def comment(self) -> pulumi.Output[Optional[str]]:
583
+ def comment(self) -> pulumi.Output[Optional[builtins.str]]:
583
584
  """
584
585
  Specifies a comment for the stream.
585
586
  """
@@ -587,12 +588,12 @@ class StreamOnTable(pulumi.CustomResource):
587
588
 
588
589
  @property
589
590
  @pulumi.getter(name="copyGrants")
590
- def copy_grants(self) -> pulumi.Output[Optional[bool]]:
591
+ def copy_grants(self) -> pulumi.Output[Optional[builtins.bool]]:
591
592
  return pulumi.get(self, "copy_grants")
592
593
 
593
594
  @property
594
595
  @pulumi.getter
595
- def database(self) -> pulumi.Output[str]:
596
+ def database(self) -> pulumi.Output[builtins.str]:
596
597
  """
597
598
  The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
598
599
  """
@@ -608,7 +609,7 @@ class StreamOnTable(pulumi.CustomResource):
608
609
 
609
610
  @property
610
611
  @pulumi.getter(name="fullyQualifiedName")
611
- def fully_qualified_name(self) -> pulumi.Output[str]:
612
+ def fully_qualified_name(self) -> pulumi.Output[builtins.str]:
612
613
  """
613
614
  Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
614
615
  """
@@ -616,7 +617,7 @@ class StreamOnTable(pulumi.CustomResource):
616
617
 
617
618
  @property
618
619
  @pulumi.getter
619
- def name(self) -> pulumi.Output[str]:
620
+ def name(self) -> pulumi.Output[builtins.str]:
620
621
  """
621
622
  Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
622
623
  """
@@ -624,7 +625,7 @@ class StreamOnTable(pulumi.CustomResource):
624
625
 
625
626
  @property
626
627
  @pulumi.getter
627
- def schema(self) -> pulumi.Output[str]:
628
+ def schema(self) -> pulumi.Output[builtins.str]:
628
629
  """
629
630
  The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
630
631
  """
@@ -632,7 +633,7 @@ class StreamOnTable(pulumi.CustomResource):
632
633
 
633
634
  @property
634
635
  @pulumi.getter(name="showInitialRows")
635
- def show_initial_rows(self) -> pulumi.Output[Optional[str]]:
636
+ def show_initial_rows(self) -> pulumi.Output[Optional[builtins.str]]:
636
637
  return pulumi.get(self, "show_initial_rows")
637
638
 
638
639
  @property
@@ -645,12 +646,12 @@ class StreamOnTable(pulumi.CustomResource):
645
646
 
646
647
  @property
647
648
  @pulumi.getter
648
- def stale(self) -> pulumi.Output[bool]:
649
+ def stale(self) -> pulumi.Output[builtins.bool]:
649
650
  return pulumi.get(self, "stale")
650
651
 
651
652
  @property
652
653
  @pulumi.getter(name="streamType")
653
- def stream_type(self) -> pulumi.Output[str]:
654
+ def stream_type(self) -> pulumi.Output[builtins.str]:
654
655
  """
655
656
  Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
656
657
  """
@@ -658,7 +659,7 @@ class StreamOnTable(pulumi.CustomResource):
658
659
 
659
660
  @property
660
661
  @pulumi.getter
661
- def table(self) -> pulumi.Output[str]:
662
+ def table(self) -> pulumi.Output[builtins.str]:
662
663
  """
663
664
  Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`. For more information about this resource, see docs.
664
665
  """