From 23294d324c6d15cae3b8c088105b1a23d555ed8f Mon Sep 17 00:00:00 2001 From: "renovate[bot]" Date: Thu, 22 Jun 2023 00:55:17 +0000 Subject: [PATCH] Generate libsonnet source from libgenerator PR https://github.com/tf-libsonnet/libgenerator/pull/180 Signed-off-by: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> --- 4.x/_gen/main.libsonnet | 2 + .../resources/bigtable_gc_policy.libsonnet | 42 +- .../resources/bigtable_instance.libsonnet | 42 +- 4.x/_gen/resources/bigtable_table.libsonnet | 6 +- 4.x/_gen/resources/compute_disk.libsonnet | 4 +- .../compute_network_endpoints.libsonnet | 134 +++++++ 4.x/_gen/resources/compute_url_map.libsonnet | 10 +- .../resources/container_cluster.libsonnet | 48 ++- .../resources/container_node_pool.libsonnet | 24 +- ...s_prevention_deidentify_template.libsonnet | 158 +++++++- ...loss_prevention_inspect_template.libsonnet | 72 +++- ...data_loss_prevention_job_trigger.libsonnet | 96 ++++- 4.x/_gen/resources/pubsub_schema.libsonnet | 6 +- .../resources/sql_database_instance.libsonnet | 4 +- .../vertex_ai_index_endpoint.libsonnet | 140 +++++++ docs/4.x/README.md | 2 + docs/4.x/bigtable_gc_policy.md | 66 ++++ docs/4.x/bigtable_instance.md | 66 ++++ docs/4.x/bigtable_table.md | 1 + docs/4.x/compute_disk.md | 6 +- docs/4.x/compute_network_endpoints.md | 275 +++++++++++++ docs/4.x/compute_url_map.md | 23 ++ docs/4.x/container_cluster.md | 106 +++++ docs/4.x/container_node_pool.md | 53 +++ ...ata_loss_prevention_deidentify_template.md | 373 ++++++++++++++++++ .../data_loss_prevention_inspect_template.md | 156 ++++++++ docs/4.x/data_loss_prevention_job_trigger.md | 183 ++++++++- docs/4.x/pubsub_schema.md | 1 + docs/4.x/sql_database_instance.md | 4 +- docs/4.x/vertex_ai_index_endpoint.md | 260 ++++++++++++ 30 files changed, 2308 insertions(+), 55 deletions(-) create mode 100644 4.x/_gen/resources/compute_network_endpoints.libsonnet create mode 100644 4.x/_gen/resources/vertex_ai_index_endpoint.libsonnet create mode 100644 docs/4.x/compute_network_endpoints.md create mode 100644 docs/4.x/vertex_ai_index_endpoint.md diff --git a/4.x/_gen/main.libsonnet b/4.x/_gen/main.libsonnet index 247f713a..181f135b 100644 --- a/4.x/_gen/main.libsonnet +++ b/4.x/_gen/main.libsonnet @@ -204,6 +204,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); compute_network: (import 'resources/compute_network.libsonnet'), compute_network_endpoint: (import 'resources/compute_network_endpoint.libsonnet'), compute_network_endpoint_group: (import 'resources/compute_network_endpoint_group.libsonnet'), + compute_network_endpoints: (import 'resources/compute_network_endpoints.libsonnet'), compute_network_firewall_policy: (import 'resources/compute_network_firewall_policy.libsonnet'), compute_network_firewall_policy_association: (import 'resources/compute_network_firewall_policy_association.libsonnet'), compute_network_firewall_policy_rule: (import 'resources/compute_network_firewall_policy_rule.libsonnet'), @@ -637,6 +638,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); vertex_ai_featurestore_entitytype: (import 'resources/vertex_ai_featurestore_entitytype.libsonnet'), vertex_ai_featurestore_entitytype_feature: (import 'resources/vertex_ai_featurestore_entitytype_feature.libsonnet'), vertex_ai_index: (import 'resources/vertex_ai_index.libsonnet'), + vertex_ai_index_endpoint: (import 'resources/vertex_ai_index_endpoint.libsonnet'), vertex_ai_tensorboard: (import 'resources/vertex_ai_tensorboard.libsonnet'), vpc_access_connector: (import 'resources/vpc_access_connector.libsonnet'), workflows_workflow: (import 'resources/workflows_workflow.libsonnet'), diff --git a/4.x/_gen/resources/bigtable_gc_policy.libsonnet b/4.x/_gen/resources/bigtable_gc_policy.libsonnet index 3636f366..6c8ae9b0 100644 --- a/4.x/_gen/resources/bigtable_gc_policy.libsonnet +++ b/4.x/_gen/resources/bigtable_gc_policy.libsonnet @@ -20,7 +20,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); number: number, }), }, - '#new':: d.fn(help="\n`google.bigtable_gc_policy.new` injects a new `google_bigtable_gc_policy` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.bigtable_gc_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.bigtable_gc_policy` using the reference:\n\n $._ref.google_bigtable_gc_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_bigtable_gc_policy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `column_family` (`string`): The name of the column family.\n - `deletion_policy` (`string`): The deletion policy for the GC policy. Setting ABANDON allows the resource\n\t\t\t\tto be abandoned rather than deleted. This is useful for GC policy as it cannot be deleted\n\t\t\t\tin a replicated instance. Possible values are: \u0026#34;ABANDON\u0026#34;. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `gc_rules` (`string`): Serialized JSON string for garbage collection policy. Conflicts with \u0026#34;mode\u0026#34;, \u0026#34;max_age\u0026#34; and \u0026#34;max_version\u0026#34;. When `null`, the `gc_rules` field will be omitted from the resulting object.\n - `instance_name` (`string`): The name of the Bigtable instance.\n - `mode` (`string`): NOTE: \u0026#39;gc_rules\u0026#39; is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. If multiple policies are set, you should choose between UNION OR INTERSECTION. When `null`, the `mode` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `table` (`string`): The name of the table.\n - `max_age` (`list[obj]`): NOTE: \u0026#39;gc_rules\u0026#39; is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all cells older than the given age. When `null`, the `max_age` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_age.new](#fn-max_agenew) constructor.\n - `max_version` (`list[obj]`): NOTE: \u0026#39;gc_rules\u0026#39; is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all versions of a cell except for the most recent. When `null`, the `max_version` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_version.new](#fn-max_versionnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google.bigtable_gc_policy.new` injects a new `google_bigtable_gc_policy` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.bigtable_gc_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.bigtable_gc_policy` using the reference:\n\n $._ref.google_bigtable_gc_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_bigtable_gc_policy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `column_family` (`string`): The name of the column family.\n - `deletion_policy` (`string`): The deletion policy for the GC policy. Setting ABANDON allows the resource\n\t\t\t\tto be abandoned rather than deleted. This is useful for GC policy as it cannot be deleted\n\t\t\t\tin a replicated instance. Possible values are: \u0026#34;ABANDON\u0026#34;. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `gc_rules` (`string`): Serialized JSON string for garbage collection policy. Conflicts with \u0026#34;mode\u0026#34;, \u0026#34;max_age\u0026#34; and \u0026#34;max_version\u0026#34;. When `null`, the `gc_rules` field will be omitted from the resulting object.\n - `instance_name` (`string`): The name of the Bigtable instance.\n - `mode` (`string`): NOTE: \u0026#39;gc_rules\u0026#39; is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. If multiple policies are set, you should choose between UNION OR INTERSECTION. When `null`, the `mode` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `table` (`string`): The name of the table.\n - `max_age` (`list[obj]`): NOTE: \u0026#39;gc_rules\u0026#39; is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all cells older than the given age. When `null`, the `max_age` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_age.new](#fn-max_agenew) constructor.\n - `max_version` (`list[obj]`): NOTE: \u0026#39;gc_rules\u0026#39; is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all versions of a cell except for the most recent. When `null`, the `max_version` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_version.new](#fn-max_versionnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, column_family, @@ -32,6 +32,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); max_version=null, mode=null, project=null, + timeouts=null, _meta={} ):: tf.withResource( type='google_bigtable_gc_policy', @@ -45,11 +46,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); max_version=max_version, mode=mode, project=project, - table=table + table=table, + timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.bigtable_gc_policy.newAttrs` constructs a new object with attributes and blocks configured for the `bigtable_gc_policy`\nTerraform resource.\n\nUnlike [google.bigtable_gc_policy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `column_family` (`string`): The name of the column family.\n - `deletion_policy` (`string`): The deletion policy for the GC policy. Setting ABANDON allows the resource\n\t\t\t\tto be abandoned rather than deleted. This is useful for GC policy as it cannot be deleted\n\t\t\t\tin a replicated instance. Possible values are: "ABANDON". When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `gc_rules` (`string`): Serialized JSON string for garbage collection policy. Conflicts with "mode", "max_age" and "max_version". When `null`, the `gc_rules` field will be omitted from the resulting object.\n - `instance_name` (`string`): The name of the Bigtable instance.\n - `mode` (`string`): NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. If multiple policies are set, you should choose between UNION OR INTERSECTION. When `null`, the `mode` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `table` (`string`): The name of the table.\n - `max_age` (`list[obj]`): NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all cells older than the given age. When `null`, the `max_age` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_age.new](#fn-max_agenew) constructor.\n - `max_version` (`list[obj]`): NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all versions of a cell except for the most recent. When `null`, the `max_version` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_version.new](#fn-max_versionnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `bigtable_gc_policy` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.bigtable_gc_policy.newAttrs` constructs a new object with attributes and blocks configured for the `bigtable_gc_policy`\nTerraform resource.\n\nUnlike [google.bigtable_gc_policy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `column_family` (`string`): The name of the column family.\n - `deletion_policy` (`string`): The deletion policy for the GC policy. Setting ABANDON allows the resource\n\t\t\t\tto be abandoned rather than deleted. This is useful for GC policy as it cannot be deleted\n\t\t\t\tin a replicated instance. Possible values are: "ABANDON". When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `gc_rules` (`string`): Serialized JSON string for garbage collection policy. Conflicts with "mode", "max_age" and "max_version". When `null`, the `gc_rules` field will be omitted from the resulting object.\n - `instance_name` (`string`): The name of the Bigtable instance.\n - `mode` (`string`): NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. If multiple policies are set, you should choose between UNION OR INTERSECTION. When `null`, the `mode` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `table` (`string`): The name of the table.\n - `max_age` (`list[obj]`): NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all cells older than the given age. When `null`, the `max_age` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_age.new](#fn-max_agenew) constructor.\n - `max_version` (`list[obj]`): NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all versions of a cell except for the most recent. When `null`, the `max_version` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_version.new](#fn-max_versionnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `bigtable_gc_policy` resource into the root Terraform configuration.\n', args=[]), newAttrs( column_family, instance_name, @@ -59,7 +61,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); max_age=null, max_version=null, mode=null, - project=null + project=null, + timeouts=null ):: std.prune(a={ column_family: column_family, deletion_policy: deletion_policy, @@ -70,7 +73,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); mode: mode, project: project, table: table, + timeouts: timeouts, }), + timeouts:: { + '#new':: d.fn(help='\n`google.bigtable_gc_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, '#withColumnFamily':: d.fn(help='`google.string.withColumnFamily` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the column_family field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `column_family` field.\n', args=[]), withColumnFamily(resourceLabel, value): { resource+: { @@ -181,4 +195,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_bigtable_gc_policy+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_bigtable_gc_policy+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, } diff --git a/4.x/_gen/resources/bigtable_instance.libsonnet b/4.x/_gen/resources/bigtable_instance.libsonnet index 5dd6edee..764f4393 100644 --- a/4.x/_gen/resources/bigtable_instance.libsonnet +++ b/4.x/_gen/resources/bigtable_instance.libsonnet @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); zone: zone, }), }, - '#new':: d.fn(help="\n`google.bigtable_instance.new` injects a new `google_bigtable_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.bigtable_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.bigtable_instance` using the reference:\n\n $._ref.google_bigtable_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_bigtable_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `deletion_protection` (`bool`): Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable display name of the Bigtable instance. Defaults to the instance name. When `null`, the `display_name` field will be omitted from the resulting object.\n - `instance_type` (`string`): The instance type to create. One of \u0026#34;DEVELOPMENT\u0026#34; or \u0026#34;PRODUCTION\u0026#34;. Defaults to \u0026#34;PRODUCTION\u0026#34;. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `labels` (`obj`): A mapping of labels to assign to the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `cluster` (`list[obj]`): A block of cluster configuration options. This can be specified at least once. When `null`, the `cluster` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_instance.cluster.new](#fn-clusternew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google.bigtable_instance.new` injects a new `google_bigtable_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.bigtable_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.bigtable_instance` using the reference:\n\n $._ref.google_bigtable_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_bigtable_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `deletion_protection` (`bool`): Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable display name of the Bigtable instance. Defaults to the instance name. When `null`, the `display_name` field will be omitted from the resulting object.\n - `instance_type` (`string`): The instance type to create. One of \u0026#34;DEVELOPMENT\u0026#34; or \u0026#34;PRODUCTION\u0026#34;. Defaults to \u0026#34;PRODUCTION\u0026#34;. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `labels` (`obj`): A mapping of labels to assign to the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `cluster` (`list[obj]`): A block of cluster configuration options. This can be specified at least once. When `null`, the `cluster` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_instance.cluster.new](#fn-clusternew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -44,6 +44,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); instance_type=null, labels=null, project=null, + timeouts=null, _meta={} ):: tf.withResource( type='google_bigtable_instance', @@ -55,11 +56,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); instance_type=instance_type, labels=labels, name=name, - project=project + project=project, + timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.bigtable_instance.newAttrs` constructs a new object with attributes and blocks configured for the `bigtable_instance`\nTerraform resource.\n\nUnlike [google.bigtable_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `deletion_protection` (`bool`): Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable display name of the Bigtable instance. Defaults to the instance name. When `null`, the `display_name` field will be omitted from the resulting object.\n - `instance_type` (`string`): The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION". When `null`, the `instance_type` field will be omitted from the resulting object.\n - `labels` (`obj`): A mapping of labels to assign to the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `cluster` (`list[obj]`): A block of cluster configuration options. This can be specified at least once. When `null`, the `cluster` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_instance.cluster.new](#fn-clusternew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `bigtable_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.bigtable_instance.newAttrs` constructs a new object with attributes and blocks configured for the `bigtable_instance`\nTerraform resource.\n\nUnlike [google.bigtable_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `deletion_protection` (`bool`): Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable display name of the Bigtable instance. Defaults to the instance name. When `null`, the `display_name` field will be omitted from the resulting object.\n - `instance_type` (`string`): The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION". When `null`, the `instance_type` field will be omitted from the resulting object.\n - `labels` (`obj`): A mapping of labels to assign to the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `cluster` (`list[obj]`): A block of cluster configuration options. This can be specified at least once. When `null`, the `cluster` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_instance.cluster.new](#fn-clusternew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `bigtable_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, cluster=null, @@ -67,7 +69,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); display_name=null, instance_type=null, labels=null, - project=null + project=null, + timeouts=null ):: std.prune(a={ cluster: cluster, deletion_protection: deletion_protection, @@ -76,7 +79,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); labels: labels, name: name, project: project, + timeouts: timeouts, }), + timeouts:: { + '#new':: d.fn(help='\n`google.bigtable_instance.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + update=null + ):: std.prune(a={ + create: create, + update: update, + }), + }, '#withCluster':: d.fn(help='`google.list[obj].withCluster` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the cluster field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withClusterMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `cluster` field.\n', args=[]), withCluster(resourceLabel, value): { resource+: { @@ -157,4 +171,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_bigtable_instance+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_bigtable_instance+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, } diff --git a/4.x/_gen/resources/bigtable_table.libsonnet b/4.x/_gen/resources/bigtable_table.libsonnet index 13c84d2d..8cc00993 100644 --- a/4.x/_gen/resources/bigtable_table.libsonnet +++ b/4.x/_gen/resources/bigtable_table.libsonnet @@ -54,11 +54,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`google.bigtable_table.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.bigtable_table.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( - create=null + create=null, + update=null ):: std.prune(a={ create: create, + update: update, }), }, '#withColumnFamily':: d.fn(help='`google.list[obj].withColumnFamily` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the column_family field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withColumnFamilyMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `column_family` field.\n', args=[]), diff --git a/4.x/_gen/resources/compute_disk.libsonnet b/4.x/_gen/resources/compute_disk.libsonnet index 7475c7c3..ccdef6d6 100644 --- a/4.x/_gen/resources/compute_disk.libsonnet +++ b/4.x/_gen/resources/compute_disk.libsonnet @@ -24,7 +24,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type: type, }), }, - '#new':: d.fn(help="\n`google.compute_disk.new` injects a new `google_compute_disk` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.compute_disk.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_disk` using the reference:\n\n $._ref.google_compute_disk.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_disk.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `image` (`string`): The image from which to initialize this disk. This can be\none of: the image\u0026#39;s \u0026#39;self_link\u0026#39;, \u0026#39;projects/{project}/global/images/{image}\u0026#39;,\n\u0026#39;projects/{project}/global/images/family/{family}\u0026#39;, \u0026#39;global/images/{image}\u0026#39;,\n\u0026#39;global/images/family/{family}\u0026#39;, \u0026#39;family/{family}\u0026#39;, \u0026#39;{project}/{family}\u0026#39;,\n\u0026#39;{project}/{image}\u0026#39;, \u0026#39;{family}\u0026#39;, or \u0026#39;{image}\u0026#39;. If referred by family, the\nimages names must include the family name. If they don\u0026#39;t, use the\n[google_compute_image data source](/docs/providers/google/d/compute_image.html).\nFor instance, the image \u0026#39;centos-6-v20180104\u0026#39; includes its family name \u0026#39;centos-6\u0026#39;.\nThese images can be referred by family name here. When `null`, the `image` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key-\u0026gt;value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `licenses` (`list`): Any applicable license URI. When `null`, the `licenses` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller\u0026#39;s project. When `null`, the `physical_block_size_bytes` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk. When `null`, the `provisioned_iops` field will be omitted from the resulting object.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the \u0026#39;image\u0026#39; or\n\u0026#39;snapshot\u0026#39; parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with \u0026#39;image\u0026#39; or \u0026#39;snapshot\u0026#39;,\nthe value must not be less than the size of the image\nor the size of the snapshot.\n\n~\u0026gt;**NOTE** If you change the size, Terraform updates the disk size\nif upsizing is detected but recreates the disk if downsizing is requested.\nYou can add \u0026#39;lifecycle.prevent_destroy\u0026#39; in the config to prevent destroying\nand recreating. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. If the snapshot is in another\nproject than this disk, you must supply a full URL. For example, the\nfollowing are valid values:\n\n* \u0026#39;https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;global/snapshots/snapshot\u0026#39;\n* \u0026#39;snapshot\u0026#39; When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `guest_os_features` (`list[obj]`): A list of features to enable on the guest operating system.\nApplicable only for bootable disks. When `null`, the `guest_os_features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.guest_os_features.new](#fn-guest_os_featuresnew) constructor.\n - `source_image_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source image. Required if\nthe source image is protected by a customer-supplied encryption key. When `null`, the `source_image_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.source_image_encryption_key.new](#fn-source_image_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google.compute_disk.new` injects a new `google_compute_disk` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.compute_disk.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_disk` using the reference:\n\n $._ref.google_compute_disk.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_disk.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `image` (`string`): The image from which to initialize this disk. This can be\none of: the image\u0026#39;s \u0026#39;self_link\u0026#39;, \u0026#39;projects/{project}/global/images/{image}\u0026#39;,\n\u0026#39;projects/{project}/global/images/family/{family}\u0026#39;, \u0026#39;global/images/{image}\u0026#39;,\n\u0026#39;global/images/family/{family}\u0026#39;, \u0026#39;family/{family}\u0026#39;, \u0026#39;{project}/{family}\u0026#39;,\n\u0026#39;{project}/{image}\u0026#39;, \u0026#39;{family}\u0026#39;, or \u0026#39;{image}\u0026#39;. If referred by family, the\nimages names must include the family name. If they don\u0026#39;t, use the\n[google_compute_image data source](/docs/providers/google/d/compute_image.html).\nFor instance, the image \u0026#39;centos-6-v20180104\u0026#39; includes its family name \u0026#39;centos-6\u0026#39;.\nThese images can be referred by family name here. When `null`, the `image` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key-\u0026gt;value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `licenses` (`list`): Any applicable license URI. When `null`, the `licenses` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller\u0026#39;s project. When `null`, the `physical_block_size_bytes` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk.\nNote: Update currently only supported by hyperdisk skus, allowing for an update of IOPS every 4 hours When `null`, the `provisioned_iops` field will be omitted from the resulting object.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the \u0026#39;image\u0026#39; or\n\u0026#39;snapshot\u0026#39; parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with \u0026#39;image\u0026#39; or \u0026#39;snapshot\u0026#39;,\nthe value must not be less than the size of the image\nor the size of the snapshot.\n\n~\u0026gt;**NOTE** If you change the size, Terraform updates the disk size\nif upsizing is detected but recreates the disk if downsizing is requested.\nYou can add \u0026#39;lifecycle.prevent_destroy\u0026#39; in the config to prevent destroying\nand recreating. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. If the snapshot is in another\nproject than this disk, you must supply a full URL. For example, the\nfollowing are valid values:\n\n* \u0026#39;https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;global/snapshots/snapshot\u0026#39;\n* \u0026#39;snapshot\u0026#39; When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `guest_os_features` (`list[obj]`): A list of features to enable on the guest operating system.\nApplicable only for bootable disks. When `null`, the `guest_os_features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.guest_os_features.new](#fn-guest_os_featuresnew) constructor.\n - `source_image_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source image. Required if\nthe source image is protected by a customer-supplied encryption key. When `null`, the `source_image_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.source_image_encryption_key.new](#fn-source_image_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -71,7 +71,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.compute_disk.newAttrs` constructs a new object with attributes and blocks configured for the `compute_disk`\nTerraform resource.\n\nUnlike [google.compute_disk.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `image` (`string`): The image from which to initialize this disk. This can be\none of: the image's 'self_link', 'projects/{project}/global/images/{image}',\n'projects/{project}/global/images/family/{family}', 'global/images/{image}',\n'global/images/family/{family}', 'family/{family}', '{project}/{family}',\n'{project}/{image}', '{family}', or '{image}'. If referred by family, the\nimages names must include the family name. If they don't, use the\n[google_compute_image data source](/docs/providers/google/d/compute_image.html).\nFor instance, the image 'centos-6-v20180104' includes its family name 'centos-6'.\nThese images can be referred by family name here. When `null`, the `image` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key->value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `licenses` (`list`): Any applicable license URI. When `null`, the `licenses` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller's project. When `null`, the `physical_block_size_bytes` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk. When `null`, the `provisioned_iops` field will be omitted from the resulting object.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the 'image' or\n'snapshot' parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with 'image' or 'snapshot',\nthe value must not be less than the size of the image\nor the size of the snapshot.\n\n~>**NOTE** If you change the size, Terraform updates the disk size\nif upsizing is detected but recreates the disk if downsizing is requested.\nYou can add 'lifecycle.prevent_destroy' in the config to prevent destroying\nand recreating. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. If the snapshot is in another\nproject than this disk, you must supply a full URL. For example, the\nfollowing are valid values:\n\n* 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot'\n* 'projects/project/global/snapshots/snapshot'\n* 'global/snapshots/snapshot'\n* 'snapshot' When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `guest_os_features` (`list[obj]`): A list of features to enable on the guest operating system.\nApplicable only for bootable disks. When `null`, the `guest_os_features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.guest_os_features.new](#fn-guest_os_featuresnew) constructor.\n - `source_image_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source image. Required if\nthe source image is protected by a customer-supplied encryption key. When `null`, the `source_image_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.source_image_encryption_key.new](#fn-source_image_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `compute_disk` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.compute_disk.newAttrs` constructs a new object with attributes and blocks configured for the `compute_disk`\nTerraform resource.\n\nUnlike [google.compute_disk.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `image` (`string`): The image from which to initialize this disk. This can be\none of: the image's 'self_link', 'projects/{project}/global/images/{image}',\n'projects/{project}/global/images/family/{family}', 'global/images/{image}',\n'global/images/family/{family}', 'family/{family}', '{project}/{family}',\n'{project}/{image}', '{family}', or '{image}'. If referred by family, the\nimages names must include the family name. If they don't, use the\n[google_compute_image data source](/docs/providers/google/d/compute_image.html).\nFor instance, the image 'centos-6-v20180104' includes its family name 'centos-6'.\nThese images can be referred by family name here. When `null`, the `image` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key->value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `licenses` (`list`): Any applicable license URI. When `null`, the `licenses` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller's project. When `null`, the `physical_block_size_bytes` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk.\nNote: Update currently only supported by hyperdisk skus, allowing for an update of IOPS every 4 hours When `null`, the `provisioned_iops` field will be omitted from the resulting object.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the 'image' or\n'snapshot' parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with 'image' or 'snapshot',\nthe value must not be less than the size of the image\nor the size of the snapshot.\n\n~>**NOTE** If you change the size, Terraform updates the disk size\nif upsizing is detected but recreates the disk if downsizing is requested.\nYou can add 'lifecycle.prevent_destroy' in the config to prevent destroying\nand recreating. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. If the snapshot is in another\nproject than this disk, you must supply a full URL. For example, the\nfollowing are valid values:\n\n* 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot'\n* 'projects/project/global/snapshots/snapshot'\n* 'global/snapshots/snapshot'\n* 'snapshot' When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `guest_os_features` (`list[obj]`): A list of features to enable on the guest operating system.\nApplicable only for bootable disks. When `null`, the `guest_os_features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.guest_os_features.new](#fn-guest_os_featuresnew) constructor.\n - `source_image_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source image. Required if\nthe source image is protected by a customer-supplied encryption key. When `null`, the `source_image_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.source_image_encryption_key.new](#fn-source_image_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_disk.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `compute_disk` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, description=null, diff --git a/4.x/_gen/resources/compute_network_endpoints.libsonnet b/4.x/_gen/resources/compute_network_endpoints.libsonnet new file mode 100644 index 00000000..9214a2f7 --- /dev/null +++ b/4.x/_gen/resources/compute_network_endpoints.libsonnet @@ -0,0 +1,134 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='compute_network_endpoints', url='', help='`compute_network_endpoints` represents the `google_compute_network_endpoints` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + network_endpoints:: { + '#new':: d.fn(help='\n`google.compute_network_endpoints.network_endpoints.new` constructs a new object with attributes and blocks configured for the `network_endpoints`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance` (`string`): The name for a specific VM instance that the IP address belongs to.\nThis is required for network endpoints of type GCE_VM_IP_PORT.\nThe instance must be in the same zone as the network endpoint group. When `null`, the `instance` field will be omitted from the resulting object.\n - `ip_address` (`string`): IPv4 address of network endpoint. The IP address must belong\nto a VM in GCE (either the primary IP or as part of an aliased IP\nrange).\n - `port` (`number`): Port number of network endpoint.\n**Note** 'port' is required unless the Network Endpoint Group is created\nwith the type of 'GCE_VM_IP' When `null`, the `port` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `network_endpoints` sub block.\n', args=[]), + new( + ip_address, + instance=null, + port=null + ):: std.prune(a={ + instance: instance, + ip_address: ip_address, + port: port, + }), + }, + '#new':: d.fn(help="\n`google.compute_network_endpoints.new` injects a new `google_compute_network_endpoints` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.compute_network_endpoints.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_network_endpoints` using the reference:\n\n $._ref.google_compute_network_endpoints.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_network_endpoints.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `network_endpoint_group` (`string`): The network endpoint group these endpoints are part of.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `zone` (`string`): Zone where the containing network endpoint group is located. When `null`, the `zone` field will be omitted from the resulting object.\n - `network_endpoints` (`list[obj]`): The network endpoints to be added to the enclosing network endpoint group\n(NEG). Each endpoint specifies an IP address and port, along with\nadditional information depending on the NEG type. When `null`, the `network_endpoints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_network_endpoints.network_endpoints.new](#fn-network_endpointsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_network_endpoints.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + network_endpoint_group, + network_endpoints=null, + project=null, + timeouts=null, + zone=null, + _meta={} + ):: tf.withResource( + type='google_compute_network_endpoints', + label=resourceLabel, + attrs=self.newAttrs( + network_endpoint_group=network_endpoint_group, + network_endpoints=network_endpoints, + project=project, + timeouts=timeouts, + zone=zone + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.compute_network_endpoints.newAttrs` constructs a new object with attributes and blocks configured for the `compute_network_endpoints`\nTerraform resource.\n\nUnlike [google.compute_network_endpoints.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `network_endpoint_group` (`string`): The network endpoint group these endpoints are part of.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `zone` (`string`): Zone where the containing network endpoint group is located. When `null`, the `zone` field will be omitted from the resulting object.\n - `network_endpoints` (`list[obj]`): The network endpoints to be added to the enclosing network endpoint group\n(NEG). Each endpoint specifies an IP address and port, along with\nadditional information depending on the NEG type. When `null`, the `network_endpoints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_network_endpoints.network_endpoints.new](#fn-network_endpointsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_network_endpoints.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `compute_network_endpoints` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + network_endpoint_group, + network_endpoints=null, + project=null, + timeouts=null, + zone=null + ):: std.prune(a={ + network_endpoint_group: network_endpoint_group, + network_endpoints: network_endpoints, + project: project, + timeouts: timeouts, + zone: zone, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.compute_network_endpoints.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#withNetworkEndpointGroup':: d.fn(help='`google.string.withNetworkEndpointGroup` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the network_endpoint_group field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `network_endpoint_group` field.\n', args=[]), + withNetworkEndpointGroup(resourceLabel, value): { + resource+: { + google_compute_network_endpoints+: { + [resourceLabel]+: { + network_endpoint_group: value, + }, + }, + }, + }, + '#withNetworkEndpoints':: d.fn(help='`google.list[obj].withNetworkEndpoints` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the network_endpoints field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withNetworkEndpointsMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `network_endpoints` field.\n', args=[]), + withNetworkEndpoints(resourceLabel, value): { + resource+: { + google_compute_network_endpoints+: { + [resourceLabel]+: { + network_endpoints: value, + }, + }, + }, + }, + '#withNetworkEndpointsMixin':: d.fn(help='`google.list[obj].withNetworkEndpointsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the network_endpoints field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withNetworkEndpoints](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `network_endpoints` field.\n', args=[]), + withNetworkEndpointsMixin(resourceLabel, value): { + resource+: { + google_compute_network_endpoints+: { + [resourceLabel]+: { + network_endpoints+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_compute_network_endpoints+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_compute_network_endpoints+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_compute_network_endpoints+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withZone':: d.fn(help='`google.string.withZone` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the zone field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `zone` field.\n', args=[]), + withZone(resourceLabel, value): { + resource+: { + google_compute_network_endpoints+: { + [resourceLabel]+: { + zone: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/compute_url_map.libsonnet b/4.x/_gen/resources/compute_url_map.libsonnet index e297fbaa..447db295 100644 --- a/4.x/_gen/resources/compute_url_map.libsonnet +++ b/4.x/_gen/resources/compute_url_map.libsonnet @@ -876,12 +876,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); filter_match_criteria: filter_match_criteria, }), }, - '#new':: d.fn(help='\n`google.compute_url_map.path_matcher.route_rules.match_rules.new` constructs a new object with attributes and blocks configured for the `match_rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `full_path_match` (`string`): For satisfying the matchRule condition, the path of the request must exactly\nmatch the value specified in fullPathMatch after removing any query parameters\nand anchor that may be part of the original URL. FullPathMatch must be between 1\nand 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must\nbe specified. When `null`, the `full_path_match` field will be omitted from the resulting object.\n - `ignore_case` (`bool`): Specifies that prefixMatch and fullPathMatch matches are case sensitive.\nDefaults to false. When `null`, the `ignore_case` field will be omitted from the resulting object.\n - `prefix_match` (`string`): For satisfying the matchRule condition, the request's path must begin with the\nspecified prefixMatch. prefixMatch must begin with a /. The value must be\nbetween 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or\nregexMatch must be specified. When `null`, the `prefix_match` field will be omitted from the resulting object.\n - `regex_match` (`string`): For satisfying the matchRule condition, the path of the request must satisfy the\nregular expression specified in regexMatch after removing any query parameters\nand anchor supplied with the original URL. For regular expression grammar please\nsee en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch,\nfullPathMatch or regexMatch must be specified. When `null`, the `regex_match` field will be omitted from the resulting object.\n - `header_matches` (`list[obj]`): Specifies a list of header match criteria, all of which must match corresponding\nheaders in the request. When `null`, the `header_matches` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_url_map.path_matcher.route_rules.match_rules.header_matches.new](#fn-path_matcherpath_matcherroute_rulesheader_matchesnew) constructor.\n - `metadata_filters` (`list[obj]`): Opaque filter criteria used by Loadbalancer to restrict routing configuration to\na limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS\nclients present node metadata. If a match takes place, the relevant routing\nconfiguration is made available to those proxies. For each metadataFilter in\nthis list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the\nfilterLabels must match the corresponding label provided in the metadata. If its\nfilterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match\nwith corresponding labels in the provided metadata. metadataFilters specified\nhere can be overrides those specified in ForwardingRule that refers to this\nUrlMap. metadataFilters only applies to Loadbalancers that have their\nloadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `metadata_filters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_url_map.path_matcher.route_rules.match_rules.metadata_filters.new](#fn-path_matcherpath_matcherroute_rulesmetadata_filtersnew) constructor.\n - `query_parameter_matches` (`list[obj]`): Specifies a list of query parameter match criteria, all of which must match\ncorresponding query parameters in the request. When `null`, the `query_parameter_matches` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_url_map.path_matcher.route_rules.match_rules.query_parameter_matches.new](#fn-path_matcherpath_matcherroute_rulesquery_parameter_matchesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `match_rules` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.compute_url_map.path_matcher.route_rules.match_rules.new` constructs a new object with attributes and blocks configured for the `match_rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `full_path_match` (`string`): For satisfying the matchRule condition, the path of the request must exactly\nmatch the value specified in fullPathMatch after removing any query parameters\nand anchor that may be part of the original URL. FullPathMatch must be between 1\nand 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must\nbe specified. When `null`, the `full_path_match` field will be omitted from the resulting object.\n - `ignore_case` (`bool`): Specifies that prefixMatch and fullPathMatch matches are case sensitive.\nDefaults to false. When `null`, the `ignore_case` field will be omitted from the resulting object.\n - `path_template_match` (`string`): For satisfying the matchRule condition, the path of the request\nmust match the wildcard pattern specified in pathTemplateMatch\nafter removing any query parameters and anchor that may be part\nof the original URL.\n\npathTemplateMatch must be between 1 and 255 characters\n(inclusive). The pattern specified by pathTemplateMatch may\nhave at most 5 wildcard operators and at most 5 variable\ncaptures in total. When `null`, the `path_template_match` field will be omitted from the resulting object.\n - `prefix_match` (`string`): For satisfying the matchRule condition, the request's path must begin with the\nspecified prefixMatch. prefixMatch must begin with a /. The value must be\nbetween 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or\nregexMatch must be specified. When `null`, the `prefix_match` field will be omitted from the resulting object.\n - `regex_match` (`string`): For satisfying the matchRule condition, the path of the request must satisfy the\nregular expression specified in regexMatch after removing any query parameters\nand anchor supplied with the original URL. For regular expression grammar please\nsee en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch,\nfullPathMatch or regexMatch must be specified. When `null`, the `regex_match` field will be omitted from the resulting object.\n - `header_matches` (`list[obj]`): Specifies a list of header match criteria, all of which must match corresponding\nheaders in the request. When `null`, the `header_matches` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_url_map.path_matcher.route_rules.match_rules.header_matches.new](#fn-path_matcherpath_matcherroute_rulesheader_matchesnew) constructor.\n - `metadata_filters` (`list[obj]`): Opaque filter criteria used by Loadbalancer to restrict routing configuration to\na limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS\nclients present node metadata. If a match takes place, the relevant routing\nconfiguration is made available to those proxies. For each metadataFilter in\nthis list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the\nfilterLabels must match the corresponding label provided in the metadata. If its\nfilterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match\nwith corresponding labels in the provided metadata. metadataFilters specified\nhere can be overrides those specified in ForwardingRule that refers to this\nUrlMap. metadataFilters only applies to Loadbalancers that have their\nloadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `metadata_filters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_url_map.path_matcher.route_rules.match_rules.metadata_filters.new](#fn-path_matcherpath_matcherroute_rulesmetadata_filtersnew) constructor.\n - `query_parameter_matches` (`list[obj]`): Specifies a list of query parameter match criteria, all of which must match\ncorresponding query parameters in the request. When `null`, the `query_parameter_matches` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_url_map.path_matcher.route_rules.match_rules.query_parameter_matches.new](#fn-path_matcherpath_matcherroute_rulesquery_parameter_matchesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `match_rules` sub block.\n', args=[]), new( full_path_match=null, header_matches=null, ignore_case=null, metadata_filters=null, + path_template_match=null, prefix_match=null, query_parameter_matches=null, regex_match=null @@ -890,6 +891,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); header_matches: header_matches, ignore_case: ignore_case, metadata_filters: metadata_filters, + path_template_match: path_template_match, prefix_match: prefix_match, query_parameter_matches: query_parameter_matches, regex_match: regex_match, @@ -1047,13 +1049,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, url_rewrite:: { - '#new':: d.fn(help='\n`google.compute_url_map.path_matcher.route_rules.route_action.url_rewrite.new` constructs a new object with attributes and blocks configured for the `url_rewrite`\nTerraform sub block.\n\n\n\n**Args**:\n - `host_rewrite` (`string`): Prior to forwarding the request to the selected service, the request's host\nheader is replaced with contents of hostRewrite. The value must be between 1 and\n255 characters. When `null`, the `host_rewrite` field will be omitted from the resulting object.\n - `path_prefix_rewrite` (`string`): Prior to forwarding the request to the selected backend service, the matching\nportion of the request's path is replaced by pathPrefixRewrite. The value must\nbe between 1 and 1024 characters. When `null`, the `path_prefix_rewrite` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `url_rewrite` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.compute_url_map.path_matcher.route_rules.route_action.url_rewrite.new` constructs a new object with attributes and blocks configured for the `url_rewrite`\nTerraform sub block.\n\n\n\n**Args**:\n - `host_rewrite` (`string`): Prior to forwarding the request to the selected service, the request's host\nheader is replaced with contents of hostRewrite. The value must be between 1 and\n255 characters. When `null`, the `host_rewrite` field will be omitted from the resulting object.\n - `path_prefix_rewrite` (`string`): Prior to forwarding the request to the selected backend service, the matching\nportion of the request's path is replaced by pathPrefixRewrite. The value must\nbe between 1 and 1024 characters. When `null`, the `path_prefix_rewrite` field will be omitted from the resulting object.\n - `path_template_rewrite` (`string`): Prior to forwarding the request to the selected origin, if the\nrequest matched a pathTemplateMatch, the matching portion of the\nrequest's path is replaced re-written using the pattern specified\nby pathTemplateRewrite.\n\npathTemplateRewrite must be between 1 and 255 characters\n(inclusive), must start with a '/', and must only use variables\ncaptured by the route's pathTemplate matchers.\n\npathTemplateRewrite may only be used when all of a route's\nMatchRules specify pathTemplate.\n\nOnly one of pathPrefixRewrite and pathTemplateRewrite may be\nspecified. When `null`, the `path_template_rewrite` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `url_rewrite` sub block.\n', args=[]), new( host_rewrite=null, - path_prefix_rewrite=null + path_prefix_rewrite=null, + path_template_rewrite=null ):: std.prune(a={ host_rewrite: host_rewrite, path_prefix_rewrite: path_prefix_rewrite, + path_template_rewrite: path_template_rewrite, }), }, weighted_backend_services:: { diff --git a/4.x/_gen/resources/container_cluster.libsonnet b/4.x/_gen/resources/container_cluster.libsonnet index 3892a167..d5e43f0a 100644 --- a/4.x/_gen/resources/container_cluster.libsonnet +++ b/4.x/_gen/resources/container_cluster.libsonnet @@ -740,7 +740,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); local_ssd_count: local_ssd_count, }), }, - '#new':: d.fn(help='\n`google.container_cluster.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.advanced_machine_features.new](#fn-node_configadvanced_machine_featuresnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_configephemeral_storage_local_ssd_confignew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.gcfs_config.new](#fn-node_configgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.gvnic.new](#fn-node_configgvnicnew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.kubelet_config.new](#fn-node_configkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.linux_node_config.new](#fn-node_configlinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.local_nvme_ssd_block_config.new](#fn-node_configlocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.reservation_affinity.new](#fn-node_configreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.shielded_instance_config.new](#fn-node_configshielded_instance_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.workload_metadata_config.new](#fn-node_configworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.container_cluster.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.advanced_machine_features.new](#fn-node_configadvanced_machine_featuresnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_configephemeral_storage_local_ssd_confignew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.gcfs_config.new](#fn-node_configgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.gvnic.new](#fn-node_configgvnicnew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.kubelet_config.new](#fn-node_configkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.linux_node_config.new](#fn-node_configlinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.local_nvme_ssd_block_config.new](#fn-node_configlocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.reservation_affinity.new](#fn-node_configreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.shielded_instance_config.new](#fn-node_configshielded_instance_confignew) constructor.\n - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.sole_tenant_config.new](#fn-node_configsole_tenant_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.workload_metadata_config.new](#fn-node_configworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), new( advanced_machine_features=null, boot_disk_kms_key=null, @@ -767,6 +767,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); resource_labels=null, service_account=null, shielded_instance_config=null, + sole_tenant_config=null, spot=null, tags=null, taint=null, @@ -797,6 +798,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); resource_labels: resource_labels, service_account: service_account, shielded_instance_config: shielded_instance_config, + sole_tenant_config: sole_tenant_config, spot: spot, tags: tags, taint: taint, @@ -824,6 +826,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_secure_boot: enable_secure_boot, }), }, + sole_tenant_config:: { + '#new':: d.fn(help='\n`google.container_cluster.node_config.sole_tenant_config.new` constructs a new object with attributes and blocks configured for the `sole_tenant_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `node_affinity` (`list[obj]`): . When `null`, the `node_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.sole_tenant_config.node_affinity.new](#fn-node_confignode_confignode_affinitynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `sole_tenant_config` sub block.\n', args=[]), + new( + node_affinity=null + ):: std.prune(a={ + node_affinity: node_affinity, + }), + node_affinity:: { + '#new':: d.fn(help='\n`google.container_cluster.node_config.sole_tenant_config.node_affinity.new` constructs a new object with attributes and blocks configured for the `node_affinity`\nTerraform sub block.\n\n\n\n**Args**:\n - `key` (`string`): .\n - `operator` (`string`): .\n - `values` (`list`): .\n\n**Returns**:\n - An attribute object that represents the `node_affinity` sub block.\n', args=[]), + new( + key, + operator, + values + ):: std.prune(a={ + key: key, + operator: operator, + values: values, + }), + }, + }, workload_metadata_config:: { '#new':: d.fn(help='\n`google.container_cluster.node_config.workload_metadata_config.new` constructs a new object with attributes and blocks configured for the `workload_metadata_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `mode` (`string`): Mode is the configuration for how to expose metadata to workloads running on the node.\n\n**Returns**:\n - An attribute object that represents the `workload_metadata_config` sub block.\n', args=[]), new( @@ -977,7 +999,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); local_ssd_count: local_ssd_count, }), }, - '#new':: d.fn(help='\n`google.container_cluster.node_pool.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.advanced_machine_features.new](#fn-node_poolnode_pooladvanced_machine_featuresnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_poolnode_poolephemeral_storage_local_ssd_confignew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.gcfs_config.new](#fn-node_poolnode_poolgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.gvnic.new](#fn-node_poolnode_poolgvnicnew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.kubelet_config.new](#fn-node_poolnode_poolkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.linux_node_config.new](#fn-node_poolnode_poollinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.local_nvme_ssd_block_config.new](#fn-node_poolnode_poollocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.reservation_affinity.new](#fn-node_poolnode_poolreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.shielded_instance_config.new](#fn-node_poolnode_poolshielded_instance_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.workload_metadata_config.new](#fn-node_poolnode_poolworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.container_cluster.node_pool.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.advanced_machine_features.new](#fn-node_poolnode_pooladvanced_machine_featuresnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_poolnode_poolephemeral_storage_local_ssd_confignew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.gcfs_config.new](#fn-node_poolnode_poolgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.gvnic.new](#fn-node_poolnode_poolgvnicnew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.kubelet_config.new](#fn-node_poolnode_poolkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.linux_node_config.new](#fn-node_poolnode_poollinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.local_nvme_ssd_block_config.new](#fn-node_poolnode_poollocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.reservation_affinity.new](#fn-node_poolnode_poolreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.shielded_instance_config.new](#fn-node_poolnode_poolshielded_instance_confignew) constructor.\n - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.sole_tenant_config.new](#fn-node_poolnode_poolsole_tenant_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.workload_metadata_config.new](#fn-node_poolnode_poolworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), new( advanced_machine_features=null, boot_disk_kms_key=null, @@ -1004,6 +1026,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); resource_labels=null, service_account=null, shielded_instance_config=null, + sole_tenant_config=null, spot=null, tags=null, taint=null, @@ -1034,6 +1057,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); resource_labels: resource_labels, service_account: service_account, shielded_instance_config: shielded_instance_config, + sole_tenant_config: sole_tenant_config, spot: spot, tags: tags, taint: taint, @@ -1061,6 +1085,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_secure_boot: enable_secure_boot, }), }, + sole_tenant_config:: { + '#new':: d.fn(help='\n`google.container_cluster.node_pool.node_config.sole_tenant_config.new` constructs a new object with attributes and blocks configured for the `sole_tenant_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `node_affinity` (`list[obj]`): . When `null`, the `node_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.sole_tenant_config.node_affinity.new](#fn-node_poolnode_poolnode_confignode_affinitynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `sole_tenant_config` sub block.\n', args=[]), + new( + node_affinity=null + ):: std.prune(a={ + node_affinity: node_affinity, + }), + node_affinity:: { + '#new':: d.fn(help='\n`google.container_cluster.node_pool.node_config.sole_tenant_config.node_affinity.new` constructs a new object with attributes and blocks configured for the `node_affinity`\nTerraform sub block.\n\n\n\n**Args**:\n - `key` (`string`): .\n - `operator` (`string`): .\n - `values` (`list`): .\n\n**Returns**:\n - An attribute object that represents the `node_affinity` sub block.\n', args=[]), + new( + key, + operator, + values + ):: std.prune(a={ + key: key, + operator: operator, + values: values, + }), + }, + }, workload_metadata_config:: { '#new':: d.fn(help='\n`google.container_cluster.node_pool.node_config.workload_metadata_config.new` constructs a new object with attributes and blocks configured for the `workload_metadata_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `mode` (`string`): Mode is the configuration for how to expose metadata to workloads running on the node.\n\n**Returns**:\n - An attribute object that represents the `workload_metadata_config` sub block.\n', args=[]), new( diff --git a/4.x/_gen/resources/container_node_pool.libsonnet b/4.x/_gen/resources/container_node_pool.libsonnet index 12a2f9b3..fbee7b9a 100644 --- a/4.x/_gen/resources/container_node_pool.libsonnet +++ b/4.x/_gen/resources/container_node_pool.libsonnet @@ -198,7 +198,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); local_ssd_count: local_ssd_count, }), }, - '#new':: d.fn(help='\n`google.container_node_pool.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.advanced_machine_features.new](#fn-node_configadvanced_machine_featuresnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_configephemeral_storage_local_ssd_confignew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.gcfs_config.new](#fn-node_configgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.gvnic.new](#fn-node_configgvnicnew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.kubelet_config.new](#fn-node_configkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.linux_node_config.new](#fn-node_configlinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.local_nvme_ssd_block_config.new](#fn-node_configlocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.reservation_affinity.new](#fn-node_configreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.shielded_instance_config.new](#fn-node_configshielded_instance_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.workload_metadata_config.new](#fn-node_configworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.container_node_pool.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_kms_key` (`string`): The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. When `null`, the `boot_disk_kms_key` field will be omitted from the resulting object.\n - `disk_size_gb` (`number`): Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. When `null`, the `disk_size_gb` field will be omitted from the resulting object.\n - `disk_type` (`string`): Type of the disk attached to each node. Such as pd-standard, pd-balanced or pd-ssd When `null`, the `disk_type` field will be omitted from the resulting object.\n - `guest_accelerator` (`list`): List of the type and count of accelerator cards attached to the instance. When `null`, the `guest_accelerator` field will be omitted from the resulting object.\n - `image_type` (`string`): The image type to use for this node. Note that for a given image type, the latest version of it will be used. When `null`, the `image_type` field will be omitted from the resulting object.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. When `null`, the `labels` field will be omitted from the resulting object.\n - `local_ssd_count` (`number`): The number of local SSD disks to be attached to the node. When `null`, the `local_ssd_count` field will be omitted from the resulting object.\n - `logging_variant` (`string`): Type of logging agent that is used as the default value for node pools in the cluster. Valid values include DEFAULT and MAX_THROUGHPUT. When `null`, the `logging_variant` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Google Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `metadata` (`obj`): The metadata key/value pairs assigned to instances in the cluster. When `null`, the `metadata` field will be omitted from the resulting object.\n - `min_cpu_platform` (`string`): Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. When `null`, the `min_cpu_platform` field will be omitted from the resulting object.\n - `node_group` (`string`): Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. When `null`, the `node_group` field will be omitted from the resulting object.\n - `oauth_scopes` (`list`): The set of Google API scopes to be made available on all of the node VMs. When `null`, the `oauth_scopes` field will be omitted from the resulting object.\n - `preemptible` (`bool`): Whether the nodes are created as preemptible VM instances. When `null`, the `preemptible` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the node pool. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `service_account` (`string`): The Google Cloud Platform Service Account to be used by the node VMs. When `null`, the `service_account` field will be omitted from the resulting object.\n - `spot` (`bool`): Whether the nodes are created as spot VM instances. When `null`, the `spot` field will be omitted from the resulting object.\n - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object.\n - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object.\n - `advanced_machine_features` (`list[obj]`): Specifies options for controlling advanced machine features. When `null`, the `advanced_machine_features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.advanced_machine_features.new](#fn-node_configadvanced_machine_featuresnew) constructor.\n - `ephemeral_storage_local_ssd_config` (`list[obj]`): Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. When `null`, the `ephemeral_storage_local_ssd_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.ephemeral_storage_local_ssd_config.new](#fn-node_configephemeral_storage_local_ssd_confignew) constructor.\n - `gcfs_config` (`list[obj]`): GCFS configuration for this node. When `null`, the `gcfs_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.gcfs_config.new](#fn-node_configgcfs_confignew) constructor.\n - `gvnic` (`list[obj]`): Enable or disable gvnic in the node pool. When `null`, the `gvnic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.gvnic.new](#fn-node_configgvnicnew) constructor.\n - `kubelet_config` (`list[obj]`): Node kubelet configs. When `null`, the `kubelet_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.kubelet_config.new](#fn-node_configkubelet_confignew) constructor.\n - `linux_node_config` (`list[obj]`): Parameters that can be configured on Linux nodes. When `null`, the `linux_node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.linux_node_config.new](#fn-node_configlinux_node_confignew) constructor.\n - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.local_nvme_ssd_block_config.new](#fn-node_configlocal_nvme_ssd_block_confignew) constructor.\n - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.reservation_affinity.new](#fn-node_configreservation_affinitynew) constructor.\n - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.shielded_instance_config.new](#fn-node_configshielded_instance_confignew) constructor.\n - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.sole_tenant_config.new](#fn-node_configsole_tenant_confignew) constructor.\n - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.workload_metadata_config.new](#fn-node_configworkload_metadata_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), new( advanced_machine_features=null, boot_disk_kms_key=null, @@ -225,6 +225,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); resource_labels=null, service_account=null, shielded_instance_config=null, + sole_tenant_config=null, spot=null, tags=null, taint=null, @@ -255,6 +256,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); resource_labels: resource_labels, service_account: service_account, shielded_instance_config: shielded_instance_config, + sole_tenant_config: sole_tenant_config, spot: spot, tags: tags, taint: taint, @@ -282,6 +284,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_secure_boot: enable_secure_boot, }), }, + sole_tenant_config:: { + '#new':: d.fn(help='\n`google.container_node_pool.node_config.sole_tenant_config.new` constructs a new object with attributes and blocks configured for the `sole_tenant_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `node_affinity` (`list[obj]`): . When `null`, the `node_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.sole_tenant_config.node_affinity.new](#fn-node_confignode_confignode_affinitynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `sole_tenant_config` sub block.\n', args=[]), + new( + node_affinity=null + ):: std.prune(a={ + node_affinity: node_affinity, + }), + node_affinity:: { + '#new':: d.fn(help='\n`google.container_node_pool.node_config.sole_tenant_config.node_affinity.new` constructs a new object with attributes and blocks configured for the `node_affinity`\nTerraform sub block.\n\n\n\n**Args**:\n - `key` (`string`): .\n - `operator` (`string`): .\n - `values` (`list`): .\n\n**Returns**:\n - An attribute object that represents the `node_affinity` sub block.\n', args=[]), + new( + key, + operator, + values + ):: std.prune(a={ + key: key, + operator: operator, + values: values, + }), + }, + }, workload_metadata_config:: { '#new':: d.fn(help='\n`google.container_node_pool.node_config.workload_metadata_config.new` constructs a new object with attributes and blocks configured for the `workload_metadata_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `mode` (`string`): Mode is the configuration for how to expose metadata to workloads running on the node.\n\n**Returns**:\n - An attribute object that represents the `workload_metadata_config` sub block.\n', args=[]), new( diff --git a/4.x/_gen/resources/data_loss_prevention_deidentify_template.libsonnet b/4.x/_gen/resources/data_loss_prevention_deidentify_template.libsonnet index ed34e0b4..601e4c31 100644 --- a/4.x/_gen/resources/data_loss_prevention_deidentify_template.libsonnet +++ b/4.x/_gen/resources/data_loss_prevention_deidentify_template.libsonnet @@ -49,14 +49,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, selected_info_types:: { info_types:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.info_types.sensitivity_score.new](#fn-deidentify_configdeidentify_configimage_transformationstransformsselected_info_typessensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.new` constructs a new object with attributes and blocks configured for the `selected_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): InfoTypes to apply the transformation to. Leaving this empty will apply the transformation to apply to\nall findings that correspond to infoTypes that were requested in InspectConfig. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.info_types.new](#fn-deidentify_configdeidentify_configimage_transformationstransformsinfo_typesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `selected_info_types` sub block.\n', args=[]), new( @@ -76,14 +86,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), transformations:: { info_types:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.info_types.sensitivity_score.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationssensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.new` constructs a new object with attributes and blocks configured for the `transformations`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): InfoTypes to apply the transformation to. Leaving this empty will apply the transformation to apply to\nall findings that correspond to infoTypes that were requested in InspectConfig. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.info_types.new](#fn-deidentify_configdeidentify_configinfo_type_transformationsinfo_typesnew) constructor.\n - `primitive_transformation` (`list[obj]`): Primitive transformation to apply to the infoType.\nThe 'primitive_transformation' block must only contain one argument, corresponding to the type of transformation. When `null`, the `primitive_transformation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.new](#fn-deidentify_configdeidentify_configinfo_type_transformationsprimitive_transformationnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `transformations` sub block.\n', args=[]), new( @@ -334,16 +354,72 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); surrogate_info_type: surrogate_info_type, }), surrogate_info_type:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), new( name=null, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, }, + crypto_hash_config:: { + crypto_key:: { + kms_wrapped:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.kms_wrapped.new` constructs a new object with attributes and blocks configured for the `kms_wrapped`\nTerraform sub block.\n\n\n\n**Args**:\n - `crypto_key_name` (`string`): The resource name of the KMS CryptoKey to use for unwrapping.\n - `wrapped_key` (`string`): The wrapped data crypto key.\n\nA base64-encoded string.\n\n**Returns**:\n - An attribute object that represents the `kms_wrapped` sub block.\n', args=[]), + new( + crypto_key_name, + wrapped_key + ):: std.prune(a={ + crypto_key_name: crypto_key_name, + wrapped_key: wrapped_key, + }), + }, + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.new` constructs a new object with attributes and blocks configured for the `crypto_key`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_wrapped` (`list[obj]`): KMS wrapped key.\nInclude to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt\nFor more information, see [Creating a wrapped key](https://cloud.google.com/dlp/docs/create-wrapped-key).\nNote: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). When `null`, the `kms_wrapped` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.kms_wrapped.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configkms_wrappednew) constructor.\n - `transient` (`list[obj]`): Transient crypto key. Use this to have a random data crypto key generated. It will be discarded after the request finishes. When `null`, the `transient` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.transient.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configtransientnew) constructor.\n - `unwrapped` (`list[obj]`): Unwrapped crypto key. Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible. When `null`, the `unwrapped` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.unwrapped.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configunwrappednew) constructor.\n\n**Returns**:\n - An attribute object that represents the `crypto_key` sub block.\n', args=[]), + new( + kms_wrapped=null, + transient=null, + unwrapped=null + ):: std.prune(a={ + kms_wrapped: kms_wrapped, + transient: transient, + unwrapped: unwrapped, + }), + transient:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.transient.new` constructs a new object with attributes and blocks configured for the `transient`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the key. This is an arbitrary string used to differentiate different keys. A unique key is generated per name: two separate 'TransientCryptoKey' protos share the same generated key if their names are the same. When the data crypto key is generated, this name is not used in any way (repeating the api call will result in a different key being generated).\n\n**Returns**:\n - An attribute object that represents the `transient` sub block.\n', args=[]), + new( + name + ):: std.prune(a={ + name: name, + }), + }, + unwrapped:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.unwrapped.new` constructs a new object with attributes and blocks configured for the `unwrapped`\nTerraform sub block.\n\n\n\n**Args**:\n - `key` (`string`): A 128/192/256 bit key.\n\nA base64-encoded string.\n\n**Returns**:\n - An attribute object that represents the `unwrapped` sub block.\n', args=[]), + new( + key + ):: std.prune(a={ + key: key, + }), + }, + }, + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.new` constructs a new object with attributes and blocks configured for the `crypto_hash_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `crypto_key` (`list[obj]`): The key used by the encryption function. When `null`, the `crypto_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_keynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `crypto_hash_config` sub block.\n', args=[]), + new( + crypto_key=null + ):: std.prune(a={ + crypto_key: crypto_key, + }), + }, crypto_replace_ffx_fpe_config:: { context:: { '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.context.new` constructs a new object with attributes and blocks configured for the `context`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name describing the field. When `null`, the `name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `context` sub block.\n', args=[]), @@ -408,14 +484,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); surrogate_info_type: surrogate_info_type, }), surrogate_info_type:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), new( name=null, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, }, date_shift_config:: { @@ -510,11 +596,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.new` constructs a new object with attributes and blocks configured for the `primitive_transformation`\nTerraform sub block.\n\n\n\n**Args**:\n - `replace_with_info_type_config` (`bool`): Replace each matching finding with the name of the info type. When `null`, the `replace_with_info_type_config` field will be omitted from the resulting object.\n - `bucketing_config` (`list[obj]`): Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH\nThis can be used on data of type: number, long, string, timestamp.\nIf the provided value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing.\nSee https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. When `null`, the `bucketing_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.bucketing_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsbucketing_confignew) constructor.\n - `character_mask_config` (`list[obj]`): Partially mask a string by replacing a given number of characters with a fixed character.\nMasking can start from the beginning or end of the string. When `null`, the `character_mask_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.character_mask_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscharacter_mask_confignew) constructor.\n - `crypto_deterministic_config` (`list[obj]`): Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC [https://tools.ietf.org/html/rfc5297](https://tools.ietf.org/html/rfc5297). When `null`, the `crypto_deterministic_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_deterministic_confignew) constructor.\n - `crypto_replace_ffx_fpe_config` (`list[obj]`): Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the 'content.reidentify' API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See [https://cloud.google.com/dlp/docs/pseudonymization](https://cloud.google.com/dlp/docs/pseudonymization) to learn more.\n\nNote: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. When `null`, the `crypto_replace_ffx_fpe_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_replace_ffx_fpe_confignew) constructor.\n - `date_shift_config` (`list[obj]`): Shifts dates by random number of days, with option to be consistent for the same context. When `null`, the `date_shift_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.date_shift_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsdate_shift_confignew) constructor.\n - `fixed_size_bucketing_config` (`list[obj]`): Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies.\n\nThe transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20".\n\nThis can be used on data of type: double, long.\n\nIf the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing.\n\nSee https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. When `null`, the `fixed_size_bucketing_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.fixed_size_bucketing_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsfixed_size_bucketing_confignew) constructor.\n - `redact_config` (`list[obj]`): Redact a given value. For example, if used with an InfoTypeTransformation transforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the output would be 'My phone number is '. When `null`, the `redact_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.redact_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsredact_confignew) constructor.\n - `replace_config` (`list[obj]`): Replace each input value with a given value. When `null`, the `replace_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsreplace_confignew) constructor.\n - `replace_dictionary_config` (`list[obj]`): Replace with a value randomly drawn (with replacement) from a dictionary. When `null`, the `replace_dictionary_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsreplace_dictionary_confignew) constructor.\n - `time_part_config` (`list[obj]`): For use with Date, Timestamp, and TimeOfDay, extract or preserve a portion of the value. When `null`, the `time_part_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.time_part_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationstime_part_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `primitive_transformation` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.new` constructs a new object with attributes and blocks configured for the `primitive_transformation`\nTerraform sub block.\n\n\n\n**Args**:\n - `replace_with_info_type_config` (`bool`): Replace each matching finding with the name of the info type. When `null`, the `replace_with_info_type_config` field will be omitted from the resulting object.\n - `bucketing_config` (`list[obj]`): Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH\nThis can be used on data of type: number, long, string, timestamp.\nIf the provided value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing.\nSee https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. When `null`, the `bucketing_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.bucketing_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsbucketing_confignew) constructor.\n - `character_mask_config` (`list[obj]`): Partially mask a string by replacing a given number of characters with a fixed character.\nMasking can start from the beginning or end of the string. When `null`, the `character_mask_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.character_mask_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscharacter_mask_confignew) constructor.\n - `crypto_deterministic_config` (`list[obj]`): Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC [https://tools.ietf.org/html/rfc5297](https://tools.ietf.org/html/rfc5297). When `null`, the `crypto_deterministic_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_deterministic_confignew) constructor.\n - `crypto_hash_config` (`list[obj]`): Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes.\nOutputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=).\nCurrently, only string and integer values can be hashed.\nSee https://cloud.google.com/dlp/docs/pseudonymization to learn more. When `null`, the `crypto_hash_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_hash_confignew) constructor.\n - `crypto_replace_ffx_fpe_config` (`list[obj]`): Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the 'content.reidentify' API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See [https://cloud.google.com/dlp/docs/pseudonymization](https://cloud.google.com/dlp/docs/pseudonymization) to learn more.\n\nNote: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. When `null`, the `crypto_replace_ffx_fpe_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_replace_ffx_fpe_confignew) constructor.\n - `date_shift_config` (`list[obj]`): Shifts dates by random number of days, with option to be consistent for the same context. When `null`, the `date_shift_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.date_shift_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsdate_shift_confignew) constructor.\n - `fixed_size_bucketing_config` (`list[obj]`): Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies.\n\nThe transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20".\n\nThis can be used on data of type: double, long.\n\nIf the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing.\n\nSee https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. When `null`, the `fixed_size_bucketing_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.fixed_size_bucketing_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsfixed_size_bucketing_confignew) constructor.\n - `redact_config` (`list[obj]`): Redact a given value. For example, if used with an InfoTypeTransformation transforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the output would be 'My phone number is '. When `null`, the `redact_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.redact_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsredact_confignew) constructor.\n - `replace_config` (`list[obj]`): Replace each input value with a given value. When `null`, the `replace_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsreplace_confignew) constructor.\n - `replace_dictionary_config` (`list[obj]`): Replace with a value randomly drawn (with replacement) from a dictionary. When `null`, the `replace_dictionary_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsreplace_dictionary_confignew) constructor.\n - `time_part_config` (`list[obj]`): For use with Date, Timestamp, and TimeOfDay, extract or preserve a portion of the value. When `null`, the `time_part_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.time_part_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationstime_part_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `primitive_transformation` sub block.\n', args=[]), new( bucketing_config=null, character_mask_config=null, crypto_deterministic_config=null, + crypto_hash_config=null, crypto_replace_ffx_fpe_config=null, date_shift_config=null, fixed_size_bucketing_config=null, @@ -527,6 +614,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); bucketing_config: bucketing_config, character_mask_config: character_mask_config, crypto_deterministic_config: crypto_deterministic_config, + crypto_hash_config: crypto_hash_config, crypto_replace_ffx_fpe_config: crypto_replace_ffx_fpe_config, date_shift_config: date_shift_config, fixed_size_bucketing_config: fixed_size_bucketing_config, @@ -748,14 +836,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), transformations:: { info_types:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.info_types.sensitivity_score.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationssensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.new` constructs a new object with attributes and blocks configured for the `transformations`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): InfoTypes to apply the transformation to. Leaving this empty will apply the transformation to apply to\nall findings that correspond to infoTypes that were requested in InspectConfig. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.info_types.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsinfo_type_transformationsinfo_typesnew) constructor.\n - `primitive_transformation` (`list[obj]`): Apply the transformation to the entire field.\nThe 'primitive_transformation' block must only contain one argument, corresponding to the type of transformation. When `null`, the `primitive_transformation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsinfo_type_transformationsprimitive_transformationnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `transformations` sub block.\n', args=[]), new( @@ -1006,14 +1104,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); surrogate_info_type: surrogate_info_type, }), surrogate_info_type:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, }, crypto_hash_config:: { @@ -1126,14 +1234,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); surrogate_info_type: surrogate_info_type, }), surrogate_info_type:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, }, date_shift_config:: { @@ -1610,14 +1728,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); surrogate_info_type: surrogate_info_type, }), surrogate_info_type:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_deterministic_configsensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), new( name=null, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, }, crypto_hash_config:: { @@ -1730,14 +1858,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); surrogate_info_type: surrogate_info_type, }), surrogate_info_type:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.new` constructs a new object with attributes and blocks configured for the `surrogate_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object.\n - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_replace_ffx_fpe_configsensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `surrogate_info_type` sub block.\n', args=[]), new( name=null, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, }, date_shift_config:: { diff --git a/4.x/_gen/resources/data_loss_prevention_inspect_template.libsonnet b/4.x/_gen/resources/data_loss_prevention_inspect_template.libsonnet index 360d861c..8a59e15e 100644 --- a/4.x/_gen/resources/data_loss_prevention_inspect_template.libsonnet +++ b/4.x/_gen/resources/data_loss_prevention_inspect_template.libsonnet @@ -31,22 +31,33 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, info_type:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names\nlisted at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names\nlisted at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.sensitivity_score.new](#fn-inspect_configinspect_configcustom_info_typessensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, - '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.new` constructs a new object with attributes and blocks configured for the `custom_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `exclusion_type` (`string`): If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Possible values: ["EXCLUSION_TYPE_EXCLUDE"] When `null`, the `exclusion_type` field will be omitted from the resulting object.\n - `likelihood` (`string`): Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria\nspecified by the rule. Default value: "VERY_LIKELY" Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `likelihood` field will be omitted from the resulting object.\n - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.dictionary.new](#fn-inspect_configinspect_configdictionarynew) constructor.\n - `info_type` (`list[obj]`): CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing\ninfoTypes and that infoType is specified in 'info_types' field. Specifying the latter adds findings to the\none detected by the system. If built-in info type is not specified in 'info_types' list then the name is\ntreated as a custom info type. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.new](#fn-inspect_configinspect_configinfo_typenew) constructor.\n - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.regex.new](#fn-inspect_configinspect_configregexnew) constructor.\n - `stored_type` (`list[obj]`): A reference to a StoredInfoType to use with scanning. When `null`, the `stored_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.stored_type.new](#fn-inspect_configinspect_configstored_typenew) constructor.\n - `surrogate_type` (`list[obj]`): Message for detecting output from deidentification transformations that support reversing. When `null`, the `surrogate_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.surrogate_type.new](#fn-inspect_configinspect_configsurrogate_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.new` constructs a new object with attributes and blocks configured for the `custom_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `exclusion_type` (`string`): If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Possible values: ["EXCLUSION_TYPE_EXCLUDE"] When `null`, the `exclusion_type` field will be omitted from the resulting object.\n - `likelihood` (`string`): Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria\nspecified by the rule. Default value: "VERY_LIKELY" Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `likelihood` field will be omitted from the resulting object.\n - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.dictionary.new](#fn-inspect_configinspect_configdictionarynew) constructor.\n - `info_type` (`list[obj]`): CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing\ninfoTypes and that infoType is specified in 'info_types' field. Specifying the latter adds findings to the\none detected by the system. If built-in info type is not specified in 'info_types' list then the name is\ntreated as a custom info type. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.new](#fn-inspect_configinspect_configinfo_typenew) constructor.\n - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.regex.new](#fn-inspect_configinspect_configregexnew) constructor.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.sensitivity_score.new](#fn-inspect_configinspect_configsensitivity_scorenew) constructor.\n - `stored_type` (`list[obj]`): A reference to a StoredInfoType to use with scanning. When `null`, the `stored_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.stored_type.new](#fn-inspect_configinspect_configstored_typenew) constructor.\n - `surrogate_type` (`list[obj]`): Message for detecting output from deidentification transformations that support reversing. When `null`, the `surrogate_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.surrogate_type.new](#fn-inspect_configinspect_configsurrogate_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_info_types` sub block.\n', args=[]), new( dictionary=null, exclusion_type=null, info_type=null, likelihood=null, regex=null, + sensitivity_score=null, stored_type=null, surrogate_type=null ):: std.prune(a={ @@ -55,6 +66,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); info_type: info_type, likelihood: likelihood, regex: regex, + sensitivity_score: sensitivity_score, stored_type: stored_type, surrogate_type: surrogate_type, }), @@ -68,6 +80,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); pattern: pattern, }), }, + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, stored_type:: { '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.stored_type.new` constructs a new object with attributes and blocks configured for the `stored_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Resource name of the requested StoredInfoType, for example 'organizations/433245324/storedInfoTypes/432452342'\nor 'projects/project-id/storedInfoTypes/432452342'.\n\n**Returns**:\n - An attribute object that represents the `stored_type` sub block.\n', args=[]), new( @@ -84,26 +104,46 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, info_types:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.info_types.sensitivity_score.new](#fn-inspect_configinspect_configsensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, limits:: { max_findings_per_info_type:: { info_type:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score.new](#fn-inspect_configinspect_configlimitsmax_findings_per_info_typesensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.new` constructs a new object with attributes and blocks configured for the `max_findings_per_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_findings` (`number`): Max findings limit for the given infoType.\n - `info_type` (`list[obj]`): Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does\nnot have an infoType, the DLP API applies the limit against all infoTypes that are found but not\nspecified in another InfoTypeLimit. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.info_type.new](#fn-inspect_configinspect_configlimitsinfo_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `max_findings_per_info_type` sub block.\n', args=[]), new( @@ -147,14 +187,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), rule_set:: { info_types:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.rule_set.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.rule_set.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.rule_set.info_types.sensitivity_score.new](#fn-inspect_configinspect_configrule_setsensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.rule_set.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.rule_set.new` constructs a new object with attributes and blocks configured for the `rule_set`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): List of infoTypes this rule set is applied to. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.rule_set.info_types.new](#fn-inspect_configinspect_configinfo_typesnew) constructor.\n - `rules` (`list[obj]`): Set of rules to be applied to infoTypes. The rules are applied in order. When `null`, the `rules` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.rule_set.rules.new](#fn-inspect_configinspect_configrulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rule_set` sub block.\n', args=[]), new( @@ -224,14 +274,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, exclude_info_types:: { info_types:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score.new](#fn-inspect_configinspect_configrule_setrulesexclusion_ruleexclude_info_typessensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, '#new':: d.fn(help='\n`google.data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.new` constructs a new object with attributes and blocks configured for the `exclude_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): If a finding is matched by any of the infoType detectors listed here, the finding will be excluded from the scan results. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new](#fn-inspect_configinspect_configrule_setrulesexclusion_ruleinfo_typesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `exclude_info_types` sub block.\n', args=[]), new( diff --git a/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet b/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet index f1afba6e..43285947 100644 --- a/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet +++ b/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet @@ -160,22 +160,33 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, info_type:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names\nlisted at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names\nlisted at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configcustom_info_typessensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, - '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.new` constructs a new object with attributes and blocks configured for the `custom_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `exclusion_type` (`string`): If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Possible values: ["EXCLUSION_TYPE_EXCLUDE"] When `null`, the `exclusion_type` field will be omitted from the resulting object.\n - `likelihood` (`string`): Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria\nspecified by the rule. Default value: "VERY_LIKELY" Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `likelihood` field will be omitted from the resulting object.\n - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.new](#fn-inspect_jobinspect_jobinspect_configdictionarynew) constructor.\n - `info_type` (`list[obj]`): CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing\ninfoTypes and that infoType is specified in 'info_types' field. Specifying the latter adds findings to the\none detected by the system. If built-in info type is not specified in 'info_types' list then the name is\ntreated as a custom info type. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.new](#fn-inspect_jobinspect_jobinspect_configinfo_typenew) constructor.\n - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.regex.new](#fn-inspect_jobinspect_jobinspect_configregexnew) constructor.\n - `stored_type` (`list[obj]`): A reference to a StoredInfoType to use with scanning. When `null`, the `stored_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.stored_type.new](#fn-inspect_jobinspect_jobinspect_configstored_typenew) constructor.\n - `surrogate_type` (`list[obj]`): Message for detecting output from deidentification transformations that support reversing. When `null`, the `surrogate_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.surrogate_type.new](#fn-inspect_jobinspect_jobinspect_configsurrogate_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.new` constructs a new object with attributes and blocks configured for the `custom_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `exclusion_type` (`string`): If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Possible values: ["EXCLUSION_TYPE_EXCLUDE"] When `null`, the `exclusion_type` field will be omitted from the resulting object.\n - `likelihood` (`string`): Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria\nspecified by the rule. Default value: "VERY_LIKELY" Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `likelihood` field will be omitted from the resulting object.\n - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.new](#fn-inspect_jobinspect_jobinspect_configdictionarynew) constructor.\n - `info_type` (`list[obj]`): CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing\ninfoTypes and that infoType is specified in 'info_types' field. Specifying the latter adds findings to the\none detected by the system. If built-in info type is not specified in 'info_types' list then the name is\ntreated as a custom info type. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.new](#fn-inspect_jobinspect_jobinspect_configinfo_typenew) constructor.\n - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.regex.new](#fn-inspect_jobinspect_jobinspect_configregexnew) constructor.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configsensitivity_scorenew) constructor.\n - `stored_type` (`list[obj]`): A reference to a StoredInfoType to use with scanning. When `null`, the `stored_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.stored_type.new](#fn-inspect_jobinspect_jobinspect_configstored_typenew) constructor.\n - `surrogate_type` (`list[obj]`): Message for detecting output from deidentification transformations that support reversing. When `null`, the `surrogate_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.surrogate_type.new](#fn-inspect_jobinspect_jobinspect_configsurrogate_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_info_types` sub block.\n', args=[]), new( dictionary=null, exclusion_type=null, info_type=null, likelihood=null, regex=null, + sensitivity_score=null, stored_type=null, surrogate_type=null ):: std.prune(a={ @@ -184,6 +195,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); info_type: info_type, likelihood: likelihood, regex: regex, + sensitivity_score: sensitivity_score, stored_type: stored_type, surrogate_type: surrogate_type, }), @@ -197,6 +209,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); pattern: pattern, }), }, + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, stored_type:: { '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.stored_type.new` constructs a new object with attributes and blocks configured for the `stored_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Resource name of the requested StoredInfoType, for example 'organizations/433245324/storedInfoTypes/432452342'\nor 'projects/project-id/storedInfoTypes/432452342'.\n\n**Returns**:\n - An attribute object that represents the `stored_type` sub block.\n', args=[]), new( @@ -213,26 +233,46 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, info_types:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.info_types.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configsensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, limits:: { max_findings_per_info_type:: { info_type:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configlimitsmax_findings_per_info_typesensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.new` constructs a new object with attributes and blocks configured for the `max_findings_per_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_findings` (`number`): Max findings limit for the given infoType. When `null`, the `max_findings` field will be omitted from the resulting object.\n - `info_type` (`list[obj]`): Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does\nnot have an infoType, the DLP API applies the limit against all infoTypes that are found but not\nspecified in another InfoTypeLimit. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.new](#fn-inspect_jobinspect_jobinspect_configlimitsinfo_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `max_findings_per_info_type` sub block.\n', args=[]), new( @@ -274,14 +314,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), rule_set:: { info_types:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.info_types.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configrule_setsensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.new` constructs a new object with attributes and blocks configured for the `rule_set`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): List of infoTypes this rule set is applied to. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.info_types.new](#fn-inspect_jobinspect_jobinspect_configinfo_typesnew) constructor.\n - `rules` (`list[obj]`): Set of rules to be applied to infoTypes. The rules are applied in order. When `null`, the `rules` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.new](#fn-inspect_jobinspect_jobinspect_configrulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rule_set` sub block.\n', args=[]), new( @@ -351,14 +401,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, exclude_info_types:: { info_types:: { - '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object.\n - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_ruleexclude_info_typessensitivity_scorenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( name, + sensitivity_score=null, version=null ):: std.prune(a={ name: name, + sensitivity_score: sensitivity_score, version: version, }), + sensitivity_score:: { + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score`\nTerraform sub block.\n\n\n\n**Args**:\n - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"]\n\n**Returns**:\n - An attribute object that represents the `sensitivity_score` sub block.\n', args=[]), + new( + score + ):: std.prune(a={ + score: score, + }), + }, }, '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.new` constructs a new object with attributes and blocks configured for the `exclude_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): If a finding is matched by any of the infoType detectors listed here, the finding will be excluded from the scan results. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_ruleinfo_typesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `exclude_info_types` sub block.\n', args=[]), new( @@ -445,11 +505,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, - '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.new` constructs a new object with attributes and blocks configured for the `inspect_job`\nTerraform sub block.\n\n\n\n**Args**:\n - `inspect_template_name` (`string`): The name of the template to run when this job is triggered.\n - `actions` (`list[obj]`): A task to execute on the completion of a job. When `null`, the `actions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.new](#fn-inspect_jobactionsnew) constructor.\n - `inspect_config` (`list[obj]`): The core content of the template. When `null`, the `inspect_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.new](#fn-inspect_jobinspect_confignew) constructor.\n - `storage_config` (`list[obj]`): Information on where to inspect When `null`, the `storage_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.new](#fn-inspect_jobstorage_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `inspect_job` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.new` constructs a new object with attributes and blocks configured for the `inspect_job`\nTerraform sub block.\n\n\n\n**Args**:\n - `inspect_template_name` (`string`): The name of the template to run when this job is triggered. When `null`, the `inspect_template_name` field will be omitted from the resulting object.\n - `actions` (`list[obj]`): A task to execute on the completion of a job. When `null`, the `actions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.new](#fn-inspect_jobactionsnew) constructor.\n - `inspect_config` (`list[obj]`): The core content of the template. When `null`, the `inspect_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.new](#fn-inspect_jobinspect_confignew) constructor.\n - `storage_config` (`list[obj]`): Information on where to inspect When `null`, the `storage_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.new](#fn-inspect_jobstorage_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `inspect_job` sub block.\n', args=[]), new( - inspect_template_name, actions=null, inspect_config=null, + inspect_template_name=null, storage_config=null ):: std.prune(a={ actions: actions, @@ -537,7 +597,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.storage_config.cloud_storage_options.new` constructs a new object with attributes and blocks configured for the `cloud_storage_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `bytes_limit_per_file` (`number`): Max number of bytes to scan from a file. If a scanned file's size is bigger than this value\nthen the rest of the bytes are omitted. When `null`, the `bytes_limit_per_file` field will be omitted from the resulting object.\n - `bytes_limit_per_file_percent` (`number`): Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down.\nMust be between 0 and 100, inclusively. Both 0 and 100 means no limit. When `null`, the `bytes_limit_per_file_percent` field will be omitted from the resulting object.\n - `file_types` (`list`): List of file type groups to include in the scan. If empty, all files are scanned and available data\nformat processors are applied. In addition, the binary content of the selected files is always scanned as well.\nImages are scanned only as binary if the specified region does not support image inspection and no fileTypes were specified. Possible values: ["BINARY_FILE", "TEXT_FILE", "IMAGE", "WORD", "PDF", "AVRO", "CSV", "TSV"] When `null`, the `file_types` field will be omitted from the resulting object.\n - `files_limit_percent` (`number`): Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down.\nMust be between 0 and 100, inclusively. Both 0 and 100 means no limit. When `null`, the `files_limit_percent` field will be omitted from the resulting object.\n - `sample_method` (`string`): How to sample bytes if not all bytes are scanned. Meaningful only when used in conjunction with bytesLimitPerFile.\nIf not specified, scanning would start from the top. Possible values: ["TOP", "RANDOM_START"] When `null`, the `sample_method` field will be omitted from the resulting object.\n - `file_set` (`list[obj]`): Set of files to scan. When `null`, the `file_set` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.cloud_storage_options.file_set.new](#fn-inspect_jobinspect_jobstorage_configfile_setnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `cloud_storage_options` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.data_loss_prevention_job_trigger.inspect_job.storage_config.cloud_storage_options.new` constructs a new object with attributes and blocks configured for the `cloud_storage_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `bytes_limit_per_file` (`number`): Max number of bytes to scan from a file. If a scanned file's size is bigger than this value\nthen the rest of the bytes are omitted. When `null`, the `bytes_limit_per_file` field will be omitted from the resulting object.\n - `bytes_limit_per_file_percent` (`number`): Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down.\nMust be between 0 and 100, inclusively. Both 0 and 100 means no limit. When `null`, the `bytes_limit_per_file_percent` field will be omitted from the resulting object.\n - `file_types` (`list`): List of file type groups to include in the scan. If empty, all files are scanned and available data\nformat processors are applied. In addition, the binary content of the selected files is always scanned as well.\nImages are scanned only as binary if the specified region does not support image inspection and no fileTypes were specified. Possible values: ["BINARY_FILE", "TEXT_FILE", "IMAGE", "WORD", "PDF", "AVRO", "CSV", "TSV", "POWERPOINT", "EXCEL"] When `null`, the `file_types` field will be omitted from the resulting object.\n - `files_limit_percent` (`number`): Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down.\nMust be between 0 and 100, inclusively. Both 0 and 100 means no limit. When `null`, the `files_limit_percent` field will be omitted from the resulting object.\n - `sample_method` (`string`): How to sample bytes if not all bytes are scanned. Meaningful only when used in conjunction with bytesLimitPerFile.\nIf not specified, scanning would start from the top. Possible values: ["TOP", "RANDOM_START"] When `null`, the `sample_method` field will be omitted from the resulting object.\n - `file_set` (`list[obj]`): Set of files to scan. When `null`, the `file_set` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.cloud_storage_options.file_set.new](#fn-inspect_jobinspect_jobstorage_configfile_setnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `cloud_storage_options` sub block.\n', args=[]), new( bytes_limit_per_file=null, bytes_limit_per_file_percent=null, @@ -650,7 +710,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, - '#new':: d.fn(help="\n`google.data_loss_prevention_job_trigger.new` injects a new `google_data_loss_prevention_job_trigger` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.data_loss_prevention_job_trigger.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data_loss_prevention_job_trigger` using the reference:\n\n $._ref.google_data_loss_prevention_job_trigger.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_data_loss_prevention_job_trigger.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): A description of the job trigger. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): User set display name of the job trigger. When `null`, the `display_name` field will be omitted from the resulting object.\n - `parent` (`string`): The parent of the trigger, either in the format \u0026#39;projects/{{project}}\u0026#39;\nor \u0026#39;projects/{{project}}/locations/{{location}}\u0026#39;\n - `status` (`string`): Whether the trigger is currently active. Default value: \u0026#34;HEALTHY\u0026#34; Possible values: [\u0026#34;PAUSED\u0026#34;, \u0026#34;HEALTHY\u0026#34;, \u0026#34;CANCELLED\u0026#34;] When `null`, the `status` field will be omitted from the resulting object.\n - `inspect_job` (`list[obj]`): Controls what and how to inspect for findings. When `null`, the `inspect_job` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.new](#fn-inspect_jobnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.timeouts.new](#fn-timeoutsnew) constructor.\n - `triggers` (`list[obj]`): What event needs to occur for a new job to be started. When `null`, the `triggers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.triggers.new](#fn-triggersnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google.data_loss_prevention_job_trigger.new` injects a new `google_data_loss_prevention_job_trigger` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.data_loss_prevention_job_trigger.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data_loss_prevention_job_trigger` using the reference:\n\n $._ref.google_data_loss_prevention_job_trigger.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_data_loss_prevention_job_trigger.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): A description of the job trigger. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): User set display name of the job trigger. When `null`, the `display_name` field will be omitted from the resulting object.\n - `parent` (`string`): The parent of the trigger, either in the format \u0026#39;projects/{{project}}\u0026#39;\nor \u0026#39;projects/{{project}}/locations/{{location}}\u0026#39;\n - `status` (`string`): Whether the trigger is currently active. Default value: \u0026#34;HEALTHY\u0026#34; Possible values: [\u0026#34;PAUSED\u0026#34;, \u0026#34;HEALTHY\u0026#34;, \u0026#34;CANCELLED\u0026#34;] When `null`, the `status` field will be omitted from the resulting object.\n - `trigger_id` (`string`): The trigger id can contain uppercase and lowercase letters, numbers, and hyphens;\nthat is, it must match the regular expression: [a-zA-Z\\d-_]\u0026#43;.\nThe maximum length is 100 characters. Can be empty to allow the system to generate one. When `null`, the `trigger_id` field will be omitted from the resulting object.\n - `inspect_job` (`list[obj]`): Controls what and how to inspect for findings. When `null`, the `inspect_job` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.new](#fn-inspect_jobnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.timeouts.new](#fn-timeoutsnew) constructor.\n - `triggers` (`list[obj]`): What event needs to occur for a new job to be started. When `null`, the `triggers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.triggers.new](#fn-triggersnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, parent, @@ -659,6 +719,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); inspect_job=null, status=null, timeouts=null, + trigger_id=null, triggers=null, _meta={} ):: tf.withResource( @@ -671,11 +732,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); parent=parent, status=status, timeouts=timeouts, + trigger_id=trigger_id, triggers=triggers ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.data_loss_prevention_job_trigger.newAttrs` constructs a new object with attributes and blocks configured for the `data_loss_prevention_job_trigger`\nTerraform resource.\n\nUnlike [google.data_loss_prevention_job_trigger.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): A description of the job trigger. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): User set display name of the job trigger. When `null`, the `display_name` field will be omitted from the resulting object.\n - `parent` (`string`): The parent of the trigger, either in the format 'projects/{{project}}'\nor 'projects/{{project}}/locations/{{location}}'\n - `status` (`string`): Whether the trigger is currently active. Default value: "HEALTHY" Possible values: ["PAUSED", "HEALTHY", "CANCELLED"] When `null`, the `status` field will be omitted from the resulting object.\n - `inspect_job` (`list[obj]`): Controls what and how to inspect for findings. When `null`, the `inspect_job` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.new](#fn-inspect_jobnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.timeouts.new](#fn-timeoutsnew) constructor.\n - `triggers` (`list[obj]`): What event needs to occur for a new job to be started. When `null`, the `triggers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.triggers.new](#fn-triggersnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `data_loss_prevention_job_trigger` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.data_loss_prevention_job_trigger.newAttrs` constructs a new object with attributes and blocks configured for the `data_loss_prevention_job_trigger`\nTerraform resource.\n\nUnlike [google.data_loss_prevention_job_trigger.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): A description of the job trigger. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): User set display name of the job trigger. When `null`, the `display_name` field will be omitted from the resulting object.\n - `parent` (`string`): The parent of the trigger, either in the format 'projects/{{project}}'\nor 'projects/{{project}}/locations/{{location}}'\n - `status` (`string`): Whether the trigger is currently active. Default value: "HEALTHY" Possible values: ["PAUSED", "HEALTHY", "CANCELLED"] When `null`, the `status` field will be omitted from the resulting object.\n - `trigger_id` (`string`): The trigger id can contain uppercase and lowercase letters, numbers, and hyphens;\nthat is, it must match the regular expression: [a-zA-Z\\d-_]+.\nThe maximum length is 100 characters. Can be empty to allow the system to generate one. When `null`, the `trigger_id` field will be omitted from the resulting object.\n - `inspect_job` (`list[obj]`): Controls what and how to inspect for findings. When `null`, the `inspect_job` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.new](#fn-inspect_jobnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.timeouts.new](#fn-timeoutsnew) constructor.\n - `triggers` (`list[obj]`): What event needs to occur for a new job to be started. When `null`, the `triggers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.triggers.new](#fn-triggersnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `data_loss_prevention_job_trigger` resource into the root Terraform configuration.\n', args=[]), newAttrs( parent, description=null, @@ -683,6 +745,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); inspect_job=null, status=null, timeouts=null, + trigger_id=null, triggers=null ):: std.prune(a={ description: description, @@ -691,6 +754,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); parent: parent, status: status, timeouts: timeouts, + trigger_id: trigger_id, triggers: triggers, }), timeouts:: { @@ -809,6 +873,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withTriggerId':: d.fn(help='`google.string.withTriggerId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the trigger_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `trigger_id` field.\n', args=[]), + withTriggerId(resourceLabel, value): { + resource+: { + google_data_loss_prevention_job_trigger+: { + [resourceLabel]+: { + trigger_id: value, + }, + }, + }, + }, '#withTriggers':: d.fn(help='`google.list[obj].withTriggers` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the triggers field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withTriggersMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `triggers` field.\n', args=[]), withTriggers(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/pubsub_schema.libsonnet b/4.x/_gen/resources/pubsub_schema.libsonnet index c0bcc7b1..b2eaed5d 100644 --- a/4.x/_gen/resources/pubsub_schema.libsonnet +++ b/4.x/_gen/resources/pubsub_schema.libsonnet @@ -38,13 +38,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type: type, }), timeouts:: { - '#new':: d.fn(help='\n`google.pubsub_schema.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.pubsub_schema.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, - delete=null + delete=null, + update=null ):: std.prune(a={ create: create, delete: delete, + update: update, }), }, '#withDefinition':: d.fn(help='`google.string.withDefinition` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the definition field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `definition` field.\n', args=[]), diff --git a/4.x/_gen/resources/sql_database_instance.libsonnet b/4.x/_gen/resources/sql_database_instance.libsonnet index 47839fac..08deeaa0 100644 --- a/4.x/_gen/resources/sql_database_instance.libsonnet +++ b/4.x/_gen/resources/sql_database_instance.libsonnet @@ -16,7 +16,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); source_instance_name: source_instance_name, }), }, - '#new':: d.fn(help="\n`google.sql_database_instance.new` injects a new `google_sql_database_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.sql_database_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.sql_database_instance` using the reference:\n\n $._ref.google_sql_database_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_sql_database_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `database_version` (`string`): The MySQL, PostgreSQL or SQL Server (beta) version to use. Supported values include MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB. Database Version Policies includes an up-to-date reference of supported versions.\n - `deletion_protection` (`bool`): Used to block Terraform from deleting a SQL Instance. Defaults to true. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `encryption_key_name` (`string`): Set the `encryption_key_name` field on the resulting resource block. When `null`, the `encryption_key_name` field will be omitted from the resulting object.\n - `instance_type` (`string`): The type of the instance. The valid values are:- \u0026#39;SQL_INSTANCE_TYPE_UNSPECIFIED\u0026#39;, \u0026#39;CLOUD_SQL_INSTANCE\u0026#39;, \u0026#39;ON_PREMISES_INSTANCE\u0026#39; and \u0026#39;READ_REPLICA_INSTANCE\u0026#39;. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `maintenance_version` (`string`): Maintenance version. When `null`, the `maintenance_version` field will be omitted from the resulting object.\n - `master_instance_name` (`string`): The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binary_log_enabled set, as well as existing backups. When `null`, the `master_instance_name` field will be omitted from the resulting object.\n - `name` (`string`): The name of the instance. If the name is left blank, Terraform will randomly generate one when the instance is first created. This is done because after a name is used, it cannot be reused for up to one week. When `null`, the `name` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The region the instance will sit in. Note, Cloud SQL is not available in all regions. A valid region must be provided to use this resource. If a region is not provided in the resource definition, the provider region will be used instead, but this will be an apply-time error for instances if the provider region is not supported with Cloud SQL. If you choose not to provide the region argument for this resource, make sure you understand this. When `null`, the `region` field will be omitted from the resulting object.\n - `root_password` (`string`): Initial root password. Required for MS SQL Server. When `null`, the `root_password` field will be omitted from the resulting object.\n - `clone` (`list[obj]`): Configuration for creating a new instance as a clone of another instance. When `null`, the `clone` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.clone.new](#fn-clonenew) constructor.\n - `replica_configuration` (`list[obj]`): The configuration for replication. When `null`, the `replica_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.replica_configuration.new](#fn-replica_configurationnew) constructor.\n - `restore_backup_context` (`list[obj]`): Set the `restore_backup_context` field on the resulting resource block. When `null`, the `restore_backup_context` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.restore_backup_context.new](#fn-restore_backup_contextnew) constructor.\n - `settings` (`list[obj]`): The settings to use for the database. The configuration is detailed below. When `null`, the `settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.settings.new](#fn-settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google.sql_database_instance.new` injects a new `google_sql_database_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.sql_database_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.sql_database_instance` using the reference:\n\n $._ref.google_sql_database_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_sql_database_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `database_version` (`string`): The MySQL, PostgreSQL or SQL Server (beta) version to use. Supported values include MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, POSTGRES_15, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB. Database Version Policies includes an up-to-date reference of supported versions.\n - `deletion_protection` (`bool`): Used to block Terraform from deleting a SQL Instance. Defaults to true. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `encryption_key_name` (`string`): Set the `encryption_key_name` field on the resulting resource block. When `null`, the `encryption_key_name` field will be omitted from the resulting object.\n - `instance_type` (`string`): The type of the instance. The valid values are:- \u0026#39;SQL_INSTANCE_TYPE_UNSPECIFIED\u0026#39;, \u0026#39;CLOUD_SQL_INSTANCE\u0026#39;, \u0026#39;ON_PREMISES_INSTANCE\u0026#39; and \u0026#39;READ_REPLICA_INSTANCE\u0026#39;. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `maintenance_version` (`string`): Maintenance version. When `null`, the `maintenance_version` field will be omitted from the resulting object.\n - `master_instance_name` (`string`): The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binary_log_enabled set, as well as existing backups. When `null`, the `master_instance_name` field will be omitted from the resulting object.\n - `name` (`string`): The name of the instance. If the name is left blank, Terraform will randomly generate one when the instance is first created. This is done because after a name is used, it cannot be reused for up to one week. When `null`, the `name` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The region the instance will sit in. Note, Cloud SQL is not available in all regions. A valid region must be provided to use this resource. If a region is not provided in the resource definition, the provider region will be used instead, but this will be an apply-time error for instances if the provider region is not supported with Cloud SQL. If you choose not to provide the region argument for this resource, make sure you understand this. When `null`, the `region` field will be omitted from the resulting object.\n - `root_password` (`string`): Initial root password. Required for MS SQL Server. When `null`, the `root_password` field will be omitted from the resulting object.\n - `clone` (`list[obj]`): Configuration for creating a new instance as a clone of another instance. When `null`, the `clone` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.clone.new](#fn-clonenew) constructor.\n - `replica_configuration` (`list[obj]`): The configuration for replication. When `null`, the `replica_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.replica_configuration.new](#fn-replica_configurationnew) constructor.\n - `restore_backup_context` (`list[obj]`): Set the `restore_backup_context` field on the resulting resource block. When `null`, the `restore_backup_context` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.restore_backup_context.new](#fn-restore_backup_contextnew) constructor.\n - `settings` (`list[obj]`): The settings to use for the database. The configuration is detailed below. When `null`, the `settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.settings.new](#fn-settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, database_version, @@ -57,7 +57,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.sql_database_instance.newAttrs` constructs a new object with attributes and blocks configured for the `sql_database_instance`\nTerraform resource.\n\nUnlike [google.sql_database_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `database_version` (`string`): The MySQL, PostgreSQL or SQL Server (beta) version to use. Supported values include MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB. Database Version Policies includes an up-to-date reference of supported versions.\n - `deletion_protection` (`bool`): Used to block Terraform from deleting a SQL Instance. Defaults to true. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `encryption_key_name` (`string`): Set the `encryption_key_name` field on the resulting object. When `null`, the `encryption_key_name` field will be omitted from the resulting object.\n - `instance_type` (`string`): The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `maintenance_version` (`string`): Maintenance version. When `null`, the `maintenance_version` field will be omitted from the resulting object.\n - `master_instance_name` (`string`): The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binary_log_enabled set, as well as existing backups. When `null`, the `master_instance_name` field will be omitted from the resulting object.\n - `name` (`string`): The name of the instance. If the name is left blank, Terraform will randomly generate one when the instance is first created. This is done because after a name is used, it cannot be reused for up to one week. When `null`, the `name` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The region the instance will sit in. Note, Cloud SQL is not available in all regions. A valid region must be provided to use this resource. If a region is not provided in the resource definition, the provider region will be used instead, but this will be an apply-time error for instances if the provider region is not supported with Cloud SQL. If you choose not to provide the region argument for this resource, make sure you understand this. When `null`, the `region` field will be omitted from the resulting object.\n - `root_password` (`string`): Initial root password. Required for MS SQL Server. When `null`, the `root_password` field will be omitted from the resulting object.\n - `clone` (`list[obj]`): Configuration for creating a new instance as a clone of another instance. When `null`, the `clone` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.clone.new](#fn-clonenew) constructor.\n - `replica_configuration` (`list[obj]`): The configuration for replication. When `null`, the `replica_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.replica_configuration.new](#fn-replica_configurationnew) constructor.\n - `restore_backup_context` (`list[obj]`): Set the `restore_backup_context` field on the resulting object. When `null`, the `restore_backup_context` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.restore_backup_context.new](#fn-restore_backup_contextnew) constructor.\n - `settings` (`list[obj]`): The settings to use for the database. The configuration is detailed below. When `null`, the `settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.settings.new](#fn-settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `sql_database_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.sql_database_instance.newAttrs` constructs a new object with attributes and blocks configured for the `sql_database_instance`\nTerraform resource.\n\nUnlike [google.sql_database_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `database_version` (`string`): The MySQL, PostgreSQL or SQL Server (beta) version to use. Supported values include MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, POSTGRES_15, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB. Database Version Policies includes an up-to-date reference of supported versions.\n - `deletion_protection` (`bool`): Used to block Terraform from deleting a SQL Instance. Defaults to true. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `encryption_key_name` (`string`): Set the `encryption_key_name` field on the resulting object. When `null`, the `encryption_key_name` field will be omitted from the resulting object.\n - `instance_type` (`string`): The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `maintenance_version` (`string`): Maintenance version. When `null`, the `maintenance_version` field will be omitted from the resulting object.\n - `master_instance_name` (`string`): The name of the instance that will act as the master in the replication setup. Note, this requires the master to have binary_log_enabled set, as well as existing backups. When `null`, the `master_instance_name` field will be omitted from the resulting object.\n - `name` (`string`): The name of the instance. If the name is left blank, Terraform will randomly generate one when the instance is first created. This is done because after a name is used, it cannot be reused for up to one week. When `null`, the `name` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The region the instance will sit in. Note, Cloud SQL is not available in all regions. A valid region must be provided to use this resource. If a region is not provided in the resource definition, the provider region will be used instead, but this will be an apply-time error for instances if the provider region is not supported with Cloud SQL. If you choose not to provide the region argument for this resource, make sure you understand this. When `null`, the `region` field will be omitted from the resulting object.\n - `root_password` (`string`): Initial root password. Required for MS SQL Server. When `null`, the `root_password` field will be omitted from the resulting object.\n - `clone` (`list[obj]`): Configuration for creating a new instance as a clone of another instance. When `null`, the `clone` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.clone.new](#fn-clonenew) constructor.\n - `replica_configuration` (`list[obj]`): The configuration for replication. When `null`, the `replica_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.replica_configuration.new](#fn-replica_configurationnew) constructor.\n - `restore_backup_context` (`list[obj]`): Set the `restore_backup_context` field on the resulting object. When `null`, the `restore_backup_context` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.restore_backup_context.new](#fn-restore_backup_contextnew) constructor.\n - `settings` (`list[obj]`): The settings to use for the database. The configuration is detailed below. When `null`, the `settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.settings.new](#fn-settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `sql_database_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( database_version, clone=null, diff --git a/4.x/_gen/resources/vertex_ai_index_endpoint.libsonnet b/4.x/_gen/resources/vertex_ai_index_endpoint.libsonnet new file mode 100644 index 00000000..1e1a45ee --- /dev/null +++ b/4.x/_gen/resources/vertex_ai_index_endpoint.libsonnet @@ -0,0 +1,140 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='vertex_ai_index_endpoint', url='', help='`vertex_ai_index_endpoint` represents the `google_vertex_ai_index_endpoint` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google.vertex_ai_index_endpoint.new` injects a new `google_vertex_ai_index_endpoint` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.vertex_ai_index_endpoint.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.vertex_ai_index_endpoint` using the reference:\n\n $._ref.google_vertex_ai_index_endpoint.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_vertex_ai_index_endpoint.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): The description of the Index. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n - `labels` (`obj`): The labels with user-defined metadata to organize your Indexes. When `null`, the `labels` field will be omitted from the resulting object.\n - `network` (`string`): The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the index endpoint should be peered.\nPrivate services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network.\n[Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): \u0026#39;projects/{project}/global/networks/{network}\u0026#39;.\nWhere \u0026#39;{project}\u0026#39; is a project number, as in \u0026#39;12345\u0026#39;, and \u0026#39;{network}\u0026#39; is network name. When `null`, the `network` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The region of the index endpoint. eg us-central1 When `null`, the `region` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.vertex_ai_index_endpoint.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + display_name, + description=null, + labels=null, + network=null, + project=null, + region=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_vertex_ai_index_endpoint', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + display_name=display_name, + labels=labels, + network=network, + project=project, + region=region, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.vertex_ai_index_endpoint.newAttrs` constructs a new object with attributes and blocks configured for the `vertex_ai_index_endpoint`\nTerraform resource.\n\nUnlike [google.vertex_ai_index_endpoint.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): The description of the Index. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n - `labels` (`obj`): The labels with user-defined metadata to organize your Indexes. When `null`, the `labels` field will be omitted from the resulting object.\n - `network` (`string`): The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the index endpoint should be peered.\nPrivate services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network.\n[Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): 'projects/{project}/global/networks/{network}'.\nWhere '{project}' is a project number, as in '12345', and '{network}' is network name. When `null`, the `network` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The region of the index endpoint. eg us-central1 When `null`, the `region` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.vertex_ai_index_endpoint.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `vertex_ai_index_endpoint` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + display_name, + description=null, + labels=null, + network=null, + project=null, + region=null, + timeouts=null + ):: std.prune(a={ + description: description, + display_name: display_name, + labels: labels, + network: network, + project: project, + region: region, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.vertex_ai_index_endpoint.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#withDescription':: d.fn(help='`google.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + google_vertex_ai_index_endpoint+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withDisplayName':: d.fn(help='`google.string.withDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the display_name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `display_name` field.\n', args=[]), + withDisplayName(resourceLabel, value): { + resource+: { + google_vertex_ai_index_endpoint+: { + [resourceLabel]+: { + display_name: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google.obj.withLabels` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the labels field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `labels` field.\n', args=[]), + withLabels(resourceLabel, value): { + resource+: { + google_vertex_ai_index_endpoint+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withNetwork':: d.fn(help='`google.string.withNetwork` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the network field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `network` field.\n', args=[]), + withNetwork(resourceLabel, value): { + resource+: { + google_vertex_ai_index_endpoint+: { + [resourceLabel]+: { + network: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_vertex_ai_index_endpoint+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRegion':: d.fn(help='`google.string.withRegion` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the region field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `region` field.\n', args=[]), + withRegion(resourceLabel, value): { + resource+: { + google_vertex_ai_index_endpoint+: { + [resourceLabel]+: { + region: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_vertex_ai_index_endpoint+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_vertex_ai_index_endpoint+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/docs/4.x/README.md b/docs/4.x/README.md index d235d5ca..715d1223 100644 --- a/docs/4.x/README.md +++ b/docs/4.x/README.md @@ -213,6 +213,7 @@ project. * [compute_network](compute_network.md) * [compute_network_endpoint](compute_network_endpoint.md) * [compute_network_endpoint_group](compute_network_endpoint_group.md) +* [compute_network_endpoints](compute_network_endpoints.md) * [compute_network_firewall_policy](compute_network_firewall_policy.md) * [compute_network_firewall_policy_association](compute_network_firewall_policy_association.md) * [compute_network_firewall_policy_rule](compute_network_firewall_policy_rule.md) @@ -648,6 +649,7 @@ project. * [vertex_ai_featurestore_entitytype](vertex_ai_featurestore_entitytype.md) * [vertex_ai_featurestore_entitytype_feature](vertex_ai_featurestore_entitytype_feature.md) * [vertex_ai_index](vertex_ai_index.md) +* [vertex_ai_index_endpoint](vertex_ai_index_endpoint.md) * [vertex_ai_tensorboard](vertex_ai_tensorboard.md) * [vpc_access_connector](vpc_access_connector.md) * [workflows_workflow](workflows_workflow.md) \ No newline at end of file diff --git a/docs/4.x/bigtable_gc_policy.md b/docs/4.x/bigtable_gc_policy.md index c2b61cf0..b55f550b 100644 --- a/docs/4.x/bigtable_gc_policy.md +++ b/docs/4.x/bigtable_gc_policy.md @@ -26,10 +26,14 @@ This package contains functions and utilities for setting up the resource using * [`fn withMode()`](#fn-withmode) * [`fn withProject()`](#fn-withproject) * [`fn withTable()`](#fn-withtable) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj max_age`](#obj-max_age) * [`fn new()`](#fn-max_agenew) * [`obj max_version`](#obj-max_version) * [`fn new()`](#fn-max_versionnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) ## Fields @@ -71,6 +75,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `table` (`string`): The name of the table. - `max_age` (`list[obj]`): NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all cells older than the given age. When `null`, the `max_age` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_age.new](#fn-max_agenew) constructor. - `max_version` (`list[obj]`): NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all versions of a cell except for the most recent. When `null`, the `max_version` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_version.new](#fn-max_versionnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -105,6 +110,7 @@ injecting into a complete block. - `table` (`string`): The name of the table. - `max_age` (`list[obj]`): NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all cells older than the given age. When `null`, the `max_age` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_age.new](#fn-max_agenew) constructor. - `max_version` (`list[obj]`): NOTE: 'gc_rules' is more flexible, and should be preferred over this field for new resources. This field may be deprecated in the future. GC policy that applies to all versions of a cell except for the most recent. When `null`, the `max_version` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.max_version.new](#fn-max_versionnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_gc_policy.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `bigtable_gc_policy` resource into the root Terraform configuration. @@ -296,6 +302,42 @@ Terraform resource block to set or update the table field. - `value` (`string`): The value to set for the `table` field. +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + ## obj max_age @@ -341,3 +383,27 @@ Terraform sub block. **Returns**: - An attribute object that represents the `max_version` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.bigtable_gc_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/bigtable_instance.md b/docs/4.x/bigtable_instance.md index b75606e5..1673d08b 100644 --- a/docs/4.x/bigtable_instance.md +++ b/docs/4.x/bigtable_instance.md @@ -23,10 +23,14 @@ This package contains functions and utilities for setting up the resource using * [`fn withLabels()`](#fn-withlabels) * [`fn withName()`](#fn-withname) * [`fn withProject()`](#fn-withproject) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj cluster`](#obj-cluster) * [`fn new()`](#fn-clusternew) * [`obj cluster.autoscaling_config`](#obj-clusterautoscaling_config) * [`fn new()`](#fn-clusterautoscaling_confignew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) ## Fields @@ -64,6 +68,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `name` (`string`): The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers. - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object. - `cluster` (`list[obj]`): A block of cluster configuration options. This can be specified at least once. When `null`, the `cluster` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_instance.cluster.new](#fn-clusternew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_instance.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -94,6 +99,7 @@ injecting into a complete block. - `name` (`string`): The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers. - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object. - `cluster` (`list[obj]`): A block of cluster configuration options. This can be specified at least once. When `null`, the `cluster` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_instance.cluster.new](#fn-clusternew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.bigtable_instance.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `bigtable_instance` resource into the root Terraform configuration. @@ -232,6 +238,42 @@ Terraform resource block to set or update the project field. - `value` (`string`): The value to set for the `project` field. +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + ## obj cluster @@ -284,3 +326,27 @@ Terraform sub block. **Returns**: - An attribute object that represents the `autoscaling_config` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.bigtable_instance.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/bigtable_table.md b/docs/4.x/bigtable_table.md index 759120bc..5a9ccd1b 100644 --- a/docs/4.x/bigtable_table.md +++ b/docs/4.x/bigtable_table.md @@ -294,6 +294,7 @@ Terraform sub block. **Args**: - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/compute_disk.md b/docs/4.x/compute_disk.md index 4b6824d6..33face18 100644 --- a/docs/4.x/compute_disk.md +++ b/docs/4.x/compute_disk.md @@ -104,7 +104,8 @@ are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. When `null`, the `physical_block_size_bytes` field will be omitted from the resulting object. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk. When `null`, the `provisioned_iops` field will be omitted from the resulting object. + - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk. +Note: Update currently only supported by hyperdisk skus, allowing for an update of IOPS every 4 hours When `null`, the `provisioned_iops` field will be omitted from the resulting object. - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the 'image' or 'snapshot' parameter, or specify it alone to create an empty @@ -208,7 +209,8 @@ are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. When `null`, the `physical_block_size_bytes` field will be omitted from the resulting object. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk. When `null`, the `provisioned_iops` field will be omitted from the resulting object. + - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk. +Note: Update currently only supported by hyperdisk skus, allowing for an update of IOPS every 4 hours When `null`, the `provisioned_iops` field will be omitted from the resulting object. - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the 'image' or 'snapshot' parameter, or specify it alone to create an empty diff --git a/docs/4.x/compute_network_endpoints.md b/docs/4.x/compute_network_endpoints.md new file mode 100644 index 00000000..aa41b4cd --- /dev/null +++ b/docs/4.x/compute_network_endpoints.md @@ -0,0 +1,275 @@ +--- +permalink: /compute_network_endpoints/ +--- + +# compute_network_endpoints + +`compute_network_endpoints` represents the `google_compute_network_endpoints` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withNetworkEndpointGroup()`](#fn-withnetworkendpointgroup) +* [`fn withNetworkEndpoints()`](#fn-withnetworkendpoints) +* [`fn withNetworkEndpointsMixin()`](#fn-withnetworkendpointsmixin) +* [`fn withProject()`](#fn-withproject) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withZone()`](#fn-withzone) +* [`obj network_endpoints`](#obj-network_endpoints) + * [`fn new()`](#fn-network_endpointsnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.compute_network_endpoints.new` injects a new `google_compute_network_endpoints` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + google.compute_network_endpoints.new('some_id') + +You can get the reference to the `id` field of the created `google.compute_network_endpoints` using the reference: + + $._ref.google_compute_network_endpoints.some_id.get('id') + +This is the same as directly entering `"${ google_compute_network_endpoints.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `network_endpoint_group` (`string`): The network endpoint group these endpoints are part of. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `zone` (`string`): Zone where the containing network endpoint group is located. When `null`, the `zone` field will be omitted from the resulting object. + - `network_endpoints` (`list[obj]`): The network endpoints to be added to the enclosing network endpoint group +(NEG). Each endpoint specifies an IP address and port, along with +additional information depending on the NEG type. When `null`, the `network_endpoints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_network_endpoints.network_endpoints.new](#fn-network_endpointsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_network_endpoints.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.compute_network_endpoints.newAttrs` constructs a new object with attributes and blocks configured for the `compute_network_endpoints` +Terraform resource. + +Unlike [google.compute_network_endpoints.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `network_endpoint_group` (`string`): The network endpoint group these endpoints are part of. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `zone` (`string`): Zone where the containing network endpoint group is located. When `null`, the `zone` field will be omitted from the resulting object. + - `network_endpoints` (`list[obj]`): The network endpoints to be added to the enclosing network endpoint group +(NEG). Each endpoint specifies an IP address and port, along with +additional information depending on the NEG type. When `null`, the `network_endpoints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_network_endpoints.network_endpoints.new](#fn-network_endpointsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_network_endpoints.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `compute_network_endpoints` resource into the root Terraform configuration. + + +### fn withNetworkEndpointGroup + +```ts +withNetworkEndpointGroup() +``` + +`google.string.withNetworkEndpointGroup` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the network_endpoint_group field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `network_endpoint_group` field. + + +### fn withNetworkEndpoints + +```ts +withNetworkEndpoints() +``` + +`google.list[obj].withNetworkEndpoints` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the network_endpoints field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withNetworkEndpointsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `network_endpoints` field. + + +### fn withNetworkEndpointsMixin + +```ts +withNetworkEndpointsMixin() +``` + +`google.list[obj].withNetworkEndpointsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the network_endpoints field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withNetworkEndpoints](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `network_endpoints` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withZone + +```ts +withZone() +``` + +`google.string.withZone` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the zone field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `zone` field. + + +## obj network_endpoints + + + +### fn network_endpoints.new + +```ts +new() +``` + + +`google.compute_network_endpoints.network_endpoints.new` constructs a new object with attributes and blocks configured for the `network_endpoints` +Terraform sub block. + + + +**Args**: + - `instance` (`string`): The name for a specific VM instance that the IP address belongs to. +This is required for network endpoints of type GCE_VM_IP_PORT. +The instance must be in the same zone as the network endpoint group. When `null`, the `instance` field will be omitted from the resulting object. + - `ip_address` (`string`): IPv4 address of network endpoint. The IP address must belong +to a VM in GCE (either the primary IP or as part of an aliased IP +range). + - `port` (`number`): Port number of network endpoint. +**Note** 'port' is required unless the Network Endpoint Group is created +with the type of 'GCE_VM_IP' When `null`, the `port` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `network_endpoints` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.compute_network_endpoints.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/compute_url_map.md b/docs/4.x/compute_url_map.md index d17a9f89..b42b4582 100644 --- a/docs/4.x/compute_url_map.md +++ b/docs/4.x/compute_url_map.md @@ -2611,6 +2611,15 @@ and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. When `null`, the `full_path_match` field will be omitted from the resulting object. - `ignore_case` (`bool`): Specifies that prefixMatch and fullPathMatch matches are case sensitive. Defaults to false. When `null`, the `ignore_case` field will be omitted from the resulting object. + - `path_template_match` (`string`): For satisfying the matchRule condition, the path of the request +must match the wildcard pattern specified in pathTemplateMatch +after removing any query parameters and anchor that may be part +of the original URL. + +pathTemplateMatch must be between 1 and 255 characters +(inclusive). The pattern specified by pathTemplateMatch may +have at most 5 wildcard operators and at most 5 variable +captures in total. When `null`, the `path_template_match` field will be omitted from the resulting object. - `prefix_match` (`string`): For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or @@ -3148,6 +3157,20 @@ header is replaced with contents of hostRewrite. The value must be between 1 and - `path_prefix_rewrite` (`string`): Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters. When `null`, the `path_prefix_rewrite` field will be omitted from the resulting object. + - `path_template_rewrite` (`string`): Prior to forwarding the request to the selected origin, if the +request matched a pathTemplateMatch, the matching portion of the +request's path is replaced re-written using the pattern specified +by pathTemplateRewrite. + +pathTemplateRewrite must be between 1 and 255 characters +(inclusive), must start with a '/', and must only use variables +captured by the route's pathTemplate matchers. + +pathTemplateRewrite may only be used when all of a route's +MatchRules specify pathTemplate. + +Only one of pathPrefixRewrite and pathTemplateRewrite may be +specified. When `null`, the `path_template_rewrite` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `url_rewrite` sub block. diff --git a/docs/4.x/container_cluster.md b/docs/4.x/container_cluster.md index 4d781435..9efaaf6e 100644 --- a/docs/4.x/container_cluster.md +++ b/docs/4.x/container_cluster.md @@ -204,6 +204,10 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-node_configreservation_affinitynew) * [`obj node_config.shielded_instance_config`](#obj-node_configshielded_instance_config) * [`fn new()`](#fn-node_configshielded_instance_confignew) + * [`obj node_config.sole_tenant_config`](#obj-node_configsole_tenant_config) + * [`fn new()`](#fn-node_configsole_tenant_confignew) + * [`obj node_config.sole_tenant_config.node_affinity`](#obj-node_configsole_tenant_confignode_affinity) + * [`fn new()`](#fn-node_configsole_tenant_confignode_affinitynew) * [`obj node_config.workload_metadata_config`](#obj-node_configworkload_metadata_config) * [`fn new()`](#fn-node_configworkload_metadata_confignew) * [`obj node_pool`](#obj-node_pool) @@ -236,6 +240,10 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-node_poolnode_configreservation_affinitynew) * [`obj node_pool.node_config.shielded_instance_config`](#obj-node_poolnode_configshielded_instance_config) * [`fn new()`](#fn-node_poolnode_configshielded_instance_confignew) + * [`obj node_pool.node_config.sole_tenant_config`](#obj-node_poolnode_configsole_tenant_config) + * [`fn new()`](#fn-node_poolnode_configsole_tenant_confignew) + * [`obj node_pool.node_config.sole_tenant_config.node_affinity`](#obj-node_poolnode_configsole_tenant_confignode_affinity) + * [`fn new()`](#fn-node_poolnode_configsole_tenant_confignode_affinitynew) * [`obj node_pool.node_config.workload_metadata_config`](#obj-node_poolnode_configworkload_metadata_config) * [`fn new()`](#fn-node_poolnode_configworkload_metadata_confignew) * [`obj node_pool.placement_policy`](#obj-node_poolplacement_policy) @@ -3013,6 +3021,7 @@ Terraform sub block. - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.local_nvme_ssd_block_config.new](#fn-node_configlocal_nvme_ssd_block_confignew) constructor. - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.reservation_affinity.new](#fn-node_configreservation_affinitynew) constructor. - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.shielded_instance_config.new](#fn-node_configshielded_instance_confignew) constructor. + - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.sole_tenant_config.new](#fn-node_configsole_tenant_confignew) constructor. - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.workload_metadata_config.new](#fn-node_configworkload_metadata_confignew) constructor. **Returns**: @@ -3232,6 +3241,54 @@ Terraform sub block. - An attribute object that represents the `shielded_instance_config` sub block. +## obj node_config.sole_tenant_config + + + +### fn node_config.sole_tenant_config.new + +```ts +new() +``` + + +`google.container_cluster.node_config.sole_tenant_config.new` constructs a new object with attributes and blocks configured for the `sole_tenant_config` +Terraform sub block. + + + +**Args**: + - `node_affinity` (`list[obj]`): . When `null`, the `node_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.sole_tenant_config.node_affinity.new](#fn-node_confignode_confignode_affinitynew) constructor. + +**Returns**: + - An attribute object that represents the `sole_tenant_config` sub block. + + +## obj node_config.sole_tenant_config.node_affinity + + + +### fn node_config.sole_tenant_config.node_affinity.new + +```ts +new() +``` + + +`google.container_cluster.node_config.sole_tenant_config.node_affinity.new` constructs a new object with attributes and blocks configured for the `node_affinity` +Terraform sub block. + + + +**Args**: + - `key` (`string`): . + - `operator` (`string`): . + - `values` (`list`): . + +**Returns**: + - An attribute object that represents the `node_affinity` sub block. + + ## obj node_config.workload_metadata_config @@ -3436,6 +3493,7 @@ Terraform sub block. - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.local_nvme_ssd_block_config.new](#fn-node_poolnode_poollocal_nvme_ssd_block_confignew) constructor. - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.reservation_affinity.new](#fn-node_poolnode_poolreservation_affinitynew) constructor. - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.shielded_instance_config.new](#fn-node_poolnode_poolshielded_instance_confignew) constructor. + - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.sole_tenant_config.new](#fn-node_poolnode_poolsole_tenant_confignew) constructor. - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.workload_metadata_config.new](#fn-node_poolnode_poolworkload_metadata_confignew) constructor. **Returns**: @@ -3655,6 +3713,54 @@ Terraform sub block. - An attribute object that represents the `shielded_instance_config` sub block. +## obj node_pool.node_config.sole_tenant_config + + + +### fn node_pool.node_config.sole_tenant_config.new + +```ts +new() +``` + + +`google.container_cluster.node_pool.node_config.sole_tenant_config.new` constructs a new object with attributes and blocks configured for the `sole_tenant_config` +Terraform sub block. + + + +**Args**: + - `node_affinity` (`list[obj]`): . When `null`, the `node_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.node_config.sole_tenant_config.node_affinity.new](#fn-node_poolnode_poolnode_confignode_affinitynew) constructor. + +**Returns**: + - An attribute object that represents the `sole_tenant_config` sub block. + + +## obj node_pool.node_config.sole_tenant_config.node_affinity + + + +### fn node_pool.node_config.sole_tenant_config.node_affinity.new + +```ts +new() +``` + + +`google.container_cluster.node_pool.node_config.sole_tenant_config.node_affinity.new` constructs a new object with attributes and blocks configured for the `node_affinity` +Terraform sub block. + + + +**Args**: + - `key` (`string`): . + - `operator` (`string`): . + - `values` (`list`): . + +**Returns**: + - An attribute object that represents the `node_affinity` sub block. + + ## obj node_pool.node_config.workload_metadata_config diff --git a/docs/4.x/container_node_pool.md b/docs/4.x/container_node_pool.md index dbd2d887..b29f75a8 100644 --- a/docs/4.x/container_node_pool.md +++ b/docs/4.x/container_node_pool.md @@ -67,6 +67,10 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-node_configreservation_affinitynew) * [`obj node_config.shielded_instance_config`](#obj-node_configshielded_instance_config) * [`fn new()`](#fn-node_configshielded_instance_confignew) + * [`obj node_config.sole_tenant_config`](#obj-node_configsole_tenant_config) + * [`fn new()`](#fn-node_configsole_tenant_confignew) + * [`obj node_config.sole_tenant_config.node_affinity`](#obj-node_configsole_tenant_confignode_affinity) + * [`fn new()`](#fn-node_configsole_tenant_confignode_affinitynew) * [`obj node_config.workload_metadata_config`](#obj-node_configworkload_metadata_config) * [`fn new()`](#fn-node_configworkload_metadata_confignew) * [`obj placement_policy`](#obj-placement_policy) @@ -735,6 +739,7 @@ Terraform sub block. - `local_nvme_ssd_block_config` (`list[obj]`): Parameters for raw-block local NVMe SSDs. When `null`, the `local_nvme_ssd_block_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.local_nvme_ssd_block_config.new](#fn-node_configlocal_nvme_ssd_block_confignew) constructor. - `reservation_affinity` (`list[obj]`): The reservation affinity configuration for the node pool. When `null`, the `reservation_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.reservation_affinity.new](#fn-node_configreservation_affinitynew) constructor. - `shielded_instance_config` (`list[obj]`): Shielded Instance options. When `null`, the `shielded_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.shielded_instance_config.new](#fn-node_configshielded_instance_confignew) constructor. + - `sole_tenant_config` (`list[obj]`): Node affinity options for sole tenant node pools. When `null`, the `sole_tenant_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.sole_tenant_config.new](#fn-node_configsole_tenant_confignew) constructor. - `workload_metadata_config` (`list[obj]`): The workload metadata configuration for this node. When `null`, the `workload_metadata_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.workload_metadata_config.new](#fn-node_configworkload_metadata_confignew) constructor. **Returns**: @@ -954,6 +959,54 @@ Terraform sub block. - An attribute object that represents the `shielded_instance_config` sub block. +## obj node_config.sole_tenant_config + + + +### fn node_config.sole_tenant_config.new + +```ts +new() +``` + + +`google.container_node_pool.node_config.sole_tenant_config.new` constructs a new object with attributes and blocks configured for the `sole_tenant_config` +Terraform sub block. + + + +**Args**: + - `node_affinity` (`list[obj]`): . When `null`, the `node_affinity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_node_pool.node_config.sole_tenant_config.node_affinity.new](#fn-node_confignode_confignode_affinitynew) constructor. + +**Returns**: + - An attribute object that represents the `sole_tenant_config` sub block. + + +## obj node_config.sole_tenant_config.node_affinity + + + +### fn node_config.sole_tenant_config.node_affinity.new + +```ts +new() +``` + + +`google.container_node_pool.node_config.sole_tenant_config.node_affinity.new` constructs a new object with attributes and blocks configured for the `node_affinity` +Terraform sub block. + + + +**Args**: + - `key` (`string`): . + - `operator` (`string`): . + - `values` (`list`): . + +**Returns**: + - An attribute object that represents the `node_affinity` sub block. + + ## obj node_config.workload_metadata_config diff --git a/docs/4.x/data_loss_prevention_deidentify_template.md b/docs/4.x/data_loss_prevention_deidentify_template.md index 402c7c1a..e4fc1369 100644 --- a/docs/4.x/data_loss_prevention_deidentify_template.md +++ b/docs/4.x/data_loss_prevention_deidentify_template.md @@ -39,12 +39,16 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-deidentify_configimage_transformationstransformsselected_info_typesnew) * [`obj deidentify_config.image_transformations.transforms.selected_info_types.info_types`](#obj-deidentify_configimage_transformationstransformsselected_info_typesinfo_types) * [`fn new()`](#fn-deidentify_configimage_transformationstransformsselected_info_typesinfo_typesnew) + * [`obj deidentify_config.image_transformations.transforms.selected_info_types.info_types.sensitivity_score`](#obj-deidentify_configimage_transformationstransformsselected_info_typesinfo_typessensitivity_score) + * [`fn new()`](#fn-deidentify_configimage_transformationstransformsselected_info_typesinfo_typessensitivity_scorenew) * [`obj deidentify_config.info_type_transformations`](#obj-deidentify_configinfo_type_transformations) * [`fn new()`](#fn-deidentify_configinfo_type_transformationsnew) * [`obj deidentify_config.info_type_transformations.transformations`](#obj-deidentify_configinfo_type_transformationstransformations) * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsnew) * [`obj deidentify_config.info_type_transformations.transformations.info_types`](#obj-deidentify_configinfo_type_transformationstransformationsinfo_types) * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsinfo_typesnew) + * [`obj deidentify_config.info_type_transformations.transformations.info_types.sensitivity_score`](#obj-deidentify_configinfo_type_transformationstransformationsinfo_typessensitivity_score) + * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsinfo_typessensitivity_scorenew) * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformation) * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationnew) * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.bucketing_config`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationbucketing_config) @@ -87,6 +91,18 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configcrypto_keyunwrappednew) * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_type) * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_typenew) + * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_typesensitivity_score) + * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_typesensitivity_scorenew) + * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_config) + * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_confignew) + * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configcrypto_key) + * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configcrypto_keynew) + * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.kms_wrapped`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configcrypto_keykms_wrapped) + * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configcrypto_keykms_wrappednew) + * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.transient`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configcrypto_keytransient) + * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configcrypto_keytransientnew) + * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.unwrapped`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configcrypto_keyunwrapped) + * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configcrypto_keyunwrappednew) * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_config) * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_confignew) * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.context`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configcontext) @@ -101,6 +117,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configcrypto_keyunwrappednew) * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_type) * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_typenew) + * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_typesensitivity_score) + * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_typesensitivity_scorenew) * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.date_shift_config`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationdate_shift_config) * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationdate_shift_confignew) * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.date_shift_config.context`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationdate_shift_configcontext) @@ -163,6 +181,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsnew) * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.info_types`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsinfo_types) * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsinfo_typesnew) + * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.info_types.sensitivity_score`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsinfo_typessensitivity_score) + * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsinfo_typessensitivity_scorenew) * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformation) * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationnew) * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.bucketing_config`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationbucketing_config) @@ -205,6 +225,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configcrypto_keyunwrappednew) * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_type) * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_typenew) + * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_typesensitivity_score) + * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_typesensitivity_scorenew) * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_hash_config`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_config) * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_confignew) * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configcrypto_key) @@ -229,6 +251,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configcrypto_keyunwrappednew) * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_type) * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_typenew) + * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_typesensitivity_score) + * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_typesensitivity_scorenew) * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.date_shift_config`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationdate_shift_config) * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationdate_shift_confignew) * [`obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.date_shift_config.context`](#obj-deidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationdate_shift_configcontext) @@ -307,6 +331,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_deterministic_configcrypto_keyunwrappednew) * [`obj deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type`](#obj-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_type) * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_typenew) + * [`obj deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score`](#obj-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_typesensitivity_score) + * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_deterministic_configsurrogate_info_typesensitivity_scorenew) * [`obj deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_hash_config`](#obj-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_hash_config) * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_hash_confignew) * [`obj deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_hash_config.crypto_key`](#obj-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_hash_configcrypto_key) @@ -331,6 +357,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_replace_ffx_fpe_configcrypto_keyunwrappednew) * [`obj deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type`](#obj-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_type) * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_typenew) + * [`obj deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score`](#obj-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_typesensitivity_score) + * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_replace_ffx_fpe_configsurrogate_info_typesensitivity_scorenew) * [`obj deidentify_config.record_transformations.field_transformations.primitive_transformation.date_shift_config`](#obj-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationdate_shift_config) * [`fn new()`](#fn-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationdate_shift_confignew) * [`obj deidentify_config.record_transformations.field_transformations.primitive_transformation.date_shift_config.context`](#obj-deidentify_configrecord_transformationsfield_transformationsprimitive_transformationdate_shift_configcontext) @@ -796,11 +824,35 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.info_types.sensitivity_score.new](#fn-deidentify_configdeidentify_configimage_transformationstransformsselected_info_typessensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_types` sub block. +## obj deidentify_config.image_transformations.transforms.selected_info_types.info_types.sensitivity_score + + + +### fn deidentify_config.image_transformations.transforms.selected_info_types.info_types.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj deidentify_config.info_type_transformations @@ -869,11 +921,35 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.info_types.sensitivity_score.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationssensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_types` sub block. +## obj deidentify_config.info_type_transformations.transformations.info_types.sensitivity_score + + + +### fn deidentify_config.info_type_transformations.transformations.info_types.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj deidentify_config.info_type_transformations.transformations.primitive_transformation @@ -899,6 +975,10 @@ See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. When `nu - `character_mask_config` (`list[obj]`): Partially mask a string by replacing a given number of characters with a fixed character. Masking can start from the beginning or end of the string. When `null`, the `character_mask_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.character_mask_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscharacter_mask_confignew) constructor. - `crypto_deterministic_config` (`list[obj]`): Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC [https://tools.ietf.org/html/rfc5297](https://tools.ietf.org/html/rfc5297). When `null`, the `crypto_deterministic_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_deterministic_confignew) constructor. + - `crypto_hash_config` (`list[obj]`): Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. +Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). +Currently, only string and integer values can be hashed. +See https://cloud.google.com/dlp/docs/pseudonymization to learn more. When `null`, the `crypto_hash_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_hash_confignew) constructor. - `crypto_replace_ffx_fpe_config` (`list[obj]`): Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the 'content.reidentify' API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See [https://cloud.google.com/dlp/docs/pseudonymization](https://cloud.google.com/dlp/docs/pseudonymization) to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. When `null`, the `crypto_replace_ffx_fpe_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_replace_ffx_fpe_confignew) constructor. @@ -1457,11 +1537,160 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object. - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `surrogate_info_type` sub block. +## obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score + + + +### fn deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + +## obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config + + + +### fn deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.new` constructs a new object with attributes and blocks configured for the `crypto_hash_config` +Terraform sub block. + + + +**Args**: + - `crypto_key` (`list[obj]`): The key used by the encryption function. When `null`, the `crypto_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_keynew) constructor. + +**Returns**: + - An attribute object that represents the `crypto_hash_config` sub block. + + +## obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key + + + +### fn deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.new` constructs a new object with attributes and blocks configured for the `crypto_key` +Terraform sub block. + + + +**Args**: + - `kms_wrapped` (`list[obj]`): KMS wrapped key. +Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt +For more information, see [Creating a wrapped key](https://cloud.google.com/dlp/docs/create-wrapped-key). +Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing). When `null`, the `kms_wrapped` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.kms_wrapped.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configkms_wrappednew) constructor. + - `transient` (`list[obj]`): Transient crypto key. Use this to have a random data crypto key generated. It will be discarded after the request finishes. When `null`, the `transient` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.transient.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configtransientnew) constructor. + - `unwrapped` (`list[obj]`): Unwrapped crypto key. Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible. When `null`, the `unwrapped` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.unwrapped.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_hash_configunwrappednew) constructor. + +**Returns**: + - An attribute object that represents the `crypto_key` sub block. + + +## obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.kms_wrapped + + + +### fn deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.kms_wrapped.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.kms_wrapped.new` constructs a new object with attributes and blocks configured for the `kms_wrapped` +Terraform sub block. + + + +**Args**: + - `crypto_key_name` (`string`): The resource name of the KMS CryptoKey to use for unwrapping. + - `wrapped_key` (`string`): The wrapped data crypto key. + +A base64-encoded string. + +**Returns**: + - An attribute object that represents the `kms_wrapped` sub block. + + +## obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.transient + + + +### fn deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.transient.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.transient.new` constructs a new object with attributes and blocks configured for the `transient` +Terraform sub block. + + + +**Args**: + - `name` (`string`): Name of the key. This is an arbitrary string used to differentiate different keys. A unique key is generated per name: two separate 'TransientCryptoKey' protos share the same generated key if their names are the same. When the data crypto key is generated, this name is not used in any way (repeating the api call will result in a different key being generated). + +**Returns**: + - An attribute object that represents the `transient` sub block. + + +## obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.unwrapped + + + +### fn deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.unwrapped.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_hash_config.crypto_key.unwrapped.new` constructs a new object with attributes and blocks configured for the `unwrapped` +Terraform sub block. + + + +**Args**: + - `key` (`string`): A 128/192/256 bit key. + +A base64-encoded string. + +**Returns**: + - An attribute object that represents the `unwrapped` sub block. + + ## obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config @@ -1656,11 +1885,35 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object. - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `surrogate_info_type` sub block. +## obj deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score + + + +### fn deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj deidentify_config.info_type_transformations.transformations.primitive_transformation.date_shift_config @@ -2436,11 +2689,35 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.info_types.sensitivity_score.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationssensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_types` sub block. +## obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.info_types.sensitivity_score + + + +### fn deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.info_types.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation @@ -3035,11 +3312,35 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_deterministic_configsensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `surrogate_info_type` sub block. +## obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score + + + +### fn deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_hash_config @@ -3359,11 +3660,35 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsinfo_type_transformationstransformationsprimitive_transformationcrypto_replace_ffx_fpe_configsensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `surrogate_info_type` sub block. +## obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score + + + +### fn deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj deidentify_config.record_transformations.field_transformations.info_type_transformations.transformations.primitive_transformation.date_shift_config @@ -4408,11 +4733,35 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object. - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_deterministic_configsensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `surrogate_info_type` sub block. +## obj deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score + + + +### fn deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_deterministic_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_hash_config @@ -4732,11 +5081,35 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at [https://cloud.google.com/dlp/docs/infotypes-reference](https://cloud.google.com/dlp/docs/infotypes-reference) when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern '[A-Za-z0-9$-_]{1,64}'. When `null`, the `name` field will be omitted from the resulting object. - `version` (`string`): Optional version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new](#fn-deidentify_configdeidentify_configrecord_transformationsfield_transformationsprimitive_transformationcrypto_replace_ffx_fpe_configsensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `surrogate_info_type` sub block. +## obj deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score + + + +### fn deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_deidentify_template.deidentify_config.record_transformations.field_transformations.primitive_transformation.crypto_replace_ffx_fpe_config.surrogate_info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj deidentify_config.record_transformations.field_transformations.primitive_transformation.date_shift_config diff --git a/docs/4.x/data_loss_prevention_inspect_template.md b/docs/4.x/data_loss_prevention_inspect_template.md index 6008c7cf..36eec090 100644 --- a/docs/4.x/data_loss_prevention_inspect_template.md +++ b/docs/4.x/data_loss_prevention_inspect_template.md @@ -35,24 +35,34 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-inspect_configcustom_info_typesdictionaryword_listnew) * [`obj inspect_config.custom_info_types.info_type`](#obj-inspect_configcustom_info_typesinfo_type) * [`fn new()`](#fn-inspect_configcustom_info_typesinfo_typenew) + * [`obj inspect_config.custom_info_types.info_type.sensitivity_score`](#obj-inspect_configcustom_info_typesinfo_typesensitivity_score) + * [`fn new()`](#fn-inspect_configcustom_info_typesinfo_typesensitivity_scorenew) * [`obj inspect_config.custom_info_types.regex`](#obj-inspect_configcustom_info_typesregex) * [`fn new()`](#fn-inspect_configcustom_info_typesregexnew) + * [`obj inspect_config.custom_info_types.sensitivity_score`](#obj-inspect_configcustom_info_typessensitivity_score) + * [`fn new()`](#fn-inspect_configcustom_info_typessensitivity_scorenew) * [`obj inspect_config.custom_info_types.stored_type`](#obj-inspect_configcustom_info_typesstored_type) * [`fn new()`](#fn-inspect_configcustom_info_typesstored_typenew) * [`obj inspect_config.custom_info_types.surrogate_type`](#obj-inspect_configcustom_info_typessurrogate_type) * [`fn new()`](#fn-inspect_configcustom_info_typessurrogate_typenew) * [`obj inspect_config.info_types`](#obj-inspect_configinfo_types) * [`fn new()`](#fn-inspect_configinfo_typesnew) + * [`obj inspect_config.info_types.sensitivity_score`](#obj-inspect_configinfo_typessensitivity_score) + * [`fn new()`](#fn-inspect_configinfo_typessensitivity_scorenew) * [`obj inspect_config.limits`](#obj-inspect_configlimits) * [`fn new()`](#fn-inspect_configlimitsnew) * [`obj inspect_config.limits.max_findings_per_info_type`](#obj-inspect_configlimitsmax_findings_per_info_type) * [`fn new()`](#fn-inspect_configlimitsmax_findings_per_info_typenew) * [`obj inspect_config.limits.max_findings_per_info_type.info_type`](#obj-inspect_configlimitsmax_findings_per_info_typeinfo_type) * [`fn new()`](#fn-inspect_configlimitsmax_findings_per_info_typeinfo_typenew) + * [`obj inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score`](#obj-inspect_configlimitsmax_findings_per_info_typeinfo_typesensitivity_score) + * [`fn new()`](#fn-inspect_configlimitsmax_findings_per_info_typeinfo_typesensitivity_scorenew) * [`obj inspect_config.rule_set`](#obj-inspect_configrule_set) * [`fn new()`](#fn-inspect_configrule_setnew) * [`obj inspect_config.rule_set.info_types`](#obj-inspect_configrule_setinfo_types) * [`fn new()`](#fn-inspect_configrule_setinfo_typesnew) + * [`obj inspect_config.rule_set.info_types.sensitivity_score`](#obj-inspect_configrule_setinfo_typessensitivity_score) + * [`fn new()`](#fn-inspect_configrule_setinfo_typessensitivity_scorenew) * [`obj inspect_config.rule_set.rules`](#obj-inspect_configrule_setrules) * [`fn new()`](#fn-inspect_configrule_setrulesnew) * [`obj inspect_config.rule_set.rules.exclusion_rule`](#obj-inspect_configrule_setrulesexclusion_rule) @@ -73,6 +83,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-inspect_configrule_setrulesexclusion_ruleexclude_info_typesnew) * [`obj inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types`](#obj-inspect_configrule_setrulesexclusion_ruleexclude_info_typesinfo_types) * [`fn new()`](#fn-inspect_configrule_setrulesexclusion_ruleexclude_info_typesinfo_typesnew) + * [`obj inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score`](#obj-inspect_configrule_setrulesexclusion_ruleexclude_info_typesinfo_typessensitivity_score) + * [`fn new()`](#fn-inspect_configrule_setrulesexclusion_ruleexclude_info_typesinfo_typessensitivity_scorenew) * [`obj inspect_config.rule_set.rules.exclusion_rule.regex`](#obj-inspect_configrule_setrulesexclusion_ruleregex) * [`fn new()`](#fn-inspect_configrule_setrulesexclusion_ruleregexnew) * [`obj inspect_config.rule_set.rules.hotword_rule`](#obj-inspect_configrule_setruleshotword_rule) @@ -367,6 +379,7 @@ infoTypes and that infoType is specified in 'info_types' field. Specifyi one detected by the system. If built-in info type is not specified in 'info_types' list then the name is treated as a custom info type. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.new](#fn-inspect_configinspect_configinfo_typenew) constructor. - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.regex.new](#fn-inspect_configinspect_configregexnew) constructor. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.sensitivity_score.new](#fn-inspect_configinspect_configsensitivity_scorenew) constructor. - `stored_type` (`list[obj]`): A reference to a StoredInfoType to use with scanning. When `null`, the `stored_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.stored_type.new](#fn-inspect_configinspect_configstored_typenew) constructor. - `surrogate_type` (`list[obj]`): Message for detecting output from deidentification transformations that support reversing. When `null`, the `surrogate_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.surrogate_type.new](#fn-inspect_configinspect_configsurrogate_typenew) constructor. @@ -465,11 +478,35 @@ Terraform sub block. - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.sensitivity_score.new](#fn-inspect_configinspect_configcustom_info_typessensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_type` sub block. +## obj inspect_config.custom_info_types.info_type.sensitivity_score + + + +### fn inspect_config.custom_info_types.info_type.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_config.custom_info_types.regex @@ -495,6 +532,29 @@ Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the go - An attribute object that represents the `regex` sub block. +## obj inspect_config.custom_info_types.sensitivity_score + + + +### fn inspect_config.custom_info_types.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_inspect_template.inspect_config.custom_info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_config.custom_info_types.stored_type @@ -559,11 +619,35 @@ Terraform sub block. - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.info_types.sensitivity_score.new](#fn-inspect_configinspect_configsensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_types` sub block. +## obj inspect_config.info_types.sensitivity_score + + + +### fn inspect_config.info_types.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_inspect_template.inspect_config.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_config.limits @@ -635,11 +719,35 @@ Terraform sub block. - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score.new](#fn-inspect_configinspect_configlimitsmax_findings_per_info_typesensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_type` sub block. +## obj inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score + + + +### fn inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_config.rule_set @@ -684,11 +792,35 @@ Terraform sub block. - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.rule_set.info_types.sensitivity_score.new](#fn-inspect_configinspect_configrule_setsensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_types` sub block. +## obj inspect_config.rule_set.info_types.sensitivity_score + + + +### fn inspect_config.rule_set.info_types.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_inspect_template.inspect_config.rule_set.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_config.rule_set.rules @@ -933,11 +1065,35 @@ Terraform sub block. - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score.new](#fn-inspect_configinspect_configrule_setrulesexclusion_ruleexclude_info_typessensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_types` sub block. +## obj inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score + + + +### fn inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_config.rule_set.rules.exclusion_rule.regex diff --git a/docs/4.x/data_loss_prevention_job_trigger.md b/docs/4.x/data_loss_prevention_job_trigger.md index c9fec09c..5664c898 100644 --- a/docs/4.x/data_loss_prevention_job_trigger.md +++ b/docs/4.x/data_loss_prevention_job_trigger.md @@ -23,6 +23,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withStatus()`](#fn-withstatus) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withTriggerId()`](#fn-withtriggerid) * [`fn withTriggers()`](#fn-withtriggers) * [`fn withTriggersMixin()`](#fn-withtriggersmixin) * [`obj inspect_job`](#obj-inspect_job) @@ -65,24 +66,34 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesdictionaryword_listnew) * [`obj inspect_job.inspect_config.custom_info_types.info_type`](#obj-inspect_jobinspect_configcustom_info_typesinfo_type) * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesinfo_typenew) + * [`obj inspect_job.inspect_config.custom_info_types.info_type.sensitivity_score`](#obj-inspect_jobinspect_configcustom_info_typesinfo_typesensitivity_score) + * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesinfo_typesensitivity_scorenew) * [`obj inspect_job.inspect_config.custom_info_types.regex`](#obj-inspect_jobinspect_configcustom_info_typesregex) * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesregexnew) + * [`obj inspect_job.inspect_config.custom_info_types.sensitivity_score`](#obj-inspect_jobinspect_configcustom_info_typessensitivity_score) + * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typessensitivity_scorenew) * [`obj inspect_job.inspect_config.custom_info_types.stored_type`](#obj-inspect_jobinspect_configcustom_info_typesstored_type) * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesstored_typenew) * [`obj inspect_job.inspect_config.custom_info_types.surrogate_type`](#obj-inspect_jobinspect_configcustom_info_typessurrogate_type) * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typessurrogate_typenew) * [`obj inspect_job.inspect_config.info_types`](#obj-inspect_jobinspect_configinfo_types) * [`fn new()`](#fn-inspect_jobinspect_configinfo_typesnew) + * [`obj inspect_job.inspect_config.info_types.sensitivity_score`](#obj-inspect_jobinspect_configinfo_typessensitivity_score) + * [`fn new()`](#fn-inspect_jobinspect_configinfo_typessensitivity_scorenew) * [`obj inspect_job.inspect_config.limits`](#obj-inspect_jobinspect_configlimits) * [`fn new()`](#fn-inspect_jobinspect_configlimitsnew) * [`obj inspect_job.inspect_config.limits.max_findings_per_info_type`](#obj-inspect_jobinspect_configlimitsmax_findings_per_info_type) * [`fn new()`](#fn-inspect_jobinspect_configlimitsmax_findings_per_info_typenew) * [`obj inspect_job.inspect_config.limits.max_findings_per_info_type.info_type`](#obj-inspect_jobinspect_configlimitsmax_findings_per_info_typeinfo_type) * [`fn new()`](#fn-inspect_jobinspect_configlimitsmax_findings_per_info_typeinfo_typenew) + * [`obj inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score`](#obj-inspect_jobinspect_configlimitsmax_findings_per_info_typeinfo_typesensitivity_score) + * [`fn new()`](#fn-inspect_jobinspect_configlimitsmax_findings_per_info_typeinfo_typesensitivity_scorenew) * [`obj inspect_job.inspect_config.rule_set`](#obj-inspect_jobinspect_configrule_set) * [`fn new()`](#fn-inspect_jobinspect_configrule_setnew) * [`obj inspect_job.inspect_config.rule_set.info_types`](#obj-inspect_jobinspect_configrule_setinfo_types) * [`fn new()`](#fn-inspect_jobinspect_configrule_setinfo_typesnew) + * [`obj inspect_job.inspect_config.rule_set.info_types.sensitivity_score`](#obj-inspect_jobinspect_configrule_setinfo_typessensitivity_score) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setinfo_typessensitivity_scorenew) * [`obj inspect_job.inspect_config.rule_set.rules`](#obj-inspect_jobinspect_configrule_setrules) * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesnew) * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule`](#obj-inspect_jobinspect_configrule_setrulesexclusion_rule) @@ -103,6 +114,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_info_typesnew) * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_info_typesinfo_types) * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_info_typesinfo_typesnew) + * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_info_typesinfo_typessensitivity_score) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_info_typesinfo_typessensitivity_scorenew) * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.regex`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruleregex) * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruleregexnew) * [`obj inspect_job.inspect_config.rule_set.rules.hotword_rule`](#obj-inspect_jobinspect_configrule_setruleshotword_rule) @@ -190,6 +203,9 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `parent` (`string`): The parent of the trigger, either in the format 'projects/{{project}}' or 'projects/{{project}}/locations/{{location}}' - `status` (`string`): Whether the trigger is currently active. Default value: "HEALTHY" Possible values: ["PAUSED", "HEALTHY", "CANCELLED"] When `null`, the `status` field will be omitted from the resulting object. + - `trigger_id` (`string`): The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; +that is, it must match the regular expression: [a-zA-Z\d-_]+. +The maximum length is 100 characters. Can be empty to allow the system to generate one. When `null`, the `trigger_id` field will be omitted from the resulting object. - `inspect_job` (`list[obj]`): Controls what and how to inspect for findings. When `null`, the `inspect_job` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.new](#fn-inspect_jobnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.timeouts.new](#fn-timeoutsnew) constructor. - `triggers` (`list[obj]`): What event needs to occur for a new job to be started. When `null`, the `triggers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.triggers.new](#fn-triggersnew) constructor. @@ -221,6 +237,9 @@ injecting into a complete block. - `parent` (`string`): The parent of the trigger, either in the format 'projects/{{project}}' or 'projects/{{project}}/locations/{{location}}' - `status` (`string`): Whether the trigger is currently active. Default value: "HEALTHY" Possible values: ["PAUSED", "HEALTHY", "CANCELLED"] When `null`, the `status` field will be omitted from the resulting object. + - `trigger_id` (`string`): The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; +that is, it must match the regular expression: [a-zA-Z\d-_]+. +The maximum length is 100 characters. Can be empty to allow the system to generate one. When `null`, the `trigger_id` field will be omitted from the resulting object. - `inspect_job` (`list[obj]`): Controls what and how to inspect for findings. When `null`, the `inspect_job` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.new](#fn-inspect_jobnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.timeouts.new](#fn-timeoutsnew) constructor. - `triggers` (`list[obj]`): What event needs to occur for a new job to be started. When `null`, the `triggers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.triggers.new](#fn-triggersnew) constructor. @@ -366,6 +385,22 @@ function. - `value` (`obj`): The value to set for the `timeouts` field. +### fn withTriggerId + +```ts +withTriggerId() +``` + +`google.string.withTriggerId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the trigger_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `trigger_id` field. + + ### fn withTriggers ```ts @@ -420,7 +455,7 @@ Terraform sub block. **Args**: - - `inspect_template_name` (`string`): The name of the template to run when this job is triggered. + - `inspect_template_name` (`string`): The name of the template to run when this job is triggered. When `null`, the `inspect_template_name` field will be omitted from the resulting object. - `actions` (`list[obj]`): A task to execute on the completion of a job. When `null`, the `actions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.actions.new](#fn-inspect_jobactionsnew) constructor. - `inspect_config` (`list[obj]`): The core content of the template. When `null`, the `inspect_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.new](#fn-inspect_jobinspect_confignew) constructor. - `storage_config` (`list[obj]`): Information on where to inspect When `null`, the `storage_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.storage_config.new](#fn-inspect_jobstorage_confignew) constructor. @@ -814,6 +849,7 @@ infoTypes and that infoType is specified in 'info_types' field. Specifyi one detected by the system. If built-in info type is not specified in 'info_types' list then the name is treated as a custom info type. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.new](#fn-inspect_jobinspect_jobinspect_configinfo_typenew) constructor. - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.regex.new](#fn-inspect_jobinspect_jobinspect_configregexnew) constructor. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configsensitivity_scorenew) constructor. - `stored_type` (`list[obj]`): A reference to a StoredInfoType to use with scanning. When `null`, the `stored_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.stored_type.new](#fn-inspect_jobinspect_jobinspect_configstored_typenew) constructor. - `surrogate_type` (`list[obj]`): Message for detecting output from deidentification transformations that support reversing. When `null`, the `surrogate_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.surrogate_type.new](#fn-inspect_jobinspect_jobinspect_configsurrogate_typenew) constructor. @@ -912,11 +948,35 @@ Terraform sub block. - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configcustom_info_typessensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_type` sub block. +## obj inspect_job.inspect_config.custom_info_types.info_type.sensitivity_score + + + +### fn inspect_job.inspect_config.custom_info_types.info_type.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_job.inspect_config.custom_info_types.regex @@ -942,6 +1002,29 @@ Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the go - An attribute object that represents the `regex` sub block. +## obj inspect_job.inspect_config.custom_info_types.sensitivity_score + + + +### fn inspect_job.inspect_config.custom_info_types.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_job.inspect_config.custom_info_types.stored_type @@ -1006,11 +1089,35 @@ Terraform sub block. - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.info_types.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configsensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_types` sub block. +## obj inspect_job.inspect_config.info_types.sensitivity_score + + + +### fn inspect_job.inspect_config.info_types.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_job.inspect_config.limits @@ -1082,11 +1189,35 @@ Terraform sub block. - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configlimitsmax_findings_per_info_typesensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_type` sub block. +## obj inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score + + + +### fn inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_job.inspect_config.rule_set @@ -1131,11 +1262,35 @@ Terraform sub block. - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.info_types.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configrule_setsensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_types` sub block. +## obj inspect_job.inspect_config.rule_set.info_types.sensitivity_score + + + +### fn inspect_job.inspect_config.rule_set.info_types.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_job.inspect_config.rule_set.rules @@ -1379,11 +1534,35 @@ Terraform sub block. - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object. + - `sensitivity_score` (`list[obj]`): Optional custom sensitivity for this InfoType. This only applies to data profiling. When `null`, the `sensitivity_score` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_ruleexclude_info_typessensitivity_scorenew) constructor. **Returns**: - An attribute object that represents the `info_types` sub block. +## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score + + + +### fn inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score.new + +```ts +new() +``` + + +`google.data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.sensitivity_score.new` constructs a new object with attributes and blocks configured for the `sensitivity_score` +Terraform sub block. + + + +**Args**: + - `score` (`string`): The sensitivity score applied to the resource. Possible values: ["SENSITIVITY_LOW", "SENSITIVITY_MODERATE", "SENSITIVITY_HIGH"] + +**Returns**: + - An attribute object that represents the `sensitivity_score` sub block. + + ## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.regex @@ -1697,7 +1876,7 @@ then the rest of the bytes are omitted. When `null`, the `bytes_limit_per_file` Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. When `null`, the `bytes_limit_per_file_percent` field will be omitted from the resulting object. - `file_types` (`list`): List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. -Images are scanned only as binary if the specified region does not support image inspection and no fileTypes were specified. Possible values: ["BINARY_FILE", "TEXT_FILE", "IMAGE", "WORD", "PDF", "AVRO", "CSV", "TSV"] When `null`, the `file_types` field will be omitted from the resulting object. +Images are scanned only as binary if the specified region does not support image inspection and no fileTypes were specified. Possible values: ["BINARY_FILE", "TEXT_FILE", "IMAGE", "WORD", "PDF", "AVRO", "CSV", "TSV", "POWERPOINT", "EXCEL"] When `null`, the `file_types` field will be omitted from the resulting object. - `files_limit_percent` (`number`): Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. When `null`, the `files_limit_percent` field will be omitted from the resulting object. - `sample_method` (`string`): How to sample bytes if not all bytes are scanned. Meaningful only when used in conjunction with bytesLimitPerFile. diff --git a/docs/4.x/pubsub_schema.md b/docs/4.x/pubsub_schema.md index ce7cf647..0b3c07c5 100644 --- a/docs/4.x/pubsub_schema.md +++ b/docs/4.x/pubsub_schema.md @@ -214,6 +214,7 @@ Terraform sub block. **Args**: - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/sql_database_instance.md b/docs/4.x/sql_database_instance.md index 6d5146ac..64f72cfe 100644 --- a/docs/4.x/sql_database_instance.md +++ b/docs/4.x/sql_database_instance.md @@ -101,7 +101,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `database_version` (`string`): The MySQL, PostgreSQL or SQL Server (beta) version to use. Supported values include MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB. Database Version Policies includes an up-to-date reference of supported versions. + - `database_version` (`string`): The MySQL, PostgreSQL or SQL Server (beta) version to use. Supported values include MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, POSTGRES_15, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB. Database Version Policies includes an up-to-date reference of supported versions. - `deletion_protection` (`bool`): Used to block Terraform from deleting a SQL Instance. Defaults to true. When `null`, the `deletion_protection` field will be omitted from the resulting object. - `encryption_key_name` (`string`): Set the `encryption_key_name` field on the resulting resource block. When `null`, the `encryption_key_name` field will be omitted from the resulting object. - `instance_type` (`string`): The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'. When `null`, the `instance_type` field will be omitted from the resulting object. @@ -139,7 +139,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `database_version` (`string`): The MySQL, PostgreSQL or SQL Server (beta) version to use. Supported values include MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB. Database Version Policies includes an up-to-date reference of supported versions. + - `database_version` (`string`): The MySQL, PostgreSQL or SQL Server (beta) version to use. Supported values include MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, POSTGRES_15, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB. Database Version Policies includes an up-to-date reference of supported versions. - `deletion_protection` (`bool`): Used to block Terraform from deleting a SQL Instance. Defaults to true. When `null`, the `deletion_protection` field will be omitted from the resulting object. - `encryption_key_name` (`string`): Set the `encryption_key_name` field on the resulting object. When `null`, the `encryption_key_name` field will be omitted from the resulting object. - `instance_type` (`string`): The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'. When `null`, the `instance_type` field will be omitted from the resulting object. diff --git a/docs/4.x/vertex_ai_index_endpoint.md b/docs/4.x/vertex_ai_index_endpoint.md new file mode 100644 index 00000000..95759f4c --- /dev/null +++ b/docs/4.x/vertex_ai_index_endpoint.md @@ -0,0 +1,260 @@ +--- +permalink: /vertex_ai_index_endpoint/ +--- + +# vertex_ai_index_endpoint + +`vertex_ai_index_endpoint` represents the `google_vertex_ai_index_endpoint` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withNetwork()`](#fn-withnetwork) +* [`fn withProject()`](#fn-withproject) +* [`fn withRegion()`](#fn-withregion) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.vertex_ai_index_endpoint.new` injects a new `google_vertex_ai_index_endpoint` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + google.vertex_ai_index_endpoint.new('some_id') + +You can get the reference to the `id` field of the created `google.vertex_ai_index_endpoint` using the reference: + + $._ref.google_vertex_ai_index_endpoint.some_id.get('id') + +This is the same as directly entering `"${ google_vertex_ai_index_endpoint.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `description` (`string`): The description of the Index. When `null`, the `description` field will be omitted from the resulting object. + - `display_name` (`string`): The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. + - `labels` (`obj`): The labels with user-defined metadata to organize your Indexes. When `null`, the `labels` field will be omitted from the resulting object. + - `network` (`string`): The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the index endpoint should be peered. +Private services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network. +[Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): 'projects/{project}/global/networks/{network}'. +Where '{project}' is a project number, as in '12345', and '{network}' is network name. When `null`, the `network` field will be omitted from the resulting object. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): The region of the index endpoint. eg us-central1 When `null`, the `region` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.vertex_ai_index_endpoint.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.vertex_ai_index_endpoint.newAttrs` constructs a new object with attributes and blocks configured for the `vertex_ai_index_endpoint` +Terraform resource. + +Unlike [google.vertex_ai_index_endpoint.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `description` (`string`): The description of the Index. When `null`, the `description` field will be omitted from the resulting object. + - `display_name` (`string`): The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. + - `labels` (`obj`): The labels with user-defined metadata to organize your Indexes. When `null`, the `labels` field will be omitted from the resulting object. + - `network` (`string`): The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the index endpoint should be peered. +Private services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network. +[Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): 'projects/{project}/global/networks/{network}'. +Where '{project}' is a project number, as in '12345', and '{network}' is network name. When `null`, the `network` field will be omitted from the resulting object. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): The region of the index endpoint. eg us-central1 When `null`, the `region` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.vertex_ai_index_endpoint.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `vertex_ai_index_endpoint` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`google.string.withDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `description` field. + + +### fn withDisplayName + +```ts +withDisplayName() +``` + +`google.string.withDisplayName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the display_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `display_name` field. + + +### fn withLabels + +```ts +withLabels() +``` + +`google.obj.withLabels` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the labels field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `labels` field. + + +### fn withNetwork + +```ts +withNetwork() +``` + +`google.string.withNetwork` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the network field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `network` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withRegion + +```ts +withRegion() +``` + +`google.string.withRegion` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the region field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `region` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.vertex_ai_index_endpoint.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block.