diff --git a/4.x/_gen/data/gke_hub_scope_iam_policy.libsonnet b/4.x/_gen/data/gke_hub_scope_iam_policy.libsonnet new file mode 100644 index 0000000..ed3658a --- /dev/null +++ b/4.x/_gen/data/gke_hub_scope_iam_policy.libsonnet @@ -0,0 +1,45 @@ +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='gke_hub_scope_iam_policy', url='', help='`gke_hub_scope_iam_policy` represents the `google_gke_hub_scope_iam_policy` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google.data.gke_hub_scope_iam_policy.new` injects a new `data_google_gke_hub_scope_iam_policy` Terraform `data source`\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.gke_hub_scope_iam_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.data.gke_hub_scope_iam_policy` using the reference:\n\n $._ref.data_google_gke_hub_scope_iam_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google_gke_hub_scope_iam_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 - `dataSrcLabel` (`string`): The name label of the block.\n - `project` (`string`): Set the `project` field on the resulting data source block. When `null`, the `project` field will be omitted from the resulting object.\n - `scope_id` (`string`): Set the `scope_id` field on the resulting data source block.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + scope_id, + project=null, + _meta={} + ):: tf.withData( + type='google_gke_hub_scope_iam_policy', + label=dataSrcLabel, + attrs=self.newAttrs(project=project, scope_id=scope_id), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.data.gke_hub_scope_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope_iam_policy`\nTerraform data source.\n\nUnlike [google.data.gke_hub_scope_iam_policy.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) 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 - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `scope_id` (`string`): Set the `scope_id` field on the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `gke_hub_scope_iam_policy` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + scope_id, + project=null + ):: std.prune(a={ + project: project, + scope_id: scope_id, + }), + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the project field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(dataSrcLabel, value): { + data+: { + google_gke_hub_scope_iam_policy+: { + [dataSrcLabel]+: { + project: value, + }, + }, + }, + }, + '#withScopeId':: d.fn(help='`google.string.withScopeId` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the scope_id field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `scope_id` field.\n', args=[]), + withScopeId(dataSrcLabel, value): { + data+: { + google_gke_hub_scope_iam_policy+: { + [dataSrcLabel]+: { + scope_id: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/data/main.libsonnet b/4.x/_gen/data/main.libsonnet index 63ef5f3..e8ebda2 100644 --- a/4.x/_gen/data/main.libsonnet +++ b/4.x/_gen/data/main.libsonnet @@ -127,6 +127,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); gke_backup_backup_plan_iam_policy: (import 'gke_backup_backup_plan_iam_policy.libsonnet'), gke_hub_feature_iam_policy: (import 'gke_hub_feature_iam_policy.libsonnet'), gke_hub_membership_iam_policy: (import 'gke_hub_membership_iam_policy.libsonnet'), + gke_hub_scope_iam_policy: (import 'gke_hub_scope_iam_policy.libsonnet'), healthcare_consent_store_iam_policy: (import 'healthcare_consent_store_iam_policy.libsonnet'), healthcare_dataset_iam_policy: (import 'healthcare_dataset_iam_policy.libsonnet'), healthcare_dicom_store_iam_policy: (import 'healthcare_dicom_store_iam_policy.libsonnet'), diff --git a/4.x/_gen/main.libsonnet b/4.x/_gen/main.libsonnet index f831fd4..63c2543 100644 --- a/4.x/_gen/main.libsonnet +++ b/4.x/_gen/main.libsonnet @@ -61,6 +61,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); beyondcorp_app_connection: (import 'resources/beyondcorp_app_connection.libsonnet'), beyondcorp_app_connector: (import 'resources/beyondcorp_app_connector.libsonnet'), beyondcorp_app_gateway: (import 'resources/beyondcorp_app_gateway.libsonnet'), + biglake_catalog: (import 'resources/biglake_catalog.libsonnet'), + biglake_database: (import 'resources/biglake_database.libsonnet'), bigquery_analytics_hub_data_exchange: (import 'resources/bigquery_analytics_hub_data_exchange.libsonnet'), bigquery_analytics_hub_data_exchange_iam_binding: (import 'resources/bigquery_analytics_hub_data_exchange_iam_binding.libsonnet'), bigquery_analytics_hub_data_exchange_iam_member: (import 'resources/bigquery_analytics_hub_data_exchange_iam_member.libsonnet'), @@ -430,9 +432,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); gke_hub_feature_iam_policy: (import 'resources/gke_hub_feature_iam_policy.libsonnet'), gke_hub_feature_membership: (import 'resources/gke_hub_feature_membership.libsonnet'), gke_hub_membership: (import 'resources/gke_hub_membership.libsonnet'), + gke_hub_membership_binding: (import 'resources/gke_hub_membership_binding.libsonnet'), gke_hub_membership_iam_binding: (import 'resources/gke_hub_membership_iam_binding.libsonnet'), gke_hub_membership_iam_member: (import 'resources/gke_hub_membership_iam_member.libsonnet'), gke_hub_membership_iam_policy: (import 'resources/gke_hub_membership_iam_policy.libsonnet'), + gke_hub_namespace: (import 'resources/gke_hub_namespace.libsonnet'), + gke_hub_scope: (import 'resources/gke_hub_scope.libsonnet'), + gke_hub_scope_iam_binding: (import 'resources/gke_hub_scope_iam_binding.libsonnet'), + gke_hub_scope_iam_member: (import 'resources/gke_hub_scope_iam_member.libsonnet'), + gke_hub_scope_iam_policy: (import 'resources/gke_hub_scope_iam_policy.libsonnet'), + gke_hub_scope_rbac_role_binding: (import 'resources/gke_hub_scope_rbac_role_binding.libsonnet'), healthcare_consent_store: (import 'resources/healthcare_consent_store.libsonnet'), healthcare_consent_store_iam_binding: (import 'resources/healthcare_consent_store_iam_binding.libsonnet'), healthcare_consent_store_iam_member: (import 'resources/healthcare_consent_store_iam_member.libsonnet'), diff --git a/4.x/_gen/provider_google.libsonnet b/4.x/_gen/provider_google.libsonnet index fbe2b0b..5ea1df7 100644 --- a/4.x/_gen/provider_google.libsonnet +++ b/4.x/_gen/provider_google.libsonnet @@ -2,7 +2,7 @@ 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='provider', url='', help='`provider` represents the `google` Terraform provider config.\n\n\n\nThis package contains functions and utilities for setting up the provider using Jsonnet code.\n'), - '#new':: d.fn(help='\n`google.provider.new` injects a new `google` Terraform `provider`\nblock into the root module document.\n\nOptionally, this inserts the provider into the\n[required_providers](https://developer.hashicorp.com/terraform/language/providers/requirements) `terraform` sub block if\nthe `src` and/or `version` parameters are set.\n\n**Args**:\n - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting provider block. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting provider block. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting provider block. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting provider block. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting provider block. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting provider block. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting provider block. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting provider block. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting provider block. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting provider block. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting provider block. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting provider block. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting provider block. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting provider block. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting provider block. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting provider block. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting provider block. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_iot_custom_endpoint` (`string`): Set the `cloud_iot_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_iot_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting provider block. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting provider block. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting provider block. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting provider block. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting provider block. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting provider block. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting provider block. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting provider block. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting provider block. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting provider block. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting provider block. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting provider block. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting provider block. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting provider block. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting provider block. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting provider block. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting provider block. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting provider block. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting provider block. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting provider block. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting provider block. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting provider block. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting provider block. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting provider block. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting provider block. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `game_services_custom_endpoint` (`string`): Set the `game_services_custom_endpoint` field on the resulting provider block. When `null`, the `game_services_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting provider block. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting provider block. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `healthcare_custom_endpoint` (`string`): Set the `healthcare_custom_endpoint` field on the resulting provider block. When `null`, the `healthcare_custom_endpoint` field will be omitted from the resulting object.\n - `iam2_custom_endpoint` (`string`): Set the `iam2_custom_endpoint` field on the resulting provider block. When `null`, the `iam2_custom_endpoint` field will be omitted from the resulting object.\n - `iam_beta_custom_endpoint` (`string`): Set the `iam_beta_custom_endpoint` field on the resulting provider block. When `null`, the `iam_beta_custom_endpoint` field will be omitted from the resulting object.\n - `iam_credentials_custom_endpoint` (`string`): Set the `iam_credentials_custom_endpoint` field on the resulting provider block. When `null`, the `iam_credentials_custom_endpoint` field will be omitted from the resulting object.\n - `iam_custom_endpoint` (`string`): Set the `iam_custom_endpoint` field on the resulting provider block. When `null`, the `iam_custom_endpoint` field will be omitted from the resulting object.\n - `iam_workforce_pool_custom_endpoint` (`string`): Set the `iam_workforce_pool_custom_endpoint` field on the resulting provider block. When `null`, the `iam_workforce_pool_custom_endpoint` field will be omitted from the resulting object.\n - `iap_custom_endpoint` (`string`): Set the `iap_custom_endpoint` field on the resulting provider block. When `null`, the `iap_custom_endpoint` field will be omitted from the resulting object.\n - `identity_platform_custom_endpoint` (`string`): Set the `identity_platform_custom_endpoint` field on the resulting provider block. When `null`, the `identity_platform_custom_endpoint` field will be omitted from the resulting object.\n - `impersonate_service_account` (`string`): Set the `impersonate_service_account` field on the resulting provider block. When `null`, the `impersonate_service_account` field will be omitted from the resulting object.\n - `impersonate_service_account_delegates` (`list`): Set the `impersonate_service_account_delegates` field on the resulting provider block. When `null`, the `impersonate_service_account_delegates` field will be omitted from the resulting object.\n - `kms_custom_endpoint` (`string`): Set the `kms_custom_endpoint` field on the resulting provider block. When `null`, the `kms_custom_endpoint` field will be omitted from the resulting object.\n - `logging_custom_endpoint` (`string`): Set the `logging_custom_endpoint` field on the resulting provider block. When `null`, the `logging_custom_endpoint` field will be omitted from the resulting object.\n - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting provider block. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting provider block. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting provider block. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting provider block. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting provider block. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting provider block. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting provider block. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting provider block. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting provider block. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting provider block. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting provider block. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting provider block. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting provider block. When `null`, the `privateca_custom_endpoint` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting provider block. When `null`, the `project` field will be omitted from the resulting object.\n - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting provider block. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting provider block. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting provider block. When `null`, the `redis_custom_endpoint` field will be omitted from the resulting object.\n - `region` (`string`): Set the `region` field on the resulting provider block. When `null`, the `region` field will be omitted from the resulting object.\n - `request_reason` (`string`): Set the `request_reason` field on the resulting provider block. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting provider block. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting provider block. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting provider block. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting provider block. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting provider block. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting provider block. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting provider block. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting provider block. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting provider block. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting provider block. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting provider block. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting provider block. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting provider block. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting provider block. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting provider block. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting provider block. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting provider block. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting provider block. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting provider block. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting provider block. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n - `alias` (`string`): The provider `alias` to set for this instance of the provider block. When `null`, the `alias`\n field will be omitted from the resulting provider block.\n - `src` (`string`): The provider `source` to set on the resulting `required_providers` block. If `src` or `version` is\n set and is not `null`, a `required_providers` block and entry for the provider will be injected into the document.\n - `version` (`string`): The provider `version` to set on the resulting `required_providers` block. If `src` or\n `version` is set and is not `null`, a `required_providers` block and entry for the provider will be injected into the\n document.\n\n\n**Returns**:\n- A mixin object that injects the new provider (and optionally, `required_providers` block) into the root Terraform configuration.\n', args=[]), + '#new':: d.fn(help='\n`google.provider.new` injects a new `google` Terraform `provider`\nblock into the root module document.\n\nOptionally, this inserts the provider into the\n[required_providers](https://developer.hashicorp.com/terraform/language/providers/requirements) `terraform` sub block if\nthe `src` and/or `version` parameters are set.\n\n**Args**:\n - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting provider block. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting provider block. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting provider block. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting provider block. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting provider block. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting provider block. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting provider block. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting provider block. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting provider block. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting provider block. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting provider block. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting provider block. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting provider block. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting provider block. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting provider block. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting provider block. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting provider block. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting provider block. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_iot_custom_endpoint` (`string`): Set the `cloud_iot_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_iot_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting provider block. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting provider block. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting provider block. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting provider block. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting provider block. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting provider block. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting provider block. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting provider block. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting provider block. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting provider block. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting provider block. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting provider block. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting provider block. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting provider block. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting provider block. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting provider block. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting provider block. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting provider block. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting provider block. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting provider block. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting provider block. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting provider block. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting provider block. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting provider block. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting provider block. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `game_services_custom_endpoint` (`string`): Set the `game_services_custom_endpoint` field on the resulting provider block. When `null`, the `game_services_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting provider block. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting provider block. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `healthcare_custom_endpoint` (`string`): Set the `healthcare_custom_endpoint` field on the resulting provider block. When `null`, the `healthcare_custom_endpoint` field will be omitted from the resulting object.\n - `iam2_custom_endpoint` (`string`): Set the `iam2_custom_endpoint` field on the resulting provider block. When `null`, the `iam2_custom_endpoint` field will be omitted from the resulting object.\n - `iam_beta_custom_endpoint` (`string`): Set the `iam_beta_custom_endpoint` field on the resulting provider block. When `null`, the `iam_beta_custom_endpoint` field will be omitted from the resulting object.\n - `iam_credentials_custom_endpoint` (`string`): Set the `iam_credentials_custom_endpoint` field on the resulting provider block. When `null`, the `iam_credentials_custom_endpoint` field will be omitted from the resulting object.\n - `iam_custom_endpoint` (`string`): Set the `iam_custom_endpoint` field on the resulting provider block. When `null`, the `iam_custom_endpoint` field will be omitted from the resulting object.\n - `iam_workforce_pool_custom_endpoint` (`string`): Set the `iam_workforce_pool_custom_endpoint` field on the resulting provider block. When `null`, the `iam_workforce_pool_custom_endpoint` field will be omitted from the resulting object.\n - `iap_custom_endpoint` (`string`): Set the `iap_custom_endpoint` field on the resulting provider block. When `null`, the `iap_custom_endpoint` field will be omitted from the resulting object.\n - `identity_platform_custom_endpoint` (`string`): Set the `identity_platform_custom_endpoint` field on the resulting provider block. When `null`, the `identity_platform_custom_endpoint` field will be omitted from the resulting object.\n - `impersonate_service_account` (`string`): Set the `impersonate_service_account` field on the resulting provider block. When `null`, the `impersonate_service_account` field will be omitted from the resulting object.\n - `impersonate_service_account_delegates` (`list`): Set the `impersonate_service_account_delegates` field on the resulting provider block. When `null`, the `impersonate_service_account_delegates` field will be omitted from the resulting object.\n - `kms_custom_endpoint` (`string`): Set the `kms_custom_endpoint` field on the resulting provider block. When `null`, the `kms_custom_endpoint` field will be omitted from the resulting object.\n - `logging_custom_endpoint` (`string`): Set the `logging_custom_endpoint` field on the resulting provider block. When `null`, the `logging_custom_endpoint` field will be omitted from the resulting object.\n - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting provider block. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting provider block. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting provider block. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting provider block. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting provider block. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting provider block. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting provider block. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting provider block. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting provider block. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting provider block. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting provider block. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting provider block. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting provider block. When `null`, the `privateca_custom_endpoint` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting provider block. When `null`, the `project` field will be omitted from the resulting object.\n - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting provider block. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting provider block. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting provider block. When `null`, the `redis_custom_endpoint` field will be omitted from the resulting object.\n - `region` (`string`): Set the `region` field on the resulting provider block. When `null`, the `region` field will be omitted from the resulting object.\n - `request_reason` (`string`): Set the `request_reason` field on the resulting provider block. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting provider block. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting provider block. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting provider block. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting provider block. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting provider block. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting provider block. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting provider block. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting provider block. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting provider block. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting provider block. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting provider block. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting provider block. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting provider block. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting provider block. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting provider block. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting provider block. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting provider block. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting provider block. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting provider block. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting provider block. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n - `alias` (`string`): The provider `alias` to set for this instance of the provider block. When `null`, the `alias`\n field will be omitted from the resulting provider block.\n - `src` (`string`): The provider `source` to set on the resulting `required_providers` block. If `src` or `version` is\n set and is not `null`, a `required_providers` block and entry for the provider will be injected into the document.\n - `version` (`string`): The provider `version` to set on the resulting `required_providers` block. If `src` or\n `version` is set and is not `null`, a `required_providers` block and entry for the provider will be injected into the\n document.\n\n\n**Returns**:\n- A mixin object that injects the new provider (and optionally, `required_providers` block) into the root Terraform configuration.\n', args=[]), new( access_approval_custom_endpoint=null, access_context_manager_custom_endpoint=null, @@ -17,6 +17,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); batching=null, beyondcorp_custom_endpoint=null, big_query_custom_endpoint=null, + biglake_custom_endpoint=null, bigquery_analytics_hub_custom_endpoint=null, bigquery_connection_custom_endpoint=null, bigquery_data_transfer_custom_endpoint=null, @@ -155,6 +156,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); batching=batching, beyondcorp_custom_endpoint=beyondcorp_custom_endpoint, big_query_custom_endpoint=big_query_custom_endpoint, + biglake_custom_endpoint=biglake_custom_endpoint, bigquery_analytics_hub_custom_endpoint=bigquery_analytics_hub_custom_endpoint, bigquery_connection_custom_endpoint=bigquery_connection_custom_endpoint, bigquery_data_transfer_custom_endpoint=bigquery_data_transfer_custom_endpoint, @@ -273,7 +275,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); zone=zone ) ), - '#newAttrs':: d.fn(help='\n`google.provider.` constructs a new object with attributes and blocks configured for the `google`\nTerraform `provider`.\n\nUnlike [google.provider.new](#fn-googlenew), this function will not inject the `provider`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) 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 - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting object. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting object. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting object. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting object. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting object. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting object. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting object. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting object. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting object. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting object. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting object. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting object. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting object. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting object. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting object. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting object. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting object. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting object. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting object. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting object. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting object. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting object. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting object. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting object. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting object. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting object. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting object. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_iot_custom_endpoint` (`string`): Set the `cloud_iot_custom_endpoint` field on the resulting object. When `null`, the `cloud_iot_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting object. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting object. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting object. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting object. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting object. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting object. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting object. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting object. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting object. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting object. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting object. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting object. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting object. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting object. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting object. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting object. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting object. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting object. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting object. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting object. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting object. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting object. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting object. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting object. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting object. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting object. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting object. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting object. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting object. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting object. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting object. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting object. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting object. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting object. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `game_services_custom_endpoint` (`string`): Set the `game_services_custom_endpoint` field on the resulting object. When `null`, the `game_services_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting object. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting object. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting object. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting object. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `healthcare_custom_endpoint` (`string`): Set the `healthcare_custom_endpoint` field on the resulting object. When `null`, the `healthcare_custom_endpoint` field will be omitted from the resulting object.\n - `iam2_custom_endpoint` (`string`): Set the `iam2_custom_endpoint` field on the resulting object. When `null`, the `iam2_custom_endpoint` field will be omitted from the resulting object.\n - `iam_beta_custom_endpoint` (`string`): Set the `iam_beta_custom_endpoint` field on the resulting object. When `null`, the `iam_beta_custom_endpoint` field will be omitted from the resulting object.\n - `iam_credentials_custom_endpoint` (`string`): Set the `iam_credentials_custom_endpoint` field on the resulting object. When `null`, the `iam_credentials_custom_endpoint` field will be omitted from the resulting object.\n - `iam_custom_endpoint` (`string`): Set the `iam_custom_endpoint` field on the resulting object. When `null`, the `iam_custom_endpoint` field will be omitted from the resulting object.\n - `iam_workforce_pool_custom_endpoint` (`string`): Set the `iam_workforce_pool_custom_endpoint` field on the resulting object. When `null`, the `iam_workforce_pool_custom_endpoint` field will be omitted from the resulting object.\n - `iap_custom_endpoint` (`string`): Set the `iap_custom_endpoint` field on the resulting object. When `null`, the `iap_custom_endpoint` field will be omitted from the resulting object.\n - `identity_platform_custom_endpoint` (`string`): Set the `identity_platform_custom_endpoint` field on the resulting object. When `null`, the `identity_platform_custom_endpoint` field will be omitted from the resulting object.\n - `impersonate_service_account` (`string`): Set the `impersonate_service_account` field on the resulting object. When `null`, the `impersonate_service_account` field will be omitted from the resulting object.\n - `impersonate_service_account_delegates` (`list`): Set the `impersonate_service_account_delegates` field on the resulting object. When `null`, the `impersonate_service_account_delegates` field will be omitted from the resulting object.\n - `kms_custom_endpoint` (`string`): Set the `kms_custom_endpoint` field on the resulting object. When `null`, the `kms_custom_endpoint` field will be omitted from the resulting object.\n - `logging_custom_endpoint` (`string`): Set the `logging_custom_endpoint` field on the resulting object. When `null`, the `logging_custom_endpoint` field will be omitted from the resulting object.\n - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting object. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting object. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting object. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting object. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting object. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting object. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting object. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting object. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting object. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting object. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting object. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting object. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting object. When `null`, the `privateca_custom_endpoint` 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 - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting object. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting object. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting object. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting object. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting object. When `null`, the `redis_custom_endpoint` field will be omitted from the resulting object.\n - `region` (`string`): Set the `region` field on the resulting object. When `null`, the `region` field will be omitted from the resulting object.\n - `request_reason` (`string`): Set the `request_reason` field on the resulting object. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting object. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting object. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting object. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting object. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting object. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting object. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting object. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting object. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting object. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting object. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting object. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting object. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting object. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting object. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting object. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting object. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting object. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting object. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting object. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting object. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting object. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) to construct a new `google` provider\n configuration into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.provider.` constructs a new object with attributes and blocks configured for the `google`\nTerraform `provider`.\n\nUnlike [google.provider.new](#fn-googlenew), this function will not inject the `provider`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) 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 - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting object. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting object. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting object. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting object. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting object. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting object. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting object. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting object. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting object. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting object. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting object. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting object. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting object. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting object. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting object. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting object. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting object. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting object. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting object. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting object. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting object. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting object. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting object. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting object. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting object. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting object. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting object. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting object. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_iot_custom_endpoint` (`string`): Set the `cloud_iot_custom_endpoint` field on the resulting object. When `null`, the `cloud_iot_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting object. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting object. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting object. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting object. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting object. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting object. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting object. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting object. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting object. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting object. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting object. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting object. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting object. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting object. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting object. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting object. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting object. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting object. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting object. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting object. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting object. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting object. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting object. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting object. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting object. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting object. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting object. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting object. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting object. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting object. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting object. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting object. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting object. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting object. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `game_services_custom_endpoint` (`string`): Set the `game_services_custom_endpoint` field on the resulting object. When `null`, the `game_services_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting object. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting object. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting object. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting object. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `healthcare_custom_endpoint` (`string`): Set the `healthcare_custom_endpoint` field on the resulting object. When `null`, the `healthcare_custom_endpoint` field will be omitted from the resulting object.\n - `iam2_custom_endpoint` (`string`): Set the `iam2_custom_endpoint` field on the resulting object. When `null`, the `iam2_custom_endpoint` field will be omitted from the resulting object.\n - `iam_beta_custom_endpoint` (`string`): Set the `iam_beta_custom_endpoint` field on the resulting object. When `null`, the `iam_beta_custom_endpoint` field will be omitted from the resulting object.\n - `iam_credentials_custom_endpoint` (`string`): Set the `iam_credentials_custom_endpoint` field on the resulting object. When `null`, the `iam_credentials_custom_endpoint` field will be omitted from the resulting object.\n - `iam_custom_endpoint` (`string`): Set the `iam_custom_endpoint` field on the resulting object. When `null`, the `iam_custom_endpoint` field will be omitted from the resulting object.\n - `iam_workforce_pool_custom_endpoint` (`string`): Set the `iam_workforce_pool_custom_endpoint` field on the resulting object. When `null`, the `iam_workforce_pool_custom_endpoint` field will be omitted from the resulting object.\n - `iap_custom_endpoint` (`string`): Set the `iap_custom_endpoint` field on the resulting object. When `null`, the `iap_custom_endpoint` field will be omitted from the resulting object.\n - `identity_platform_custom_endpoint` (`string`): Set the `identity_platform_custom_endpoint` field on the resulting object. When `null`, the `identity_platform_custom_endpoint` field will be omitted from the resulting object.\n - `impersonate_service_account` (`string`): Set the `impersonate_service_account` field on the resulting object. When `null`, the `impersonate_service_account` field will be omitted from the resulting object.\n - `impersonate_service_account_delegates` (`list`): Set the `impersonate_service_account_delegates` field on the resulting object. When `null`, the `impersonate_service_account_delegates` field will be omitted from the resulting object.\n - `kms_custom_endpoint` (`string`): Set the `kms_custom_endpoint` field on the resulting object. When `null`, the `kms_custom_endpoint` field will be omitted from the resulting object.\n - `logging_custom_endpoint` (`string`): Set the `logging_custom_endpoint` field on the resulting object. When `null`, the `logging_custom_endpoint` field will be omitted from the resulting object.\n - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting object. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting object. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting object. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting object. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting object. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting object. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting object. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting object. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting object. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting object. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting object. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting object. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting object. When `null`, the `privateca_custom_endpoint` 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 - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting object. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting object. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting object. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting object. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting object. When `null`, the `redis_custom_endpoint` field will be omitted from the resulting object.\n - `region` (`string`): Set the `region` field on the resulting object. When `null`, the `region` field will be omitted from the resulting object.\n - `request_reason` (`string`): Set the `request_reason` field on the resulting object. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting object. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting object. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting object. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting object. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting object. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting object. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting object. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting object. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting object. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting object. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting object. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting object. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting object. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting object. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting object. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting object. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting object. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting object. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting object. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting object. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting object. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) to construct a new `google` provider\n configuration into the root Terraform configuration.\n', args=[]), newAttrs( access_approval_custom_endpoint=null, access_context_manager_custom_endpoint=null, @@ -288,6 +290,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); batching=null, beyondcorp_custom_endpoint=null, big_query_custom_endpoint=null, + biglake_custom_endpoint=null, bigquery_analytics_hub_custom_endpoint=null, bigquery_connection_custom_endpoint=null, bigquery_data_transfer_custom_endpoint=null, @@ -418,6 +421,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); batching: batching, beyondcorp_custom_endpoint: beyondcorp_custom_endpoint, big_query_custom_endpoint: big_query_custom_endpoint, + biglake_custom_endpoint: biglake_custom_endpoint, bigquery_analytics_hub_custom_endpoint: bigquery_analytics_hub_custom_endpoint, bigquery_connection_custom_endpoint: bigquery_connection_custom_endpoint, bigquery_data_transfer_custom_endpoint: bigquery_data_transfer_custom_endpoint, diff --git a/4.x/_gen/resources/biglake_catalog.libsonnet b/4.x/_gen/resources/biglake_catalog.libsonnet new file mode 100644 index 0000000..5d75c87 --- /dev/null +++ b/4.x/_gen/resources/biglake_catalog.libsonnet @@ -0,0 +1,96 @@ +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='biglake_catalog', url='', help='`biglake_catalog` represents the `google_biglake_catalog` 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.biglake_catalog.new` injects a new `google_biglake_catalog` 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.biglake_catalog.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.biglake_catalog` using the reference:\n\n $._ref.google_biglake_catalog.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_biglake_catalog.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 - `location` (`string`): The geographic location where the Catalog should reside.\n - `name` (`string`): The name of the Catalog. Format:\nprojects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}\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 - `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.biglake_catalog.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, + location, + name, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_biglake_catalog', + label=resourceLabel, + attrs=self.newAttrs( + location=location, + name=name, + project=project, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.biglake_catalog.newAttrs` constructs a new object with attributes and blocks configured for the `biglake_catalog`\nTerraform resource.\n\nUnlike [google.biglake_catalog.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 - `location` (`string`): The geographic location where the Catalog should reside.\n - `name` (`string`): The name of the Catalog. Format:\nprojects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` 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.biglake_catalog.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 `biglake_catalog` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + location, + name, + project=null, + timeouts=null + ):: std.prune(a={ + location: location, + name: name, + project: project, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.biglake_catalog.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, + }), + }, + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location 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 `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_biglake_catalog+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the 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 `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_biglake_catalog+: { + [resourceLabel]+: { + name: 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_biglake_catalog+: { + [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_biglake_catalog+: { + [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_biglake_catalog+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/biglake_database.libsonnet b/4.x/_gen/resources/biglake_database.libsonnet new file mode 100644 index 0000000..0305665 --- /dev/null +++ b/4.x/_gen/resources/biglake_database.libsonnet @@ -0,0 +1,132 @@ +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='biglake_database', url='', help='`biglake_database` represents the `google_biglake_database` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + hive_options:: { + '#new':: d.fn(help='\n`google.biglake_database.hive_options.new` constructs a new object with attributes and blocks configured for the `hive_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `location_uri` (`string`): Cloud Storage folder URI where the database data is stored, starting with "gs://". When `null`, the `location_uri` field will be omitted from the resulting object.\n - `parameters` (`obj`): Stores user supplied Hive database parameters. An object containing a\nlist of"key": value pairs.\nExample: { "name": "wrench", "mass": "1.3kg", "count": "3" }. When `null`, the `parameters` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `hive_options` sub block.\n', args=[]), + new( + location_uri=null, + parameters=null + ):: std.prune(a={ + location_uri: location_uri, + parameters: parameters, + }), + }, + '#new':: d.fn(help="\n`google.biglake_database.new` injects a new `google_biglake_database` 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.biglake_database.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.biglake_database` using the reference:\n\n $._ref.google_biglake_database.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_biglake_database.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 - `catalog` (`string`): The parent catalog.\n - `name` (`string`): The name of the database.\n - `type` (`string`): The database type.\n - `hive_options` (`list[obj]`): Options of a Hive database. When `null`, the `hive_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.biglake_database.hive_options.new](#fn-hive_optionsnew) 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.biglake_database.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, + catalog, + name, + type, + hive_options=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_biglake_database', + label=resourceLabel, + attrs=self.newAttrs( + catalog=catalog, + hive_options=hive_options, + name=name, + timeouts=timeouts, + type=type + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.biglake_database.newAttrs` constructs a new object with attributes and blocks configured for the `biglake_database`\nTerraform resource.\n\nUnlike [google.biglake_database.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 - `catalog` (`string`): The parent catalog.\n - `name` (`string`): The name of the database.\n - `type` (`string`): The database type.\n - `hive_options` (`list[obj]`): Options of a Hive database. When `null`, the `hive_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.biglake_database.hive_options.new](#fn-hive_optionsnew) 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.biglake_database.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 `biglake_database` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + catalog, + name, + type, + hive_options=null, + timeouts=null + ):: std.prune(a={ + catalog: catalog, + hive_options: hive_options, + name: name, + timeouts: timeouts, + type: type, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.biglake_database.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, + }), + }, + '#withCatalog':: d.fn(help='`google.string.withCatalog` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the catalog 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 `catalog` field.\n', args=[]), + withCatalog(resourceLabel, value): { + resource+: { + google_biglake_database+: { + [resourceLabel]+: { + catalog: value, + }, + }, + }, + }, + '#withHiveOptions':: d.fn(help='`google.list[obj].withHiveOptions` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the hive_options 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].withHiveOptionsMixin](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 `hive_options` field.\n', args=[]), + withHiveOptions(resourceLabel, value): { + resource+: { + google_biglake_database+: { + [resourceLabel]+: { + hive_options: value, + }, + }, + }, + }, + '#withHiveOptionsMixin':: d.fn(help='`google.list[obj].withHiveOptionsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the hive_options 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].withHiveOptions](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 `hive_options` field.\n', args=[]), + withHiveOptionsMixin(resourceLabel, value): { + resource+: { + google_biglake_database+: { + [resourceLabel]+: { + hive_options+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the 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 `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_biglake_database+: { + [resourceLabel]+: { + name: 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_biglake_database+: { + [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_biglake_database+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withType':: d.fn(help='`google.string.withType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the type 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 `type` field.\n', args=[]), + withType(resourceLabel, value): { + resource+: { + google_biglake_database+: { + [resourceLabel]+: { + type: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/cloud_run_v2_job.libsonnet b/4.x/_gen/resources/cloud_run_v2_job.libsonnet index c05605f..9c54952 100644 --- a/4.x/_gen/resources/cloud_run_v2_job.libsonnet +++ b/4.x/_gen/resources/cloud_run_v2_job.libsonnet @@ -306,11 +306,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), secret:: { items:: { - '#new':: d.fn(help='\n`google.cloud_run_v2_job.template.template.volumes.secret.items.new` constructs a new object with attributes and blocks configured for the `items`\nTerraform sub block.\n\n\n\n**Args**:\n - `mode` (`number`): Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used.\n - `path` (`string`): The relative path of the secret in the container.\n - `version` (`string`): The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version\n\n**Returns**:\n - An attribute object that represents the `items` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.cloud_run_v2_job.template.template.volumes.secret.items.new` constructs a new object with attributes and blocks configured for the `items`\nTerraform sub block.\n\n\n\n**Args**:\n - `mode` (`number`): Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. When `null`, the `mode` field will be omitted from the resulting object.\n - `path` (`string`): The relative path of the secret in the container.\n - `version` (`string`): The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version\n\n**Returns**:\n - An attribute object that represents the `items` sub block.\n', args=[]), new( - mode, path, - version + version, + mode=null ):: std.prune(a={ mode: mode, path: path, diff --git a/4.x/_gen/resources/cloud_run_v2_service.libsonnet b/4.x/_gen/resources/cloud_run_v2_service.libsonnet index 82cb26a..9fa7524 100644 --- a/4.x/_gen/resources/cloud_run_v2_service.libsonnet +++ b/4.x/_gen/resources/cloud_run_v2_service.libsonnet @@ -355,10 +355,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), secret:: { items:: { - '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.volumes.secret.items.new` constructs a new object with attributes and blocks configured for the `items`\nTerraform sub block.\n\n\n\n**Args**:\n - `mode` (`number`): Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used.\n - `path` (`string`): The relative path of the secret in the container.\n - `version` (`string`): The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `items` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.cloud_run_v2_service.template.volumes.secret.items.new` constructs a new object with attributes and blocks configured for the `items`\nTerraform sub block.\n\n\n\n**Args**:\n - `mode` (`number`): Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. When `null`, the `mode` field will be omitted from the resulting object.\n - `path` (`string`): The relative path of the secret in the container.\n - `version` (`string`): The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `items` sub block.\n', args=[]), new( - mode, path, + mode=null, version=null ):: std.prune(a={ mode: mode, diff --git a/4.x/_gen/resources/compute_region_target_https_proxy.libsonnet b/4.x/_gen/resources/compute_region_target_https_proxy.libsonnet index 3b69aaf..fc85561 100644 --- a/4.x/_gen/resources/compute_region_target_https_proxy.libsonnet +++ b/4.x/_gen/resources/compute_region_target_https_proxy.libsonnet @@ -2,7 +2,7 @@ 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_region_target_https_proxy', url='', help='`compute_region_target_https_proxy` represents the `google_compute_region_target_https_proxy` 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.compute_region_target_https_proxy.new` injects a new `google_compute_region_target_https_proxy` 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_region_target_https_proxy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_region_target_https_proxy` using the reference:\n\n $._ref.google_compute_region_target_https_proxy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_region_target_https_proxy.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. When `null`, the `description` 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 - `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 in which the created target https proxy should reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of RegionSslCertificate resources that are used to authenticate\nconnections between users and the load balancer. Currently, exactly\none SSL certificate must be specified.\n - `url_map` (`string`): A reference to the RegionUrlMap resource that defines the mapping from URL\nto the RegionBackendService.\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_region_target_https_proxy.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_region_target_https_proxy.new` injects a new `google_compute_region_target_https_proxy` 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_region_target_https_proxy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_region_target_https_proxy` using the reference:\n\n $._ref.google_compute_region_target_https_proxy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_region_target_https_proxy.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. When `null`, the `description` 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 - `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 in which the created target https proxy should reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of RegionSslCertificate resources that are used to authenticate\nconnections between users and the load balancer. Currently, exactly\none SSL certificate must be specified.\n - `ssl_policy` (`string`): A reference to the Region SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the RegionUrlMap resource that defines the mapping from URL\nto the RegionBackendService.\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_region_target_https_proxy.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, @@ -11,6 +11,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); description=null, project=null, region=null, + ssl_policy=null, timeouts=null, _meta={} ):: tf.withResource( @@ -22,12 +23,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); project=project, region=region, ssl_certificates=ssl_certificates, + ssl_policy=ssl_policy, timeouts=timeouts, url_map=url_map ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.compute_region_target_https_proxy.newAttrs` constructs a new object with attributes and blocks configured for the `compute_region_target_https_proxy`\nTerraform resource.\n\nUnlike [google.compute_region_target_https_proxy.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. When `null`, the `description` 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 - `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 in which the created target https proxy should reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of RegionSslCertificate resources that are used to authenticate\nconnections between users and the load balancer. Currently, exactly\none SSL certificate must be specified.\n - `url_map` (`string`): A reference to the RegionUrlMap resource that defines the mapping from URL\nto the RegionBackendService.\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_region_target_https_proxy.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_region_target_https_proxy` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.compute_region_target_https_proxy.newAttrs` constructs a new object with attributes and blocks configured for the `compute_region_target_https_proxy`\nTerraform resource.\n\nUnlike [google.compute_region_target_https_proxy.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. When `null`, the `description` 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 - `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 in which the created target https proxy should reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of RegionSslCertificate resources that are used to authenticate\nconnections between users and the load balancer. Currently, exactly\none SSL certificate must be specified.\n - `ssl_policy` (`string`): A reference to the Region SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the RegionUrlMap resource that defines the mapping from URL\nto the RegionBackendService.\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_region_target_https_proxy.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_region_target_https_proxy` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, ssl_certificates, @@ -35,6 +37,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); description=null, project=null, region=null, + ssl_policy=null, timeouts=null ):: std.prune(a={ description: description, @@ -42,6 +45,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); project: project, region: region, ssl_certificates: ssl_certificates, + ssl_policy: ssl_policy, timeouts: timeouts, url_map: url_map, }), @@ -107,6 +111,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSslPolicy':: d.fn(help='`google.string.withSslPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the ssl_policy 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 `ssl_policy` field.\n', args=[]), + withSslPolicy(resourceLabel, value): { + resource+: { + google_compute_region_target_https_proxy+: { + [resourceLabel]+: { + ssl_policy: 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+: { diff --git a/4.x/_gen/resources/container_cluster.libsonnet b/4.x/_gen/resources/container_cluster.libsonnet index 272d93a..6fd4260 100644 --- a/4.x/_gen/resources/container_cluster.libsonnet +++ b/4.x/_gen/resources/container_cluster.libsonnet @@ -738,6 +738,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); threads_per_core: threads_per_core, }), }, + confidential_nodes:: { + '#new':: d.fn(help='\n`google.container_cluster.node_config.confidential_nodes.new` constructs a new object with attributes and blocks configured for the `confidential_nodes`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether Confidential Nodes feature is enabled for all nodes in this pool.\n\n**Returns**:\n - An attribute object that represents the `confidential_nodes` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, ephemeral_storage_local_ssd_config:: { '#new':: d.fn(help='\n`google.container_cluster.node_config.ephemeral_storage_local_ssd_config.new` constructs a new object with attributes and blocks configured for the `ephemeral_storage_local_ssd_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `local_ssd_count` (`number`): Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD must be 375 or 3000 GB in size, and all local SSDs must share the same size.\n\n**Returns**:\n - An attribute object that represents the `ephemeral_storage_local_ssd_config` sub block.\n', args=[]), new( @@ -800,10 +808,11 @@ 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 - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` 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.host_maintenance_policy.new](#fn-node_confighost_maintenance_policynew) 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':: 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 - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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.confidential_nodes.new](#fn-node_configconfidential_nodesnew) 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 - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` 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.host_maintenance_policy.new](#fn-node_confighost_maintenance_policynew) 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, + confidential_nodes=null, disk_size_gb=null, disk_type=null, ephemeral_storage_local_ssd_config=null, @@ -836,6 +845,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ):: std.prune(a={ advanced_machine_features: advanced_machine_features, boot_disk_kms_key: boot_disk_kms_key, + confidential_nodes: confidential_nodes, disk_size_gb: disk_size_gb, disk_type: disk_type, ephemeral_storage_local_ssd_config: ephemeral_storage_local_ssd_config, @@ -1007,6 +1017,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); threads_per_core: threads_per_core, }), }, + confidential_nodes:: { + '#new':: d.fn(help='\n`google.container_cluster.node_pool.node_config.confidential_nodes.new` constructs a new object with attributes and blocks configured for the `confidential_nodes`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether Confidential Nodes feature is enabled for all nodes in this pool.\n\n**Returns**:\n - An attribute object that represents the `confidential_nodes` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, ephemeral_storage_local_ssd_config:: { '#new':: d.fn(help='\n`google.container_cluster.node_pool.node_config.ephemeral_storage_local_ssd_config.new` constructs a new object with attributes and blocks configured for the `ephemeral_storage_local_ssd_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `local_ssd_count` (`number`): Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD must be 375 or 3000 GB in size, and all local SSDs must share the same size.\n\n**Returns**:\n - An attribute object that represents the `ephemeral_storage_local_ssd_config` sub block.\n', args=[]), new( @@ -1069,10 +1087,11 @@ 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 - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` 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.host_maintenance_policy.new](#fn-node_poolnode_poolhost_maintenance_policynew) 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':: 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 - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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.confidential_nodes.new](#fn-node_poolnode_poolconfidential_nodesnew) 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 - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` 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.host_maintenance_policy.new](#fn-node_poolnode_poolhost_maintenance_policynew) 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, + confidential_nodes=null, disk_size_gb=null, disk_type=null, ephemeral_storage_local_ssd_config=null, @@ -1105,6 +1124,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ):: std.prune(a={ advanced_machine_features: advanced_machine_features, boot_disk_kms_key: boot_disk_kms_key, + confidential_nodes: confidential_nodes, disk_size_gb: disk_size_gb, disk_type: disk_type, ephemeral_storage_local_ssd_config: ephemeral_storage_local_ssd_config, diff --git a/4.x/_gen/resources/container_node_pool.libsonnet b/4.x/_gen/resources/container_node_pool.libsonnet index 3eb9bea..1a2afe1 100644 --- a/4.x/_gen/resources/container_node_pool.libsonnet +++ b/4.x/_gen/resources/container_node_pool.libsonnet @@ -144,6 +144,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); threads_per_core: threads_per_core, }), }, + confidential_nodes:: { + '#new':: d.fn(help='\n`google.container_node_pool.node_config.confidential_nodes.new` constructs a new object with attributes and blocks configured for the `confidential_nodes`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether Confidential Nodes feature is enabled for all nodes in this pool.\n\n**Returns**:\n - An attribute object that represents the `confidential_nodes` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, ephemeral_storage_local_ssd_config:: { '#new':: d.fn(help='\n`google.container_node_pool.node_config.ephemeral_storage_local_ssd_config.new` constructs a new object with attributes and blocks configured for the `ephemeral_storage_local_ssd_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `local_ssd_count` (`number`): Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD must be 375 or 3000 GB in size, and all local SSDs must share the same size.\n\n**Returns**:\n - An attribute object that represents the `ephemeral_storage_local_ssd_config` sub block.\n', args=[]), new( @@ -206,10 +214,11 @@ 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 - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` 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.host_maintenance_policy.new](#fn-node_confighost_maintenance_policynew) 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':: 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 - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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.confidential_nodes.new](#fn-node_configconfidential_nodesnew) 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 - `host_maintenance_policy` (`list[obj]`): The maintenance policy for the hosts on which the GKE VMs run on. When `null`, the `host_maintenance_policy` 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.host_maintenance_policy.new](#fn-node_confighost_maintenance_policynew) 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, + confidential_nodes=null, disk_size_gb=null, disk_type=null, ephemeral_storage_local_ssd_config=null, @@ -242,6 +251,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ):: std.prune(a={ advanced_machine_features: advanced_machine_features, boot_disk_kms_key: boot_disk_kms_key, + confidential_nodes: confidential_nodes, disk_size_gb: disk_size_gb, disk_type: disk_type, ephemeral_storage_local_ssd_config: ephemeral_storage_local_ssd_config, diff --git a/4.x/_gen/resources/dialogflow_cx_flow.libsonnet b/4.x/_gen/resources/dialogflow_cx_flow.libsonnet index 834191f..e5ea92e 100644 --- a/4.x/_gen/resources/dialogflow_cx_flow.libsonnet +++ b/4.x/_gen/resources/dialogflow_cx_flow.libsonnet @@ -16,13 +16,77 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); trigger_fulfillment: trigger_fulfillment, }), trigger_fulfillment:: { + conditional_cases:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases`\nTerraform sub block.\n\n\n\n**Args**:\n - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.\nSee [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conditional_cases` sub block.\n', args=[]), + new( + cases=null + ):: std.prune(a={ + cases: cases, + }), + }, messages:: { - '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.text.new](#fn-event_handlersevent_handlerstrigger_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), + conversation_success:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conversation_success` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + live_agent_handoff:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `live_agent_handoff` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object.\n - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object.\n - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.\nDialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.\n* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.conversation_success.new](#fn-event_handlersevent_handlerstrigger_fulfillmentconversation_successnew) constructor.\n - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent.\nDialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.\n* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.live_agent_handoff.new](#fn-event_handlersevent_handlerstrigger_fulfillmentlive_agent_handoffnew) constructor.\n - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.output_audio_text.new](#fn-event_handlersevent_handlerstrigger_fulfillmentoutput_audio_textnew) constructor.\n - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.play_audio.new](#fn-event_handlersevent_handlerstrigger_fulfillmentplay_audionew) constructor.\n - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new](#fn-event_handlersevent_handlerstrigger_fulfillmenttelephony_transfer_callnew) constructor.\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.text.new](#fn-event_handlersevent_handlerstrigger_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), new( + channel=null, + conversation_success=null, + live_agent_handoff=null, + output_audio_text=null, + payload=null, + play_audio=null, + telephony_transfer_call=null, text=null ):: std.prune(a={ + channel: channel, + conversation_success: conversation_success, + live_agent_handoff: live_agent_handoff, + output_audio_text: output_audio_text, + payload: payload, + play_audio: play_audio, + telephony_transfer_call: telephony_transfer_call, text: text, }), + output_audio_text:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text`\nTerraform sub block.\n\n\n\n**Args**:\n - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object.\n - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `output_audio_text` sub block.\n', args=[]), + new( + ssml=null, + text=null + ):: std.prune(a={ + ssml: ssml, + text: text, + }), + }, + play_audio:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio`\nTerraform sub block.\n\n\n\n**Args**:\n - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.\n\n**Returns**:\n - An attribute object that represents the `play_audio` sub block.\n', args=[]), + new( + audio_uri + ):: std.prune(a={ + audio_uri: audio_uri, + }), + }, + telephony_transfer_call:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call`\nTerraform sub block.\n\n\n\n**Args**:\n - `phone_number` (`string`): Transfer the call to a phone number in E.164 format.\n\n**Returns**:\n - An attribute object that represents the `telephony_transfer_call` sub block.\n', args=[]), + new( + phone_number + ):: std.prune(a={ + phone_number: phone_number, + }), + }, text:: { '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list`): A collection of text responses. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `text` sub block.\n', args=[]), new( @@ -32,18 +96,32 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.new](#fn-event_handlersevent_handlersmessagesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `trigger_fulfillment` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.conditional_cases.new](#fn-event_handlersevent_handlersconditional_casesnew) constructor.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.new](#fn-event_handlersevent_handlersmessagesnew) constructor.\n - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_flow.event_handlers.trigger_fulfillment.set_parameter_actions.new](#fn-event_handlersevent_handlersset_parameter_actionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `trigger_fulfillment` sub block.\n', args=[]), new( + conditional_cases=null, messages=null, return_partial_responses=null, + set_parameter_actions=null, tag=null, webhook=null ):: std.prune(a={ + conditional_cases: conditional_cases, messages: messages, return_partial_responses: return_partial_responses, + set_parameter_actions: set_parameter_actions, tag: tag, webhook: webhook, }), + set_parameter_actions:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object.\n - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `set_parameter_actions` sub block.\n', args=[]), + new( + parameter=null, + value=null + ):: std.prune(a={ + parameter: parameter, + value: value, + }), + }, }, }, '#new':: d.fn(help="\n`google.dialogflow_cx_flow.new` injects a new `google_dialogflow_cx_flow` 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.dialogflow_cx_flow.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.dialogflow_cx_flow` using the reference:\n\n $._ref.google_dialogflow_cx_flow.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_dialogflow_cx_flow.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 flow. The maximum length is 500 characters. If exceeded, the request is rejected. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable name of the flow.\n - `language_code` (`string`): The language of the following fields in flow:\nFlow.event_handlers.trigger_fulfillment.messages\nFlow.event_handlers.trigger_fulfillment.conditional_cases\nFlow.transition_routes.trigger_fulfillment.messages\nFlow.transition_routes.trigger_fulfillment.conditional_cases\nIf not specified, the agent\u0026#39;s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. When `null`, the `language_code` field will be omitted from the resulting object.\n - `parent` (`string`): The agent to create a flow for.\nFormat: projects/\u0026lt;Project ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/agents/\u0026lt;Agent ID\u0026gt;. When `null`, the `parent` field will be omitted from the resulting object.\n - `transition_route_groups` (`list`): A flow\u0026#39;s transition route group serve two purposes:\nThey are responsible for matching the user\u0026#39;s first utterances in the flow.\nThey are inherited by every page\u0026#39;s [transition route groups][Page.transition_route_groups]. Transition route groups defined in the page have higher priority than those defined in the flow.\nFormat:projects/\u0026lt;Project ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/agents/\u0026lt;Agent ID\u0026gt;/flows/\u0026lt;Flow ID\u0026gt;/transitionRouteGroups/\u0026lt;TransitionRouteGroup ID\u0026gt;. When `null`, the `transition_route_groups` field will be omitted from the resulting object.\n - `event_handlers` (`list[obj]`): A flow\u0026#39;s event handlers serve two purposes:\nThey are responsible for handling events (e.g. no match, webhook errors) in the flow.\nThey are inherited by every page\u0026#39;s [event handlers][Page.event_handlers], which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.\nUnlike transitionRoutes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. When `null`, the `event_handlers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.new](#fn-event_handlersnew) constructor.\n - `nlu_settings` (`list[obj]`): NLU related settings of the flow. When `null`, the `nlu_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.dialogflow_cx_flow.nlu_settings.new](#fn-nlu_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.dialogflow_cx_flow.timeouts.new](#fn-timeoutsnew) constructor.\n - `transition_routes` (`list[obj]`): A flow\u0026#39;s transition routes serve two purposes:\nThey are responsible for matching the user\u0026#39;s first utterances in the flow.\nThey are inherited by every page\u0026#39;s [transition routes][Page.transition_routes] and can support use cases such as the user saying \u0026#34;help\u0026#34; or \u0026#34;can I talk to a human?\u0026#34;, which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.\n\nTransitionRoutes are evalauted in the following order:\n TransitionRoutes with intent specified.\n TransitionRoutes with only condition specified.\n TransitionRoutes with intent specified are inherited by pages in the flow. When `null`, the `transition_routes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.new](#fn-transition_routesnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), @@ -137,13 +215,77 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); trigger_fulfillment: trigger_fulfillment, }), trigger_fulfillment:: { + conditional_cases:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases`\nTerraform sub block.\n\n\n\n**Args**:\n - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.\nSee [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conditional_cases` sub block.\n', args=[]), + new( + cases=null + ):: std.prune(a={ + cases: cases, + }), + }, messages:: { - '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.text.new](#fn-transition_routestransition_routestrigger_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), + conversation_success:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conversation_success` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + live_agent_handoff:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `live_agent_handoff` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object.\n - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object.\n - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.\nDialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.\n* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.conversation_success.new](#fn-transition_routestransition_routestrigger_fulfillmentconversation_successnew) constructor.\n - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent.\nDialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.\n* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.live_agent_handoff.new](#fn-transition_routestransition_routestrigger_fulfillmentlive_agent_handoffnew) constructor.\n - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.output_audio_text.new](#fn-transition_routestransition_routestrigger_fulfillmentoutput_audio_textnew) constructor.\n - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.play_audio.new](#fn-transition_routestransition_routestrigger_fulfillmentplay_audionew) constructor.\n - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new](#fn-transition_routestransition_routestrigger_fulfillmenttelephony_transfer_callnew) constructor.\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.text.new](#fn-transition_routestransition_routestrigger_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), new( + channel=null, + conversation_success=null, + live_agent_handoff=null, + output_audio_text=null, + payload=null, + play_audio=null, + telephony_transfer_call=null, text=null ):: std.prune(a={ + channel: channel, + conversation_success: conversation_success, + live_agent_handoff: live_agent_handoff, + output_audio_text: output_audio_text, + payload: payload, + play_audio: play_audio, + telephony_transfer_call: telephony_transfer_call, text: text, }), + output_audio_text:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text`\nTerraform sub block.\n\n\n\n**Args**:\n - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object.\n - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `output_audio_text` sub block.\n', args=[]), + new( + ssml=null, + text=null + ):: std.prune(a={ + ssml: ssml, + text: text, + }), + }, + play_audio:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio`\nTerraform sub block.\n\n\n\n**Args**:\n - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.\n\n**Returns**:\n - An attribute object that represents the `play_audio` sub block.\n', args=[]), + new( + audio_uri + ):: std.prune(a={ + audio_uri: audio_uri, + }), + }, + telephony_transfer_call:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call`\nTerraform sub block.\n\n\n\n**Args**:\n - `phone_number` (`string`): Transfer the call to a phone number in E.164 format.\n\n**Returns**:\n - An attribute object that represents the `telephony_transfer_call` sub block.\n', args=[]), + new( + phone_number + ):: std.prune(a={ + phone_number: phone_number, + }), + }, text:: { '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list`): A collection of text responses. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `text` sub block.\n', args=[]), new( @@ -153,18 +295,32 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.new](#fn-transition_routestransition_routesmessagesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `trigger_fulfillment` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.conditional_cases.new](#fn-transition_routestransition_routesconditional_casesnew) constructor.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.new](#fn-transition_routestransition_routesmessagesnew) constructor.\n - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_flow.transition_routes.trigger_fulfillment.set_parameter_actions.new](#fn-transition_routestransition_routesset_parameter_actionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `trigger_fulfillment` sub block.\n', args=[]), new( + conditional_cases=null, messages=null, return_partial_responses=null, + set_parameter_actions=null, tag=null, webhook=null ):: std.prune(a={ + conditional_cases: conditional_cases, messages: messages, return_partial_responses: return_partial_responses, + set_parameter_actions: set_parameter_actions, tag: tag, webhook: webhook, }), + set_parameter_actions:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object.\n - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `set_parameter_actions` sub block.\n', args=[]), + new( + parameter=null, + value=null + ):: std.prune(a={ + parameter: parameter, + value: value, + }), + }, }, }, '#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=[]), diff --git a/4.x/_gen/resources/dialogflow_cx_page.libsonnet b/4.x/_gen/resources/dialogflow_cx_page.libsonnet index f21ee03..d4cb174 100644 --- a/4.x/_gen/resources/dialogflow_cx_page.libsonnet +++ b/4.x/_gen/resources/dialogflow_cx_page.libsonnet @@ -3,13 +3,77 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='dialogflow_cx_page', url='', help='`dialogflow_cx_page` represents the `google_dialogflow_cx_page` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), entry_fulfillment:: { + conditional_cases:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases`\nTerraform sub block.\n\n\n\n**Args**:\n - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.\nSee [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conditional_cases` sub block.\n', args=[]), + new( + cases=null + ):: std.prune(a={ + cases: cases, + }), + }, messages:: { - '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.text.new](#fn-entry_fulfillmententry_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), + conversation_success:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conversation_success` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + live_agent_handoff:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `live_agent_handoff` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object.\n - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object.\n - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.\nDialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.\n* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.conversation_success.new](#fn-entry_fulfillmententry_fulfillmentconversation_successnew) constructor.\n - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent.\nDialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.\n* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.live_agent_handoff.new](#fn-entry_fulfillmententry_fulfillmentlive_agent_handoffnew) constructor.\n - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.output_audio_text.new](#fn-entry_fulfillmententry_fulfillmentoutput_audio_textnew) constructor.\n - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.play_audio.new](#fn-entry_fulfillmententry_fulfillmentplay_audionew) constructor.\n - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.telephony_transfer_call.new](#fn-entry_fulfillmententry_fulfillmenttelephony_transfer_callnew) constructor.\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.text.new](#fn-entry_fulfillmententry_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), new( + channel=null, + conversation_success=null, + live_agent_handoff=null, + output_audio_text=null, + payload=null, + play_audio=null, + telephony_transfer_call=null, text=null ):: std.prune(a={ + channel: channel, + conversation_success: conversation_success, + live_agent_handoff: live_agent_handoff, + output_audio_text: output_audio_text, + payload: payload, + play_audio: play_audio, + telephony_transfer_call: telephony_transfer_call, text: text, }), + output_audio_text:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text`\nTerraform sub block.\n\n\n\n**Args**:\n - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object.\n - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `output_audio_text` sub block.\n', args=[]), + new( + ssml=null, + text=null + ):: std.prune(a={ + ssml: ssml, + text: text, + }), + }, + play_audio:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio`\nTerraform sub block.\n\n\n\n**Args**:\n - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.\n\n**Returns**:\n - An attribute object that represents the `play_audio` sub block.\n', args=[]), + new( + audio_uri + ):: std.prune(a={ + audio_uri: audio_uri, + }), + }, + telephony_transfer_call:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call`\nTerraform sub block.\n\n\n\n**Args**:\n - `phone_number` (`string`): Transfer the call to a phone number in E.164 format.\n\n**Returns**:\n - An attribute object that represents the `telephony_transfer_call` sub block.\n', args=[]), + new( + phone_number + ):: std.prune(a={ + phone_number: phone_number, + }), + }, text:: { '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list`): A collection of text responses. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `text` sub block.\n', args=[]), new( @@ -19,18 +83,32 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.new` constructs a new object with attributes and blocks configured for the `entry_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.new](#fn-entry_fulfillmentmessagesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `entry_fulfillment` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.new` constructs a new object with attributes and blocks configured for the `entry_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.conditional_cases.new](#fn-entry_fulfillmentconditional_casesnew) constructor.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.new](#fn-entry_fulfillmentmessagesnew) constructor.\n - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_page.entry_fulfillment.set_parameter_actions.new](#fn-entry_fulfillmentset_parameter_actionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `entry_fulfillment` sub block.\n', args=[]), new( + conditional_cases=null, messages=null, return_partial_responses=null, + set_parameter_actions=null, tag=null, webhook=null ):: std.prune(a={ + conditional_cases: conditional_cases, messages: messages, return_partial_responses: return_partial_responses, + set_parameter_actions: set_parameter_actions, tag: tag, webhook: webhook, }), + set_parameter_actions:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.entry_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object.\n - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `set_parameter_actions` sub block.\n', args=[]), + new( + parameter=null, + value=null + ):: std.prune(a={ + parameter: parameter, + value: value, + }), + }, }, event_handlers:: { '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.new` constructs a new object with attributes and blocks configured for the `event_handlers`\nTerraform sub block.\n\n\n\n**Args**:\n - `event` (`string`): The name of the event to handle. When `null`, the `event` field will be omitted from the resulting object.\n - `target_flow` (`string`): The target flow to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. When `null`, the `target_flow` field will be omitted from the resulting object.\n - `target_page` (`string`): The target page to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. When `null`, the `target_page` field will be omitted from the resulting object.\n - `trigger_fulfillment` (`list[obj]`): The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. When `null`, the `trigger_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.new](#fn-event_handlerstrigger_fulfillmentnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `event_handlers` sub block.\n', args=[]), @@ -46,13 +124,77 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); trigger_fulfillment: trigger_fulfillment, }), trigger_fulfillment:: { + conditional_cases:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases`\nTerraform sub block.\n\n\n\n**Args**:\n - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.\nSee [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conditional_cases` sub block.\n', args=[]), + new( + cases=null + ):: std.prune(a={ + cases: cases, + }), + }, messages:: { - '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.text.new](#fn-event_handlersevent_handlerstrigger_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), + conversation_success:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conversation_success` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + live_agent_handoff:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `live_agent_handoff` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object.\n - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object.\n - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.\nDialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.\n* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.conversation_success.new](#fn-event_handlersevent_handlerstrigger_fulfillmentconversation_successnew) constructor.\n - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent.\nDialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.\n* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.live_agent_handoff.new](#fn-event_handlersevent_handlerstrigger_fulfillmentlive_agent_handoffnew) constructor.\n - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.output_audio_text.new](#fn-event_handlersevent_handlerstrigger_fulfillmentoutput_audio_textnew) constructor.\n - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.play_audio.new](#fn-event_handlersevent_handlerstrigger_fulfillmentplay_audionew) constructor.\n - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new](#fn-event_handlersevent_handlerstrigger_fulfillmenttelephony_transfer_callnew) constructor.\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.text.new](#fn-event_handlersevent_handlerstrigger_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), new( + channel=null, + conversation_success=null, + live_agent_handoff=null, + output_audio_text=null, + payload=null, + play_audio=null, + telephony_transfer_call=null, text=null ):: std.prune(a={ + channel: channel, + conversation_success: conversation_success, + live_agent_handoff: live_agent_handoff, + output_audio_text: output_audio_text, + payload: payload, + play_audio: play_audio, + telephony_transfer_call: telephony_transfer_call, text: text, }), + output_audio_text:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text`\nTerraform sub block.\n\n\n\n**Args**:\n - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object.\n - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `output_audio_text` sub block.\n', args=[]), + new( + ssml=null, + text=null + ):: std.prune(a={ + ssml: ssml, + text: text, + }), + }, + play_audio:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio`\nTerraform sub block.\n\n\n\n**Args**:\n - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.\n\n**Returns**:\n - An attribute object that represents the `play_audio` sub block.\n', args=[]), + new( + audio_uri + ):: std.prune(a={ + audio_uri: audio_uri, + }), + }, + telephony_transfer_call:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call`\nTerraform sub block.\n\n\n\n**Args**:\n - `phone_number` (`string`): Transfer the call to a phone number in E.164 format.\n\n**Returns**:\n - An attribute object that represents the `telephony_transfer_call` sub block.\n', args=[]), + new( + phone_number + ):: std.prune(a={ + phone_number: phone_number, + }), + }, text:: { '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list`): A collection of text responses. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `text` sub block.\n', args=[]), new( @@ -62,18 +204,32 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.new](#fn-event_handlersevent_handlersmessagesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `trigger_fulfillment` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.conditional_cases.new](#fn-event_handlersevent_handlersconditional_casesnew) constructor.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.new](#fn-event_handlersevent_handlersmessagesnew) constructor.\n - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_page.event_handlers.trigger_fulfillment.set_parameter_actions.new](#fn-event_handlersevent_handlersset_parameter_actionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `trigger_fulfillment` sub block.\n', args=[]), new( + conditional_cases=null, messages=null, return_partial_responses=null, + set_parameter_actions=null, tag=null, webhook=null ):: std.prune(a={ + conditional_cases: conditional_cases, messages: messages, return_partial_responses: return_partial_responses, + set_parameter_actions: set_parameter_actions, tag: tag, webhook: webhook, }), + set_parameter_actions:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object.\n - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `set_parameter_actions` sub block.\n', args=[]), + new( + parameter=null, + value=null + ):: std.prune(a={ + parameter: parameter, + value: value, + }), + }, }, }, form:: { @@ -86,13 +242,77 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); parameters:: { fill_behavior:: { initial_prompt_fulfillment:: { + conditional_cases:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases`\nTerraform sub block.\n\n\n\n**Args**:\n - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.\nSee [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conditional_cases` sub block.\n', args=[]), + new( + cases=null + ):: std.prune(a={ + cases: cases, + }), + }, messages:: { - '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), + conversation_success:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conversation_success` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + live_agent_handoff:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `live_agent_handoff` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object.\n - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object.\n - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.\nDialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.\n* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.conversation_success.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmentconversation_successnew) constructor.\n - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent.\nDialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.\n* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.live_agent_handoff.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmentlive_agent_handoffnew) constructor.\n - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.output_audio_text.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmentoutput_audio_textnew) constructor.\n - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.play_audio.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmentplay_audionew) constructor.\n - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.telephony_transfer_call.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmenttelephony_transfer_callnew) constructor.\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), new( + channel=null, + conversation_success=null, + live_agent_handoff=null, + output_audio_text=null, + payload=null, + play_audio=null, + telephony_transfer_call=null, text=null ):: std.prune(a={ + channel: channel, + conversation_success: conversation_success, + live_agent_handoff: live_agent_handoff, + output_audio_text: output_audio_text, + payload: payload, + play_audio: play_audio, + telephony_transfer_call: telephony_transfer_call, text: text, }), + output_audio_text:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text`\nTerraform sub block.\n\n\n\n**Args**:\n - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object.\n - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `output_audio_text` sub block.\n', args=[]), + new( + ssml=null, + text=null + ):: std.prune(a={ + ssml: ssml, + text: text, + }), + }, + play_audio:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio`\nTerraform sub block.\n\n\n\n**Args**:\n - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.\n\n**Returns**:\n - An attribute object that represents the `play_audio` sub block.\n', args=[]), + new( + audio_uri + ):: std.prune(a={ + audio_uri: audio_uri, + }), + }, + telephony_transfer_call:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call`\nTerraform sub block.\n\n\n\n**Args**:\n - `phone_number` (`string`): Transfer the call to a phone number in E.164 format.\n\n**Returns**:\n - An attribute object that represents the `telephony_transfer_call` sub block.\n', args=[]), + new( + phone_number + ):: std.prune(a={ + phone_number: phone_number, + }), + }, text:: { '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list`): A collection of text responses. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `text` sub block.\n', args=[]), new( @@ -102,28 +322,167 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.new` constructs a new object with attributes and blocks configured for the `initial_prompt_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.new](#fn-formformparametersfill_behaviormessagesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `initial_prompt_fulfillment` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.new` constructs a new object with attributes and blocks configured for the `initial_prompt_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases.new](#fn-formformparametersfill_behaviorconditional_casesnew) constructor.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.new](#fn-formformparametersfill_behaviormessagesnew) constructor.\n - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.set_parameter_actions.new](#fn-formformparametersfill_behaviorset_parameter_actionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `initial_prompt_fulfillment` sub block.\n', args=[]), new( + conditional_cases=null, messages=null, return_partial_responses=null, + set_parameter_actions=null, tag=null, webhook=null ):: std.prune(a={ + conditional_cases: conditional_cases, messages: messages, return_partial_responses: return_partial_responses, + set_parameter_actions: set_parameter_actions, tag: tag, webhook: webhook, }), + set_parameter_actions:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object.\n - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `set_parameter_actions` sub block.\n', args=[]), + new( + parameter=null, + value=null + ):: std.prune(a={ + parameter: parameter, + value: value, + }), + }, }, - '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.new` constructs a new object with attributes and blocks configured for the `fill_behavior`\nTerraform sub block.\n\n\n\n**Args**:\n - `initial_prompt_fulfillment` (`list[obj]`): The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. When `null`, the `initial_prompt_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.new](#fn-formformparametersinitial_prompt_fulfillmentnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `fill_behavior` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.new` constructs a new object with attributes and blocks configured for the `fill_behavior`\nTerraform sub block.\n\n\n\n**Args**:\n - `initial_prompt_fulfillment` (`list[obj]`): The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. When `null`, the `initial_prompt_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.new](#fn-formformparametersinitial_prompt_fulfillmentnew) constructor.\n - `reprompt_event_handlers` (`list[obj]`): The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are:\n* sys.no-match-<N>, where N can be from 1 to 6\n* sys.no-match-default\n* sys.no-input-<N>, where N can be from 1 to 6\n* sys.no-input-default\n* sys.invalid-parameter\n[initialPromptFulfillment][initialPromptFulfillment] provides the first prompt for the parameter.\nIf the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on.\nA sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed.\nA sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt.\nIf the event handler for the corresponding event can't be found on the parameter, initialPromptFulfillment will be re-prompted. When `null`, the `reprompt_event_handlers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.new](#fn-formformparametersreprompt_event_handlersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `fill_behavior` sub block.\n', args=[]), new( - initial_prompt_fulfillment=null + initial_prompt_fulfillment=null, + reprompt_event_handlers=null ):: std.prune(a={ initial_prompt_fulfillment: initial_prompt_fulfillment, + reprompt_event_handlers: reprompt_event_handlers, }), + reprompt_event_handlers:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.new` constructs a new object with attributes and blocks configured for the `reprompt_event_handlers`\nTerraform sub block.\n\n\n\n**Args**:\n - `event` (`string`): The name of the event to handle. When `null`, the `event` field will be omitted from the resulting object.\n - `target_flow` (`string`): The target flow to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. When `null`, the `target_flow` field will be omitted from the resulting object.\n - `target_page` (`string`): The target page to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. When `null`, the `target_page` field will be omitted from the resulting object.\n - `trigger_fulfillment` (`list[obj]`): The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. When `null`, the `trigger_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.new](#fn-formformparametersfill_behaviortrigger_fulfillmentnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `reprompt_event_handlers` sub block.\n', args=[]), + new( + event=null, + target_flow=null, + target_page=null, + trigger_fulfillment=null + ):: std.prune(a={ + event: event, + target_flow: target_flow, + target_page: target_page, + trigger_fulfillment: trigger_fulfillment, + }), + trigger_fulfillment:: { + conditional_cases:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases`\nTerraform sub block.\n\n\n\n**Args**:\n - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.\nSee [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conditional_cases` sub block.\n', args=[]), + new( + cases=null + ):: std.prune(a={ + cases: cases, + }), + }, + messages:: { + conversation_success:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conversation_success` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + live_agent_handoff:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `live_agent_handoff` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object.\n - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object.\n - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.\nDialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.\n* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.conversation_success.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentconversation_successnew) constructor.\n - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent.\nDialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.\n* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.live_agent_handoff.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentlive_agent_handoffnew) constructor.\n - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.output_audio_text.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentoutput_audio_textnew) constructor.\n - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.play_audio.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentplay_audionew) constructor.\n - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmenttelephony_transfer_callnew) constructor.\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.text.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), + new( + channel=null, + conversation_success=null, + live_agent_handoff=null, + output_audio_text=null, + payload=null, + play_audio=null, + telephony_transfer_call=null, + text=null + ):: std.prune(a={ + channel: channel, + conversation_success: conversation_success, + live_agent_handoff: live_agent_handoff, + output_audio_text: output_audio_text, + payload: payload, + play_audio: play_audio, + telephony_transfer_call: telephony_transfer_call, + text: text, + }), + output_audio_text:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text`\nTerraform sub block.\n\n\n\n**Args**:\n - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object.\n - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `output_audio_text` sub block.\n', args=[]), + new( + ssml=null, + text=null + ):: std.prune(a={ + ssml: ssml, + text: text, + }), + }, + play_audio:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio`\nTerraform sub block.\n\n\n\n**Args**:\n - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.\n\n**Returns**:\n - An attribute object that represents the `play_audio` sub block.\n', args=[]), + new( + audio_uri + ):: std.prune(a={ + audio_uri: audio_uri, + }), + }, + telephony_transfer_call:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call`\nTerraform sub block.\n\n\n\n**Args**:\n - `phone_number` (`string`): Transfer the call to a phone number in E.164 format.\n\n**Returns**:\n - An attribute object that represents the `telephony_transfer_call` sub block.\n', args=[]), + new( + phone_number + ):: std.prune(a={ + phone_number: phone_number, + }), + }, + text:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list`): A collection of text responses. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `text` sub block.\n', args=[]), + new( + text=null + ):: std.prune(a={ + text: text, + }), + }, + }, + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.conditional_cases.new](#fn-formformparametersfill_behaviorreprompt_event_handlersconditional_casesnew) constructor.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.new](#fn-formformparametersfill_behaviorreprompt_event_handlersmessagesnew) constructor.\n - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.set_parameter_actions.new](#fn-formformparametersfill_behaviorreprompt_event_handlersset_parameter_actionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `trigger_fulfillment` sub block.\n', args=[]), + new( + conditional_cases=null, + messages=null, + return_partial_responses=null, + set_parameter_actions=null, + tag=null, + webhook=null + ):: std.prune(a={ + conditional_cases: conditional_cases, + messages: messages, + return_partial_responses: return_partial_responses, + set_parameter_actions: set_parameter_actions, + tag: tag, + webhook: webhook, + }), + set_parameter_actions:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object.\n - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `set_parameter_actions` sub block.\n', args=[]), + new( + parameter=null, + value=null + ):: std.prune(a={ + parameter: parameter, + value: value, + }), + }, + }, + }, }, - '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.new` constructs a new object with attributes and blocks configured for the `parameters`\nTerraform sub block.\n\n\n\n**Args**:\n - `display_name` (`string`): The human-readable name of the parameter, unique within the form. When `null`, the `display_name` field will be omitted from the resulting object.\n - `entity_type` (`string`): The entity type of the parameter.\nFormat: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types. When `null`, the `entity_type` field will be omitted from the resulting object.\n - `is_list` (`bool`): Indicates whether the parameter represents a list of values. When `null`, the `is_list` field will be omitted from the resulting object.\n - `redact` (`bool`): Indicates whether the parameter content should be redacted in log.\nIf redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. When `null`, the `redact` field will be omitted from the resulting object.\n - `required` (`bool`): Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them.\nRequired parameters must be filled before form filling concludes. When `null`, the `required` field will be omitted from the resulting object.\n - `fill_behavior` (`list[obj]`): Defines fill behavior for the parameter. When `null`, the `fill_behavior` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.new](#fn-formformfill_behaviornew) constructor.\n\n**Returns**:\n - An attribute object that represents the `parameters` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.dialogflow_cx_page.form.parameters.new` constructs a new object with attributes and blocks configured for the `parameters`\nTerraform sub block.\n\n\n\n**Args**:\n - `default_value` (`string`): The default value of an optional parameter. If the parameter is required, the default value will be ignored. When `null`, the `default_value` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable name of the parameter, unique within the form. When `null`, the `display_name` field will be omitted from the resulting object.\n - `entity_type` (`string`): The entity type of the parameter.\nFormat: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types. When `null`, the `entity_type` field will be omitted from the resulting object.\n - `is_list` (`bool`): Indicates whether the parameter represents a list of values. When `null`, the `is_list` field will be omitted from the resulting object.\n - `redact` (`bool`): Indicates whether the parameter content should be redacted in log.\nIf redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. When `null`, the `redact` field will be omitted from the resulting object.\n - `required` (`bool`): Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them.\nRequired parameters must be filled before form filling concludes. When `null`, the `required` field will be omitted from the resulting object.\n - `fill_behavior` (`list[obj]`): Defines fill behavior for the parameter. When `null`, the `fill_behavior` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.new](#fn-formformfill_behaviornew) constructor.\n\n**Returns**:\n - An attribute object that represents the `parameters` sub block.\n', args=[]), new( + default_value=null, display_name=null, entity_type=null, fill_behavior=null, @@ -131,6 +490,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); redact=null, required=null ):: std.prune(a={ + default_value: default_value, display_name: display_name, entity_type: entity_type, fill_behavior: fill_behavior, @@ -204,7 +564,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, transition_routes:: { - '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.new` constructs a new object with attributes and blocks configured for the `transition_routes`\nTerraform sub block.\n\n\n\n**Args**:\n - `condition` (`string`): The condition to evaluate against form parameters or session parameters.\nAt least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. When `null`, the `condition` field will be omitted from the resulting object.\n - `intent` (`string`): The unique identifier of an Intent.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. When `null`, the `intent` field will be omitted from the resulting object.\n - `target_flow` (`string`): The target flow to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. When `null`, the `target_flow` field will be omitted from the resulting object.\n - `target_page` (`string`): The target page to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. When `null`, the `target_page` field will be omitted from the resulting object.\n - `trigger_fulfillment` (`list[obj]`): The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. When `null`, the `trigger_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.new](#fn-transition_routestrigger_fulfillmentnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `transition_routes` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.new` constructs a new object with attributes and blocks configured for the `transition_routes`\nTerraform sub block.\n\n\n\n**Args**:\n - `condition` (`string`): The condition to evaluate against form parameters or session parameters.\nAt least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. When `null`, the `condition` field will be omitted from the resulting object.\n - `intent` (`string`): The unique identifier of an Intent.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. When `null`, the `intent` field will be omitted from the resulting object.\n - `target_flow` (`string`): The target flow to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. When `null`, the `target_flow` field will be omitted from the resulting object.\n - `target_page` (`string`): The target page to transition to.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. When `null`, the `target_page` field will be omitted from the resulting object.\n - `trigger_fulfillment` (`list[obj]`): The fulfillment to call when the condition is satisfied. At least one of triggerFulfillment and target must be specified. When both are defined, triggerFulfillment is executed first. When `null`, the `trigger_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.new](#fn-transition_routestrigger_fulfillmentnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `transition_routes` sub block.\n', args=[]), new( condition=null, intent=null, @@ -219,13 +579,77 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); trigger_fulfillment: trigger_fulfillment, }), trigger_fulfillment:: { + conditional_cases:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases`\nTerraform sub block.\n\n\n\n**Args**:\n - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.\nSee [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conditional_cases` sub block.\n', args=[]), + new( + cases=null + ):: std.prune(a={ + cases: cases, + }), + }, messages:: { - '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.text.new](#fn-transition_routestransition_routestrigger_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), + conversation_success:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conversation_success` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + live_agent_handoff:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `live_agent_handoff` sub block.\n', args=[]), + new( + metadata=null + ):: std.prune(a={ + metadata: metadata, + }), + }, + '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages`\nTerraform sub block.\n\n\n\n**Args**:\n - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object.\n - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object.\n - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.\nDialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.\n* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.conversation_success.new](#fn-transition_routestransition_routestrigger_fulfillmentconversation_successnew) constructor.\n - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent.\nDialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.\nYou may set this, for example:\n* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.\n* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.live_agent_handoff.new](#fn-transition_routestransition_routestrigger_fulfillmentlive_agent_handoffnew) constructor.\n - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.output_audio_text.new](#fn-transition_routestransition_routestrigger_fulfillmentoutput_audio_textnew) constructor.\n - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.play_audio.new](#fn-transition_routestransition_routestrigger_fulfillmentplay_audionew) constructor.\n - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new](#fn-transition_routestransition_routestrigger_fulfillmenttelephony_transfer_callnew) constructor.\n - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.text.new](#fn-transition_routestransition_routestrigger_fulfillmenttextnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `messages` sub block.\n', args=[]), new( + channel=null, + conversation_success=null, + live_agent_handoff=null, + output_audio_text=null, + payload=null, + play_audio=null, + telephony_transfer_call=null, text=null ):: std.prune(a={ + channel: channel, + conversation_success: conversation_success, + live_agent_handoff: live_agent_handoff, + output_audio_text: output_audio_text, + payload: payload, + play_audio: play_audio, + telephony_transfer_call: telephony_transfer_call, text: text, }), + output_audio_text:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text`\nTerraform sub block.\n\n\n\n**Args**:\n - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object.\n - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `output_audio_text` sub block.\n', args=[]), + new( + ssml=null, + text=null + ):: std.prune(a={ + ssml: ssml, + text: text, + }), + }, + play_audio:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio`\nTerraform sub block.\n\n\n\n**Args**:\n - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.\n\n**Returns**:\n - An attribute object that represents the `play_audio` sub block.\n', args=[]), + new( + audio_uri + ):: std.prune(a={ + audio_uri: audio_uri, + }), + }, + telephony_transfer_call:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call`\nTerraform sub block.\n\n\n\n**Args**:\n - `phone_number` (`string`): Transfer the call to a phone number in E.164 format.\n\n**Returns**:\n - An attribute object that represents the `telephony_transfer_call` sub block.\n', args=[]), + new( + phone_number + ):: std.prune(a={ + phone_number: phone_number, + }), + }, text:: { '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text`\nTerraform sub block.\n\n\n\n**Args**:\n - `text` (`list`): A collection of text responses. When `null`, the `text` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `text` sub block.\n', args=[]), new( @@ -235,18 +659,32 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.new](#fn-transition_routestransition_routesmessagesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `trigger_fulfillment` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment`\nTerraform sub block.\n\n\n\n**Args**:\n - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object.\n - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object.\n - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object.\n - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.conditional_cases.new](#fn-transition_routestransition_routesconditional_casesnew) constructor.\n - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.new](#fn-transition_routestransition_routesmessagesnew) constructor.\n - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_page.transition_routes.trigger_fulfillment.set_parameter_actions.new](#fn-transition_routestransition_routesset_parameter_actionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `trigger_fulfillment` sub block.\n', args=[]), new( + conditional_cases=null, messages=null, return_partial_responses=null, + set_parameter_actions=null, tag=null, webhook=null ):: std.prune(a={ + conditional_cases: conditional_cases, messages: messages, return_partial_responses: return_partial_responses, + set_parameter_actions: set_parameter_actions, tag: tag, webhook: webhook, }), + set_parameter_actions:: { + '#new':: d.fn(help='\n`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object.\n - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `set_parameter_actions` sub block.\n', args=[]), + new( + parameter=null, + value=null + ):: std.prune(a={ + parameter: parameter, + value: 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=[]), diff --git a/4.x/_gen/resources/gke_hub_membership_binding.libsonnet b/4.x/_gen/resources/gke_hub_membership_binding.libsonnet new file mode 100644 index 0000000..ca21a44 --- /dev/null +++ b/4.x/_gen/resources/gke_hub_membership_binding.libsonnet @@ -0,0 +1,126 @@ +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='gke_hub_membership_binding', url='', help='`gke_hub_membership_binding` represents the `google_gke_hub_membership_binding` 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.gke_hub_membership_binding.new` injects a new `google_gke_hub_membership_binding` 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.gke_hub_membership_binding.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_hub_membership_binding` using the reference:\n\n $._ref.google_gke_hub_membership_binding.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_hub_membership_binding.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 - `location` (`string`): Location of the membership\n - `membership_binding_id` (`string`): The client-provided identifier of the membership binding.\n - `membership_id` (`string`): Id of the membership\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 - `scope` (`string`): A Workspace resource name in the format\n\u0026#39;projects/*/locations/*/scopes/*\u0026#39;.\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.gke_hub_membership_binding.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, + location, + membership_binding_id, + membership_id, + scope, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_gke_hub_membership_binding', + label=resourceLabel, + attrs=self.newAttrs( + location=location, + membership_binding_id=membership_binding_id, + membership_id=membership_id, + project=project, + scope=scope, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.gke_hub_membership_binding.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_membership_binding`\nTerraform resource.\n\nUnlike [google.gke_hub_membership_binding.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 - `location` (`string`): Location of the membership\n - `membership_binding_id` (`string`): The client-provided identifier of the membership binding.\n - `membership_id` (`string`): Id of the membership\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `scope` (`string`): A Workspace resource name in the format\n'projects/*/locations/*/scopes/*'.\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.gke_hub_membership_binding.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 `gke_hub_membership_binding` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + location, + membership_binding_id, + membership_id, + scope, + project=null, + timeouts=null + ):: std.prune(a={ + location: location, + membership_binding_id: membership_binding_id, + membership_id: membership_id, + project: project, + scope: scope, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.gke_hub_membership_binding.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, + }), + }, + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location 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 `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_gke_hub_membership_binding+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withMembershipBindingId':: d.fn(help='`google.string.withMembershipBindingId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the membership_binding_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 `membership_binding_id` field.\n', args=[]), + withMembershipBindingId(resourceLabel, value): { + resource+: { + google_gke_hub_membership_binding+: { + [resourceLabel]+: { + membership_binding_id: value, + }, + }, + }, + }, + '#withMembershipId':: d.fn(help='`google.string.withMembershipId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the membership_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 `membership_id` field.\n', args=[]), + withMembershipId(resourceLabel, value): { + resource+: { + google_gke_hub_membership_binding+: { + [resourceLabel]+: { + membership_id: 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_gke_hub_membership_binding+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withScope':: d.fn(help='`google.string.withScope` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the scope 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 `scope` field.\n', args=[]), + withScope(resourceLabel, value): { + resource+: { + google_gke_hub_membership_binding+: { + [resourceLabel]+: { + scope: 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_gke_hub_membership_binding+: { + [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_gke_hub_membership_binding+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/gke_hub_namespace.libsonnet b/4.x/_gen/resources/gke_hub_namespace.libsonnet new file mode 100644 index 0000000..3418299 --- /dev/null +++ b/4.x/_gen/resources/gke_hub_namespace.libsonnet @@ -0,0 +1,110 @@ +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='gke_hub_namespace', url='', help='`gke_hub_namespace` represents the `google_gke_hub_namespace` 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.gke_hub_namespace.new` injects a new `google_gke_hub_namespace` 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.gke_hub_namespace.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_hub_namespace` using the reference:\n\n $._ref.google_gke_hub_namespace.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_hub_namespace.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 - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `scope` (`string`): The name of the Scope instance.\n - `scope_id` (`string`): Id of the scope\n - `scope_namespace_id` (`string`): The client-provided identifier of the namespace.\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.gke_hub_namespace.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, + scope, + scope_id, + scope_namespace_id, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_gke_hub_namespace', + label=resourceLabel, + attrs=self.newAttrs( + project=project, + scope=scope, + scope_id=scope_id, + scope_namespace_id=scope_namespace_id, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.gke_hub_namespace.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_namespace`\nTerraform resource.\n\nUnlike [google.gke_hub_namespace.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 - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `scope` (`string`): The name of the Scope instance.\n - `scope_id` (`string`): Id of the scope\n - `scope_namespace_id` (`string`): The client-provided identifier of the namespace.\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.gke_hub_namespace.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 `gke_hub_namespace` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + scope, + scope_id, + scope_namespace_id, + project=null, + timeouts=null + ):: std.prune(a={ + project: project, + scope: scope, + scope_id: scope_id, + scope_namespace_id: scope_namespace_id, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.gke_hub_namespace.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, + }), + }, + '#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_gke_hub_namespace+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withScope':: d.fn(help='`google.string.withScope` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the scope 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 `scope` field.\n', args=[]), + withScope(resourceLabel, value): { + resource+: { + google_gke_hub_namespace+: { + [resourceLabel]+: { + scope: value, + }, + }, + }, + }, + '#withScopeId':: d.fn(help='`google.string.withScopeId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the scope_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 `scope_id` field.\n', args=[]), + withScopeId(resourceLabel, value): { + resource+: { + google_gke_hub_namespace+: { + [resourceLabel]+: { + scope_id: value, + }, + }, + }, + }, + '#withScopeNamespaceId':: d.fn(help='`google.string.withScopeNamespaceId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the scope_namespace_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 `scope_namespace_id` field.\n', args=[]), + withScopeNamespaceId(resourceLabel, value): { + resource+: { + google_gke_hub_namespace+: { + [resourceLabel]+: { + scope_namespace_id: 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_gke_hub_namespace+: { + [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_gke_hub_namespace+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/gke_hub_scope.libsonnet b/4.x/_gen/resources/gke_hub_scope.libsonnet new file mode 100644 index 0000000..bebd0b2 --- /dev/null +++ b/4.x/_gen/resources/gke_hub_scope.libsonnet @@ -0,0 +1,78 @@ +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='gke_hub_scope', url='', help='`gke_hub_scope` represents the `google_gke_hub_scope` 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.gke_hub_scope.new` injects a new `google_gke_hub_scope` 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.gke_hub_scope.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_hub_scope` using the reference:\n\n $._ref.google_gke_hub_scope.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_hub_scope.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 - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `scope_id` (`string`): The client-provided identifier of the scope.\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.gke_hub_scope.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, + scope_id, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_gke_hub_scope', + label=resourceLabel, + attrs=self.newAttrs(project=project, scope_id=scope_id, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.gke_hub_scope.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope`\nTerraform resource.\n\nUnlike [google.gke_hub_scope.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 - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `scope_id` (`string`): The client-provided identifier of the scope.\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.gke_hub_scope.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 `gke_hub_scope` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + scope_id, + project=null, + timeouts=null + ):: std.prune(a={ + project: project, + scope_id: scope_id, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.gke_hub_scope.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, + }), + }, + '#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_gke_hub_scope+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withScopeId':: d.fn(help='`google.string.withScopeId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the scope_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 `scope_id` field.\n', args=[]), + withScopeId(resourceLabel, value): { + resource+: { + google_gke_hub_scope+: { + [resourceLabel]+: { + scope_id: 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_gke_hub_scope+: { + [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_gke_hub_scope+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/gke_hub_scope_iam_binding.libsonnet b/4.x/_gen/resources/gke_hub_scope_iam_binding.libsonnet new file mode 100644 index 0000000..675bb0d --- /dev/null +++ b/4.x/_gen/resources/gke_hub_scope_iam_binding.libsonnet @@ -0,0 +1,112 @@ +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='gke_hub_scope_iam_binding', url='', help='`gke_hub_scope_iam_binding` represents the `google_gke_hub_scope_iam_binding` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + condition:: { + '#new':: d.fn(help='\n`google.gke_hub_scope_iam_binding.condition.new` constructs a new object with attributes and blocks configured for the `condition`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `expression` (`string`): Set the `expression` field on the resulting object.\n - `title` (`string`): Set the `title` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), + new( + expression, + title, + description=null + ):: std.prune(a={ + description: description, + expression: expression, + title: title, + }), + }, + '#new':: d.fn(help="\n`google.gke_hub_scope_iam_binding.new` injects a new `google_gke_hub_scope_iam_binding` 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.gke_hub_scope_iam_binding.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_hub_scope_iam_binding` using the reference:\n\n $._ref.google_gke_hub_scope_iam_binding.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_hub_scope_iam_binding.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 - `members` (`list`): Set the `members` field on the resulting resource block.\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 - `role` (`string`): Set the `role` field on the resulting resource block.\n - `scope_id` (`string`): Set the `scope_id` field on the resulting resource block.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_iam_binding.condition.new](#fn-conditionnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + members, + role, + scope_id, + condition=null, + project=null, + _meta={} + ):: tf.withResource( + type='google_gke_hub_scope_iam_binding', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + members=members, + project=project, + role=role, + scope_id=scope_id + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.gke_hub_scope_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope_iam_binding`\nTerraform resource.\n\nUnlike [google.gke_hub_scope_iam_binding.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 - `members` (`list`): Set the `members` field on 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 - `role` (`string`): Set the `role` field on the resulting object.\n - `scope_id` (`string`): Set the `scope_id` field on the resulting object.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_iam_binding.condition.new](#fn-conditionnew) 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 `gke_hub_scope_iam_binding` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + members, + role, + scope_id, + condition=null, + project=null + ):: std.prune(a={ + condition: condition, + members: members, + project: project, + role: role, + scope_id: scope_id, + }), + '#withCondition':: d.fn(help='`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withConditionMixin](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 `condition` field.\n', args=[]), + withCondition(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_binding+: { + [resourceLabel]+: { + condition: value, + }, + }, + }, + }, + '#withConditionMixin':: d.fn(help='`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withCondition](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 `condition` field.\n', args=[]), + withConditionMixin(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_binding+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withMembers':: d.fn(help='`google.list.withMembers` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the members field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `members` field.\n', args=[]), + withMembers(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_binding+: { + [resourceLabel]+: { + members: 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_gke_hub_scope_iam_binding+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google.string.withRole` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the role 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 `role` field.\n', args=[]), + withRole(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_binding+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, + '#withScopeId':: d.fn(help='`google.string.withScopeId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the scope_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 `scope_id` field.\n', args=[]), + withScopeId(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_binding+: { + [resourceLabel]+: { + scope_id: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/gke_hub_scope_iam_member.libsonnet b/4.x/_gen/resources/gke_hub_scope_iam_member.libsonnet new file mode 100644 index 0000000..c2f2e7d --- /dev/null +++ b/4.x/_gen/resources/gke_hub_scope_iam_member.libsonnet @@ -0,0 +1,112 @@ +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='gke_hub_scope_iam_member', url='', help='`gke_hub_scope_iam_member` represents the `google_gke_hub_scope_iam_member` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + condition:: { + '#new':: d.fn(help='\n`google.gke_hub_scope_iam_member.condition.new` constructs a new object with attributes and blocks configured for the `condition`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `expression` (`string`): Set the `expression` field on the resulting object.\n - `title` (`string`): Set the `title` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), + new( + expression, + title, + description=null + ):: std.prune(a={ + description: description, + expression: expression, + title: title, + }), + }, + '#new':: d.fn(help="\n`google.gke_hub_scope_iam_member.new` injects a new `google_gke_hub_scope_iam_member` 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.gke_hub_scope_iam_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_hub_scope_iam_member` using the reference:\n\n $._ref.google_gke_hub_scope_iam_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_hub_scope_iam_member.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 - `member` (`string`): Set the `member` field on the resulting resource block.\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 - `role` (`string`): Set the `role` field on the resulting resource block.\n - `scope_id` (`string`): Set the `scope_id` field on the resulting resource block.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_iam_member.condition.new](#fn-conditionnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + member, + role, + scope_id, + condition=null, + project=null, + _meta={} + ):: tf.withResource( + type='google_gke_hub_scope_iam_member', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + member=member, + project=project, + role=role, + scope_id=scope_id + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.gke_hub_scope_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope_iam_member`\nTerraform resource.\n\nUnlike [google.gke_hub_scope_iam_member.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 - `member` (`string`): Set the `member` field on 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 - `role` (`string`): Set the `role` field on the resulting object.\n - `scope_id` (`string`): Set the `scope_id` field on the resulting object.\n - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_iam_member.condition.new](#fn-conditionnew) 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 `gke_hub_scope_iam_member` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + member, + role, + scope_id, + condition=null, + project=null + ):: std.prune(a={ + condition: condition, + member: member, + project: project, + role: role, + scope_id: scope_id, + }), + '#withCondition':: d.fn(help='`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withConditionMixin](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 `condition` field.\n', args=[]), + withCondition(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_member+: { + [resourceLabel]+: { + condition: value, + }, + }, + }, + }, + '#withConditionMixin':: d.fn(help='`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the condition 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].withCondition](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 `condition` field.\n', args=[]), + withConditionMixin(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_member+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withMember':: d.fn(help='`google.string.withMember` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the member 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 `member` field.\n', args=[]), + withMember(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_member+: { + [resourceLabel]+: { + member: 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_gke_hub_scope_iam_member+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google.string.withRole` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the role 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 `role` field.\n', args=[]), + withRole(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_member+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, + '#withScopeId':: d.fn(help='`google.string.withScopeId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the scope_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 `scope_id` field.\n', args=[]), + withScopeId(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_member+: { + [resourceLabel]+: { + scope_id: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/gke_hub_scope_iam_policy.libsonnet b/4.x/_gen/resources/gke_hub_scope_iam_policy.libsonnet new file mode 100644 index 0000000..10b2f02 --- /dev/null +++ b/4.x/_gen/resources/gke_hub_scope_iam_policy.libsonnet @@ -0,0 +1,58 @@ +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='gke_hub_scope_iam_policy', url='', help='`gke_hub_scope_iam_policy` represents the `google_gke_hub_scope_iam_policy` 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.gke_hub_scope_iam_policy.new` injects a new `google_gke_hub_scope_iam_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.gke_hub_scope_iam_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_hub_scope_iam_policy` using the reference:\n\n $._ref.google_gke_hub_scope_iam_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_hub_scope_iam_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 - `policy_data` (`string`): Set the `policy_data` field on the resulting resource block.\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 - `scope_id` (`string`): Set the `scope_id` field on the resulting resource block.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + policy_data, + scope_id, + project=null, + _meta={} + ):: tf.withResource( + type='google_gke_hub_scope_iam_policy', + label=resourceLabel, + attrs=self.newAttrs(policy_data=policy_data, project=project, scope_id=scope_id), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.gke_hub_scope_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope_iam_policy`\nTerraform resource.\n\nUnlike [google.gke_hub_scope_iam_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 - `policy_data` (`string`): Set the `policy_data` field on 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 - `scope_id` (`string`): Set the `scope_id` field on the resulting object.\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 `gke_hub_scope_iam_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + policy_data, + scope_id, + project=null + ):: std.prune(a={ + policy_data: policy_data, + project: project, + scope_id: scope_id, + }), + '#withPolicyData':: d.fn(help='`google.string.withPolicyData` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the policy_data 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 `policy_data` field.\n', args=[]), + withPolicyData(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_policy+: { + [resourceLabel]+: { + policy_data: 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_gke_hub_scope_iam_policy+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withScopeId':: d.fn(help='`google.string.withScopeId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the scope_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 `scope_id` field.\n', args=[]), + withScopeId(resourceLabel, value): { + resource+: { + google_gke_hub_scope_iam_policy+: { + [resourceLabel]+: { + scope_id: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/gke_hub_scope_rbac_role_binding.libsonnet b/4.x/_gen/resources/gke_hub_scope_rbac_role_binding.libsonnet new file mode 100644 index 0000000..5aece2f --- /dev/null +++ b/4.x/_gen/resources/gke_hub_scope_rbac_role_binding.libsonnet @@ -0,0 +1,158 @@ +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='gke_hub_scope_rbac_role_binding', url='', help='`gke_hub_scope_rbac_role_binding` represents the `google_gke_hub_scope_rbac_role_binding` 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.gke_hub_scope_rbac_role_binding.new` injects a new `google_gke_hub_scope_rbac_role_binding` 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.gke_hub_scope_rbac_role_binding.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_hub_scope_rbac_role_binding` using the reference:\n\n $._ref.google_gke_hub_scope_rbac_role_binding.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_hub_scope_rbac_role_binding.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 - `group` (`string`): Principal that is be authorized in the cluster (at least of one the oneof\nis required). Updating one will unset the other automatically.\ngroup is the group, as seen by the kubernetes cluster. When `null`, the `group` 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 - `scope_id` (`string`): Id of the scope\n - `scope_rbac_role_binding_id` (`string`): The client-provided identifier of the RBAC Role Binding.\n - `user` (`string`): Principal that is be authorized in the cluster (at least of one the oneof\nis required). Updating one will unset the other automatically.\nuser is the name of the user as seen by the kubernetes cluster, example\n\u0026#34;alice\u0026#34; or \u0026#34;alice@domain.tld\u0026#34; When `null`, the `user` field will be omitted from the resulting object.\n - `role` (`list[obj]`): Role to bind to the principal. When `null`, the `role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_rbac_role_binding.role.new](#fn-rolenew) 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.gke_hub_scope_rbac_role_binding.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, + scope_id, + scope_rbac_role_binding_id, + group=null, + project=null, + role=null, + timeouts=null, + user=null, + _meta={} + ):: tf.withResource( + type='google_gke_hub_scope_rbac_role_binding', + label=resourceLabel, + attrs=self.newAttrs( + group=group, + project=project, + role=role, + scope_id=scope_id, + scope_rbac_role_binding_id=scope_rbac_role_binding_id, + timeouts=timeouts, + user=user + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.gke_hub_scope_rbac_role_binding.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope_rbac_role_binding`\nTerraform resource.\n\nUnlike [google.gke_hub_scope_rbac_role_binding.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 - `group` (`string`): Principal that is be authorized in the cluster (at least of one the oneof\nis required). Updating one will unset the other automatically.\ngroup is the group, as seen by the kubernetes cluster. When `null`, the `group` 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 - `scope_id` (`string`): Id of the scope\n - `scope_rbac_role_binding_id` (`string`): The client-provided identifier of the RBAC Role Binding.\n - `user` (`string`): Principal that is be authorized in the cluster (at least of one the oneof\nis required). Updating one will unset the other automatically.\nuser is the name of the user as seen by the kubernetes cluster, example\n"alice" or "alice@domain.tld" When `null`, the `user` field will be omitted from the resulting object.\n - `role` (`list[obj]`): Role to bind to the principal. When `null`, the `role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_rbac_role_binding.role.new](#fn-rolenew) 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.gke_hub_scope_rbac_role_binding.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 `gke_hub_scope_rbac_role_binding` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + scope_id, + scope_rbac_role_binding_id, + group=null, + project=null, + role=null, + timeouts=null, + user=null + ):: std.prune(a={ + group: group, + project: project, + role: role, + scope_id: scope_id, + scope_rbac_role_binding_id: scope_rbac_role_binding_id, + timeouts: timeouts, + user: user, + }), + role:: { + '#new':: d.fn(help='\n`google.gke_hub_scope_rbac_role_binding.role.new` constructs a new object with attributes and blocks configured for the `role`\nTerraform sub block.\n\n\n\n**Args**:\n - `predefined_role` (`string`): PredefinedRole is an ENUM representation of the default Kubernetes Roles Possible values: ["UNKNOWN", "ADMIN", "EDIT", "VIEW"] When `null`, the `predefined_role` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `role` sub block.\n', args=[]), + new( + predefined_role=null + ):: std.prune(a={ + predefined_role: predefined_role, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`google.gke_hub_scope_rbac_role_binding.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, + }), + }, + '#withGroup':: d.fn(help='`google.string.withGroup` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the 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 `group` field.\n', args=[]), + withGroup(resourceLabel, value): { + resource+: { + google_gke_hub_scope_rbac_role_binding+: { + [resourceLabel]+: { + group: 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_gke_hub_scope_rbac_role_binding+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google.list[obj].withRole` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the role 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].withRoleMixin](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 `role` field.\n', args=[]), + withRole(resourceLabel, value): { + resource+: { + google_gke_hub_scope_rbac_role_binding+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, + '#withRoleMixin':: d.fn(help='`google.list[obj].withRoleMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the role 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].withRole](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 `role` field.\n', args=[]), + withRoleMixin(resourceLabel, value): { + resource+: { + google_gke_hub_scope_rbac_role_binding+: { + [resourceLabel]+: { + role+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withScopeId':: d.fn(help='`google.string.withScopeId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the scope_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 `scope_id` field.\n', args=[]), + withScopeId(resourceLabel, value): { + resource+: { + google_gke_hub_scope_rbac_role_binding+: { + [resourceLabel]+: { + scope_id: value, + }, + }, + }, + }, + '#withScopeRbacRoleBindingId':: d.fn(help='`google.string.withScopeRbacRoleBindingId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the scope_rbac_role_binding_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 `scope_rbac_role_binding_id` field.\n', args=[]), + withScopeRbacRoleBindingId(resourceLabel, value): { + resource+: { + google_gke_hub_scope_rbac_role_binding+: { + [resourceLabel]+: { + scope_rbac_role_binding_id: 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_gke_hub_scope_rbac_role_binding+: { + [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_gke_hub_scope_rbac_role_binding+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withUser':: d.fn(help='`google.string.withUser` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the user 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 `user` field.\n', args=[]), + withUser(resourceLabel, value): { + resource+: { + google_gke_hub_scope_rbac_role_binding+: { + [resourceLabel]+: { + user: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet b/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet index 2d67553..fe626fd 100644 --- a/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet +++ b/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet @@ -91,11 +91,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); web_sso_config: web_sso_config, }), web_sso_config:: { - '#new':: d.fn(help='\n`google.iam_workforce_pool_provider.oidc.web_sso_config.new` constructs a new object with attributes and blocks configured for the `web_sso_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `assertion_claims_behavior` (`string`): The behavior for how OIDC Claims are included in the 'assertion' object used for attribute mapping and attribute condition.\n* MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS: Merge the UserInfo Endpoint Claims with ID Token Claims, preferring UserInfo Claim Values for the same Claim Name. This option is available only for the Authorization Code Flow.\n* ONLY_ID_TOKEN_CLAIMS: Only include ID Token Claims. Possible values: ["MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS", "ONLY_ID_TOKEN_CLAIMS"]\n - `response_type` (`string`): The Response Type to request for in the OIDC Authorization Request for web sign-in.\n\nThe 'CODE' Response Type is recommended to avoid the Implicit Flow, for security reasons.\n* CODE: The 'response_type=code' selection uses the Authorization Code Flow for web sign-in. Requires a configured client secret.\n* ID_TOKEN: The 'response_type=id_token' selection uses the Implicit Flow for web sign-in. Possible values: ["CODE", "ID_TOKEN"]\n\n**Returns**:\n - An attribute object that represents the `web_sso_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.iam_workforce_pool_provider.oidc.web_sso_config.new` constructs a new object with attributes and blocks configured for the `web_sso_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `additional_scopes` (`list`): Additional scopes to request for in the OIDC authentication request on top of scopes requested by default. By default, the 'openid', 'profile' and 'email' scopes that are supported by the identity provider are requested.\nEach additional scope may be at most 256 characters. A maximum of 10 additional scopes may be configured. When `null`, the `additional_scopes` field will be omitted from the resulting object.\n - `assertion_claims_behavior` (`string`): The behavior for how OIDC Claims are included in the 'assertion' object used for attribute mapping and attribute condition.\n* MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS: Merge the UserInfo Endpoint Claims with ID Token Claims, preferring UserInfo Claim Values for the same Claim Name. This option is available only for the Authorization Code Flow.\n* ONLY_ID_TOKEN_CLAIMS: Only include ID Token Claims. Possible values: ["MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS", "ONLY_ID_TOKEN_CLAIMS"]\n - `response_type` (`string`): The Response Type to request for in the OIDC Authorization Request for web sign-in.\n\nThe 'CODE' Response Type is recommended to avoid the Implicit Flow, for security reasons.\n* CODE: The 'response_type=code' selection uses the Authorization Code Flow for web sign-in. Requires a configured client secret.\n* ID_TOKEN: The 'response_type=id_token' selection uses the Implicit Flow for web sign-in. Possible values: ["CODE", "ID_TOKEN"]\n\n**Returns**:\n - An attribute object that represents the `web_sso_config` sub block.\n', args=[]), new( assertion_claims_behavior, - response_type + response_type, + additional_scopes=null ):: std.prune(a={ + additional_scopes: additional_scopes, assertion_claims_behavior: assertion_claims_behavior, response_type: response_type, }), diff --git a/4.x/_gen/resources/monitoring_uptime_check_config.libsonnet b/4.x/_gen/resources/monitoring_uptime_check_config.libsonnet index 148360e..20a527d 100644 --- a/4.x/_gen/resources/monitoring_uptime_check_config.libsonnet +++ b/4.x/_gen/resources/monitoring_uptime_check_config.libsonnet @@ -82,7 +82,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type: type, }), }, - '#new':: d.fn(help="\n`google.monitoring_uptime_check_config.new` injects a new `google_monitoring_uptime_check_config` 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.monitoring_uptime_check_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.monitoring_uptime_check_config` using the reference:\n\n $._ref.google_monitoring_uptime_check_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_monitoring_uptime_check_config.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 - `checker_type` (`string`): The checker type to use for the check. If the monitored resource type is servicedirectory_service, checkerType must be set to VPC_CHECKERS. Possible values: [\u0026#34;STATIC_IP_CHECKERS\u0026#34;, \u0026#34;VPC_CHECKERS\u0026#34;] When `null`, the `checker_type` field will be omitted from the resulting object.\n - `display_name` (`string`): A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.\n - `period` (`string`): How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s. When `null`, the `period` 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 - `selected_regions` (`list`): The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. When `null`, the `selected_regions` field will be omitted from the resulting object.\n - `timeout` (`string`): The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration\n - `content_matchers` (`list[obj]`): The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response\u0026#39;s content. This field is optional and should only be specified if a content match is required. When `null`, the `content_matchers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.content_matchers.new](#fn-content_matchersnew) constructor.\n - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor.\n - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor.\n - `resource_group` (`list[obj]`): The group resource associated with the configuration. When `null`, the `resource_group` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.resource_group.new](#fn-resource_groupnew) constructor.\n - `tcp_check` (`list[obj]`): Contains information needed to make a TCP check. When `null`, the `tcp_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.new](#fn-tcp_checknew) 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.monitoring_uptime_check_config.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.monitoring_uptime_check_config.new` injects a new `google_monitoring_uptime_check_config` 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.monitoring_uptime_check_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.monitoring_uptime_check_config` using the reference:\n\n $._ref.google_monitoring_uptime_check_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_monitoring_uptime_check_config.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 - `checker_type` (`string`): The checker type to use for the check. If the monitored resource type is servicedirectory_service, checkerType must be set to VPC_CHECKERS. Possible values: [\u0026#34;STATIC_IP_CHECKERS\u0026#34;, \u0026#34;VPC_CHECKERS\u0026#34;] When `null`, the `checker_type` field will be omitted from the resulting object.\n - `display_name` (`string`): A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.\n - `period` (`string`): How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s. When `null`, the `period` 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 - `selected_regions` (`list`): The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. When `null`, the `selected_regions` field will be omitted from the resulting object.\n - `timeout` (`string`): The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration\n - `content_matchers` (`list[obj]`): The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response\u0026#39;s content. This field is optional and should only be specified if a content match is required. When `null`, the `content_matchers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.content_matchers.new](#fn-content_matchersnew) constructor.\n - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor.\n - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor.\n - `resource_group` (`list[obj]`): The group resource associated with the configuration. When `null`, the `resource_group` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.resource_group.new](#fn-resource_groupnew) constructor.\n - `synthetic_monitor` (`list[obj]`): A Synthetic Monitor deployed to a Cloud Functions V2 instance. When `null`, the `synthetic_monitor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.synthetic_monitor.new](#fn-synthetic_monitornew) constructor.\n - `tcp_check` (`list[obj]`): Contains information needed to make a TCP check. When `null`, the `tcp_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.new](#fn-tcp_checknew) 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.monitoring_uptime_check_config.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, @@ -95,6 +95,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); project=null, resource_group=null, selected_regions=null, + synthetic_monitor=null, tcp_check=null, timeouts=null, _meta={} @@ -111,13 +112,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); project=project, resource_group=resource_group, selected_regions=selected_regions, + synthetic_monitor=synthetic_monitor, tcp_check=tcp_check, timeout=timeout, timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.monitoring_uptime_check_config.newAttrs` constructs a new object with attributes and blocks configured for the `monitoring_uptime_check_config`\nTerraform resource.\n\nUnlike [google.monitoring_uptime_check_config.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 - `checker_type` (`string`): The checker type to use for the check. If the monitored resource type is servicedirectory_service, checkerType must be set to VPC_CHECKERS. Possible values: ["STATIC_IP_CHECKERS", "VPC_CHECKERS"] When `null`, the `checker_type` field will be omitted from the resulting object.\n - `display_name` (`string`): A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.\n - `period` (`string`): How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s. When `null`, the `period` 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 - `selected_regions` (`list`): The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. When `null`, the `selected_regions` field will be omitted from the resulting object.\n - `timeout` (`string`): The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration\n - `content_matchers` (`list[obj]`): The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required. When `null`, the `content_matchers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.content_matchers.new](#fn-content_matchersnew) constructor.\n - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor.\n - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor.\n - `resource_group` (`list[obj]`): The group resource associated with the configuration. When `null`, the `resource_group` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.resource_group.new](#fn-resource_groupnew) constructor.\n - `tcp_check` (`list[obj]`): Contains information needed to make a TCP check. When `null`, the `tcp_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.new](#fn-tcp_checknew) 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.monitoring_uptime_check_config.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 `monitoring_uptime_check_config` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.monitoring_uptime_check_config.newAttrs` constructs a new object with attributes and blocks configured for the `monitoring_uptime_check_config`\nTerraform resource.\n\nUnlike [google.monitoring_uptime_check_config.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 - `checker_type` (`string`): The checker type to use for the check. If the monitored resource type is servicedirectory_service, checkerType must be set to VPC_CHECKERS. Possible values: ["STATIC_IP_CHECKERS", "VPC_CHECKERS"] When `null`, the `checker_type` field will be omitted from the resulting object.\n - `display_name` (`string`): A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.\n - `period` (`string`): How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s. When `null`, the `period` 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 - `selected_regions` (`list`): The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. When `null`, the `selected_regions` field will be omitted from the resulting object.\n - `timeout` (`string`): The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration\n - `content_matchers` (`list[obj]`): The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required. When `null`, the `content_matchers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.content_matchers.new](#fn-content_matchersnew) constructor.\n - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor.\n - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor.\n - `resource_group` (`list[obj]`): The group resource associated with the configuration. When `null`, the `resource_group` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.resource_group.new](#fn-resource_groupnew) constructor.\n - `synthetic_monitor` (`list[obj]`): A Synthetic Monitor deployed to a Cloud Functions V2 instance. When `null`, the `synthetic_monitor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.synthetic_monitor.new](#fn-synthetic_monitornew) constructor.\n - `tcp_check` (`list[obj]`): Contains information needed to make a TCP check. When `null`, the `tcp_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.new](#fn-tcp_checknew) 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.monitoring_uptime_check_config.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 `monitoring_uptime_check_config` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, timeout, @@ -129,6 +131,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); project=null, resource_group=null, selected_regions=null, + synthetic_monitor=null, tcp_check=null, timeouts=null ):: std.prune(a={ @@ -141,6 +144,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); project: project, resource_group: resource_group, selected_regions: selected_regions, + synthetic_monitor: synthetic_monitor, tcp_check: tcp_check, timeout: timeout, timeouts: timeouts, @@ -155,6 +159,22 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); resource_type: resource_type, }), }, + synthetic_monitor:: { + cloud_function_v2:: { + '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.synthetic_monitor.cloud_function_v2.new` constructs a new object with attributes and blocks configured for the `cloud_function_v2`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): The fully qualified name of the cloud function resource.\n\n**Returns**:\n - An attribute object that represents the `cloud_function_v2` sub block.\n', args=[]), + new( + name + ):: std.prune(a={ + name: name, + }), + }, + '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.synthetic_monitor.new` constructs a new object with attributes and blocks configured for the `synthetic_monitor`\nTerraform sub block.\n\n\n\n**Args**:\n - `cloud_function_v2` (`list[obj]`): Target a Synthetic Monitor GCFv2 Instance When `null`, the `cloud_function_v2` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.synthetic_monitor.cloud_function_v2.new](#fn-synthetic_monitorcloud_function_v2new) constructor.\n\n**Returns**:\n - An attribute object that represents the `synthetic_monitor` sub block.\n', args=[]), + new( + cloud_function_v2=null + ):: std.prune(a={ + cloud_function_v2: cloud_function_v2, + }), + }, tcp_check:: { '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.tcp_check.new` constructs a new object with attributes and blocks configured for the `tcp_check`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.\n\n**Returns**:\n - An attribute object that represents the `tcp_check` sub block.\n', args=[]), new( @@ -305,6 +325,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSyntheticMonitor':: d.fn(help='`google.list[obj].withSyntheticMonitor` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the synthetic_monitor 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].withSyntheticMonitorMixin](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 `synthetic_monitor` field.\n', args=[]), + withSyntheticMonitor(resourceLabel, value): { + resource+: { + google_monitoring_uptime_check_config+: { + [resourceLabel]+: { + synthetic_monitor: value, + }, + }, + }, + }, + '#withSyntheticMonitorMixin':: d.fn(help='`google.list[obj].withSyntheticMonitorMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the synthetic_monitor 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].withSyntheticMonitor](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 `synthetic_monitor` field.\n', args=[]), + withSyntheticMonitorMixin(resourceLabel, value): { + resource+: { + google_monitoring_uptime_check_config+: { + [resourceLabel]+: { + synthetic_monitor+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withTcpCheck':: d.fn(help='`google.list[obj].withTcpCheck` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the tcp_check 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].withTcpCheckMixin](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 `tcp_check` field.\n', args=[]), withTcpCheck(resourceLabel, value): { resource+: { diff --git a/docs/4.x/README.md b/docs/4.x/README.md index 2483d91..c0d8274 100644 --- a/docs/4.x/README.md +++ b/docs/4.x/README.md @@ -70,6 +70,8 @@ project. * [beyondcorp_app_connection](beyondcorp_app_connection.md) * [beyondcorp_app_connector](beyondcorp_app_connector.md) * [beyondcorp_app_gateway](beyondcorp_app_gateway.md) +* [biglake_catalog](biglake_catalog.md) +* [biglake_database](biglake_database.md) * [bigquery_analytics_hub_data_exchange](bigquery_analytics_hub_data_exchange.md) * [bigquery_analytics_hub_data_exchange_iam_binding](bigquery_analytics_hub_data_exchange_iam_binding.md) * [bigquery_analytics_hub_data_exchange_iam_member](bigquery_analytics_hub_data_exchange_iam_member.md) @@ -440,9 +442,16 @@ project. * [gke_hub_feature_iam_policy](gke_hub_feature_iam_policy.md) * [gke_hub_feature_membership](gke_hub_feature_membership.md) * [gke_hub_membership](gke_hub_membership.md) +* [gke_hub_membership_binding](gke_hub_membership_binding.md) * [gke_hub_membership_iam_binding](gke_hub_membership_iam_binding.md) * [gke_hub_membership_iam_member](gke_hub_membership_iam_member.md) * [gke_hub_membership_iam_policy](gke_hub_membership_iam_policy.md) +* [gke_hub_namespace](gke_hub_namespace.md) +* [gke_hub_scope](gke_hub_scope.md) +* [gke_hub_scope_iam_binding](gke_hub_scope_iam_binding.md) +* [gke_hub_scope_iam_member](gke_hub_scope_iam_member.md) +* [gke_hub_scope_iam_policy](gke_hub_scope_iam_policy.md) +* [gke_hub_scope_rbac_role_binding](gke_hub_scope_rbac_role_binding.md) * [healthcare_consent_store](healthcare_consent_store.md) * [healthcare_consent_store_iam_binding](healthcare_consent_store_iam_binding.md) * [healthcare_consent_store_iam_member](healthcare_consent_store_iam_member.md) diff --git a/docs/4.x/biglake_catalog.md b/docs/4.x/biglake_catalog.md new file mode 100644 index 0000000..ed5bdc1 --- /dev/null +++ b/docs/4.x/biglake_catalog.md @@ -0,0 +1,198 @@ +--- +permalink: /biglake_catalog/ +--- + +# biglake_catalog + +`biglake_catalog` represents the `google_biglake_catalog` 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 withLocation()`](#fn-withlocation) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.biglake_catalog.new` injects a new `google_biglake_catalog` 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.biglake_catalog.new('some_id') + +You can get the reference to the `id` field of the created `google.biglake_catalog` using the reference: + + $._ref.google_biglake_catalog.some_id.get('id') + +This is the same as directly entering `"${ google_biglake_catalog.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. + - `location` (`string`): The geographic location where the Catalog should reside. + - `name` (`string`): The name of the Catalog. Format: +projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId} + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` 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.biglake_catalog.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.biglake_catalog.newAttrs` constructs a new object with attributes and blocks configured for the `biglake_catalog` +Terraform resource. + +Unlike [google.biglake_catalog.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**: + - `location` (`string`): The geographic location where the Catalog should reside. + - `name` (`string`): The name of the Catalog. Format: +projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId} + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` 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.biglake_catalog.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 `biglake_catalog` resource into the root Terraform configuration. + + +### fn withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` 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. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.biglake_catalog.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/biglake_database.md b/docs/4.x/biglake_database.md new file mode 100644 index 0000000..6507437 --- /dev/null +++ b/docs/4.x/biglake_database.md @@ -0,0 +1,266 @@ +--- +permalink: /biglake_database/ +--- + +# biglake_database + +`biglake_database` represents the `google_biglake_database` 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 withCatalog()`](#fn-withcatalog) +* [`fn withHiveOptions()`](#fn-withhiveoptions) +* [`fn withHiveOptionsMixin()`](#fn-withhiveoptionsmixin) +* [`fn withName()`](#fn-withname) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withType()`](#fn-withtype) +* [`obj hive_options`](#obj-hive_options) + * [`fn new()`](#fn-hive_optionsnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.biglake_database.new` injects a new `google_biglake_database` 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.biglake_database.new('some_id') + +You can get the reference to the `id` field of the created `google.biglake_database` using the reference: + + $._ref.google_biglake_database.some_id.get('id') + +This is the same as directly entering `"${ google_biglake_database.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. + - `catalog` (`string`): The parent catalog. + - `name` (`string`): The name of the database. + - `type` (`string`): The database type. + - `hive_options` (`list[obj]`): Options of a Hive database. When `null`, the `hive_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.biglake_database.hive_options.new](#fn-hive_optionsnew) 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.biglake_database.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.biglake_database.newAttrs` constructs a new object with attributes and blocks configured for the `biglake_database` +Terraform resource. + +Unlike [google.biglake_database.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**: + - `catalog` (`string`): The parent catalog. + - `name` (`string`): The name of the database. + - `type` (`string`): The database type. + - `hive_options` (`list[obj]`): Options of a Hive database. When `null`, the `hive_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.biglake_database.hive_options.new](#fn-hive_optionsnew) 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.biglake_database.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 `biglake_database` resource into the root Terraform configuration. + + +### fn withCatalog + +```ts +withCatalog() +``` + +`google.string.withCatalog` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the catalog field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `catalog` field. + + +### fn withHiveOptions + +```ts +withHiveOptions() +``` + +`google.list[obj].withHiveOptions` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the hive_options 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].withHiveOptionsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `hive_options` field. + + +### fn withHiveOptionsMixin + +```ts +withHiveOptionsMixin() +``` + +`google.list[obj].withHiveOptionsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the hive_options 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].withHiveOptions](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `hive_options` field. + + +### fn withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` 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 withType + +```ts +withType() +``` + +`google.string.withType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `type` field. + + +## obj hive_options + + + +### fn hive_options.new + +```ts +new() +``` + + +`google.biglake_database.hive_options.new` constructs a new object with attributes and blocks configured for the `hive_options` +Terraform sub block. + + + +**Args**: + - `location_uri` (`string`): Cloud Storage folder URI where the database data is stored, starting with "gs://". When `null`, the `location_uri` field will be omitted from the resulting object. + - `parameters` (`obj`): Stores user supplied Hive database parameters. An object containing a +list of"key": value pairs. +Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. When `null`, the `parameters` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `hive_options` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.biglake_database.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/cloud_run_v2_job.md b/docs/4.x/cloud_run_v2_job.md index 261c788..344f114 100644 --- a/docs/4.x/cloud_run_v2_job.md +++ b/docs/4.x/cloud_run_v2_job.md @@ -980,7 +980,7 @@ Terraform sub block. **Args**: - - `mode` (`number`): Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. + - `mode` (`number`): Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. When `null`, the `mode` field will be omitted from the resulting object. - `path` (`string`): The relative path of the secret in the container. - `version` (`string`): The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version diff --git a/docs/4.x/cloud_run_v2_service.md b/docs/4.x/cloud_run_v2_service.md index 2974265..1e2ae3c 100644 --- a/docs/4.x/cloud_run_v2_service.md +++ b/docs/4.x/cloud_run_v2_service.md @@ -1127,7 +1127,7 @@ Terraform sub block. **Args**: - - `mode` (`number`): Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. + - `mode` (`number`): Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. When `null`, the `mode` field will be omitted from the resulting object. - `path` (`string`): The relative path of the secret in the container. - `version` (`string`): The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version When `null`, the `version` field will be omitted from the resulting object. diff --git a/docs/4.x/compute_region_target_https_proxy.md b/docs/4.x/compute_region_target_https_proxy.md index 5915ec6..9fb6daf 100644 --- a/docs/4.x/compute_region_target_https_proxy.md +++ b/docs/4.x/compute_region_target_https_proxy.md @@ -20,6 +20,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withProject()`](#fn-withproject) * [`fn withRegion()`](#fn-withregion) * [`fn withSslCertificates()`](#fn-withsslcertificates) +* [`fn withSslPolicy()`](#fn-withsslpolicy) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`fn withUrlMap()`](#fn-withurlmap) @@ -69,6 +70,9 @@ If it is not provided, the provider region is used. When `null`, the `region` fi - `ssl_certificates` (`list`): A list of RegionSslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified. + - `ssl_policy` (`string`): A reference to the Region SslPolicy resource that will be associated with +the TargetHttpsProxy resource. If not set, the TargetHttpsProxy +resource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object. - `url_map` (`string`): A reference to the RegionUrlMap resource that defines the mapping from URL to the RegionBackendService. - `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_region_target_https_proxy.timeouts.new](#fn-timeoutsnew) constructor. @@ -109,6 +113,9 @@ If it is not provided, the provider region is used. When `null`, the `region` fi - `ssl_certificates` (`list`): A list of RegionSslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified. + - `ssl_policy` (`string`): A reference to the Region SslPolicy resource that will be associated with +the TargetHttpsProxy resource. If not set, the TargetHttpsProxy +resource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object. - `url_map` (`string`): A reference to the RegionUrlMap resource that defines the mapping from URL to the RegionBackendService. - `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_region_target_https_proxy.timeouts.new](#fn-timeoutsnew) constructor. @@ -197,6 +204,22 @@ Terraform resource block to set or update the ssl_certificates field. - `value` (`list`): The value to set for the `ssl_certificates` field. +### fn withSslPolicy + +```ts +withSslPolicy() +``` + +`google.string.withSslPolicy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the ssl_policy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `ssl_policy` field. + + ### fn withTimeouts ```ts diff --git a/docs/4.x/container_cluster.md b/docs/4.x/container_cluster.md index cb75679..685d40c 100644 --- a/docs/4.x/container_cluster.md +++ b/docs/4.x/container_cluster.md @@ -201,6 +201,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-node_confignew) * [`obj node_config.advanced_machine_features`](#obj-node_configadvanced_machine_features) * [`fn new()`](#fn-node_configadvanced_machine_featuresnew) + * [`obj node_config.confidential_nodes`](#obj-node_configconfidential_nodes) + * [`fn new()`](#fn-node_configconfidential_nodesnew) * [`obj node_config.ephemeral_storage_local_ssd_config`](#obj-node_configephemeral_storage_local_ssd_config) * [`fn new()`](#fn-node_configephemeral_storage_local_ssd_confignew) * [`obj node_config.gcfs_config`](#obj-node_configgcfs_config) @@ -239,6 +241,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-node_poolnode_confignew) * [`obj node_pool.node_config.advanced_machine_features`](#obj-node_poolnode_configadvanced_machine_features) * [`fn new()`](#fn-node_poolnode_configadvanced_machine_featuresnew) + * [`obj node_pool.node_config.confidential_nodes`](#obj-node_poolnode_configconfidential_nodes) + * [`fn new()`](#fn-node_poolnode_configconfidential_nodesnew) * [`obj node_pool.node_config.ephemeral_storage_local_ssd_config`](#obj-node_poolnode_configephemeral_storage_local_ssd_config) * [`fn new()`](#fn-node_poolnode_configephemeral_storage_local_ssd_confignew) * [`obj node_pool.node_config.gcfs_config`](#obj-node_poolnode_configgcfs_config) @@ -3224,6 +3228,7 @@ Terraform sub block. - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object. - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object. - `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. + - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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.confidential_nodes.new](#fn-node_configconfidential_nodesnew) constructor. - `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. - `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. - `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. @@ -3263,6 +3268,29 @@ Terraform sub block. - An attribute object that represents the `advanced_machine_features` sub block. +## obj node_config.confidential_nodes + + + +### fn node_config.confidential_nodes.new + +```ts +new() +``` + + +`google.container_cluster.node_config.confidential_nodes.new` constructs a new object with attributes and blocks configured for the `confidential_nodes` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Whether Confidential Nodes feature is enabled for all nodes in this pool. + +**Returns**: + - An attribute object that represents the `confidential_nodes` sub block. + + ## obj node_config.ephemeral_storage_local_ssd_config @@ -3720,6 +3748,7 @@ Terraform sub block. - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object. - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object. - `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. + - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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.confidential_nodes.new](#fn-node_poolnode_poolconfidential_nodesnew) constructor. - `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. - `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. - `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. @@ -3759,6 +3788,29 @@ Terraform sub block. - An attribute object that represents the `advanced_machine_features` sub block. +## obj node_pool.node_config.confidential_nodes + + + +### fn node_pool.node_config.confidential_nodes.new + +```ts +new() +``` + + +`google.container_cluster.node_pool.node_config.confidential_nodes.new` constructs a new object with attributes and blocks configured for the `confidential_nodes` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Whether Confidential Nodes feature is enabled for all nodes in this pool. + +**Returns**: + - An attribute object that represents the `confidential_nodes` sub block. + + ## obj node_pool.node_config.ephemeral_storage_local_ssd_config diff --git a/docs/4.x/container_node_pool.md b/docs/4.x/container_node_pool.md index 4eac2b5..252ee9d 100644 --- a/docs/4.x/container_node_pool.md +++ b/docs/4.x/container_node_pool.md @@ -51,6 +51,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-node_confignew) * [`obj node_config.advanced_machine_features`](#obj-node_configadvanced_machine_features) * [`fn new()`](#fn-node_configadvanced_machine_featuresnew) + * [`obj node_config.confidential_nodes`](#obj-node_configconfidential_nodes) + * [`fn new()`](#fn-node_configconfidential_nodesnew) * [`obj node_config.ephemeral_storage_local_ssd_config`](#obj-node_configephemeral_storage_local_ssd_config) * [`fn new()`](#fn-node_configephemeral_storage_local_ssd_confignew) * [`obj node_config.gcfs_config`](#obj-node_configgcfs_config) @@ -733,6 +735,7 @@ Terraform sub block. - `tags` (`list`): The list of instance tags applied to all nodes. When `null`, the `tags` field will be omitted from the resulting object. - `taint` (`list`): List of Kubernetes taints to be applied to each node. When `null`, the `taint` field will be omitted from the resulting object. - `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. + - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after pool creation without deleting and recreating the entire pool. When `null`, the `confidential_nodes` 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.confidential_nodes.new](#fn-node_configconfidential_nodesnew) constructor. - `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. - `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. - `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. @@ -772,6 +775,29 @@ Terraform sub block. - An attribute object that represents the `advanced_machine_features` sub block. +## obj node_config.confidential_nodes + + + +### fn node_config.confidential_nodes.new + +```ts +new() +``` + + +`google.container_node_pool.node_config.confidential_nodes.new` constructs a new object with attributes and blocks configured for the `confidential_nodes` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Whether Confidential Nodes feature is enabled for all nodes in this pool. + +**Returns**: + - An attribute object that represents the `confidential_nodes` sub block. + + ## obj node_config.ephemeral_storage_local_ssd_config diff --git a/docs/4.x/data/gke_hub_scope_iam_policy.md b/docs/4.x/data/gke_hub_scope_iam_policy.md new file mode 100644 index 0000000..fa57460 --- /dev/null +++ b/docs/4.x/data/gke_hub_scope_iam_policy.md @@ -0,0 +1,111 @@ +--- +permalink: /data/gke_hub_scope_iam_policy/ +--- + +# data.gke_hub_scope_iam_policy + +`gke_hub_scope_iam_policy` represents the `google_gke_hub_scope_iam_policy` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withProject()`](#fn-withproject) +* [`fn withScopeId()`](#fn-withscopeid) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.data.gke_hub_scope_iam_policy.new` injects a new `data_google_gke_hub_scope_iam_policy` Terraform `data source` +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.data.gke_hub_scope_iam_policy.new('some_id') + +You can get the reference to the `id` field of the created `google.data.gke_hub_scope_iam_policy` using the reference: + + $._ref.data_google_gke_hub_scope_iam_policy.some_id.get('id') + +This is the same as directly entering `"${ data_google_gke_hub_scope_iam_policy.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**: + - `dataSrcLabel` (`string`): The name label of the block. + - `project` (`string`): Set the `project` field on the resulting data source block. When `null`, the `project` field will be omitted from the resulting object. + - `scope_id` (`string`): Set the `scope_id` field on the resulting data source block. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.data.gke_hub_scope_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope_iam_policy` +Terraform data source. + +Unlike [google.data.gke_hub_scope_iam_policy.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) 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**: + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `scope_id` (`string`): Set the `scope_id` field on the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `gke_hub_scope_iam_policy` data source into the root Terraform configuration. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the project field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withScopeId + +```ts +withScopeId() +``` + +`google.string.withScopeId` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the scope_id field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope_id` field. diff --git a/docs/4.x/data/index.md b/docs/4.x/data/index.md index 2c6e3b7..b9ca8eb 100644 --- a/docs/4.x/data/index.md +++ b/docs/4.x/data/index.md @@ -132,6 +132,7 @@ permalink: /data/ * [gke_backup_backup_plan_iam_policy](gke_backup_backup_plan_iam_policy.md) * [gke_hub_feature_iam_policy](gke_hub_feature_iam_policy.md) * [gke_hub_membership_iam_policy](gke_hub_membership_iam_policy.md) +* [gke_hub_scope_iam_policy](gke_hub_scope_iam_policy.md) * [healthcare_consent_store_iam_policy](healthcare_consent_store_iam_policy.md) * [healthcare_dataset_iam_policy](healthcare_dataset_iam_policy.md) * [healthcare_dicom_store_iam_policy](healthcare_dicom_store_iam_policy.md) diff --git a/docs/4.x/dialogflow_cx_flow.md b/docs/4.x/dialogflow_cx_flow.md index 1e783cb..166f090 100644 --- a/docs/4.x/dialogflow_cx_flow.md +++ b/docs/4.x/dialogflow_cx_flow.md @@ -32,10 +32,24 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-event_handlersnew) * [`obj event_handlers.trigger_fulfillment`](#obj-event_handlerstrigger_fulfillment) * [`fn new()`](#fn-event_handlerstrigger_fulfillmentnew) + * [`obj event_handlers.trigger_fulfillment.conditional_cases`](#obj-event_handlerstrigger_fulfillmentconditional_cases) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentconditional_casesnew) * [`obj event_handlers.trigger_fulfillment.messages`](#obj-event_handlerstrigger_fulfillmentmessages) * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagesnew) + * [`obj event_handlers.trigger_fulfillment.messages.conversation_success`](#obj-event_handlerstrigger_fulfillmentmessagesconversation_success) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagesconversation_successnew) + * [`obj event_handlers.trigger_fulfillment.messages.live_agent_handoff`](#obj-event_handlerstrigger_fulfillmentmessageslive_agent_handoff) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessageslive_agent_handoffnew) + * [`obj event_handlers.trigger_fulfillment.messages.output_audio_text`](#obj-event_handlerstrigger_fulfillmentmessagesoutput_audio_text) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagesoutput_audio_textnew) + * [`obj event_handlers.trigger_fulfillment.messages.play_audio`](#obj-event_handlerstrigger_fulfillmentmessagesplay_audio) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagesplay_audionew) + * [`obj event_handlers.trigger_fulfillment.messages.telephony_transfer_call`](#obj-event_handlerstrigger_fulfillmentmessagestelephony_transfer_call) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagestelephony_transfer_callnew) * [`obj event_handlers.trigger_fulfillment.messages.text`](#obj-event_handlerstrigger_fulfillmentmessagestext) * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagestextnew) + * [`obj event_handlers.trigger_fulfillment.set_parameter_actions`](#obj-event_handlerstrigger_fulfillmentset_parameter_actions) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentset_parameter_actionsnew) * [`obj nlu_settings`](#obj-nlu_settings) * [`fn new()`](#fn-nlu_settingsnew) * [`obj timeouts`](#obj-timeouts) @@ -44,10 +58,24 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-transition_routesnew) * [`obj transition_routes.trigger_fulfillment`](#obj-transition_routestrigger_fulfillment) * [`fn new()`](#fn-transition_routestrigger_fulfillmentnew) + * [`obj transition_routes.trigger_fulfillment.conditional_cases`](#obj-transition_routestrigger_fulfillmentconditional_cases) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentconditional_casesnew) * [`obj transition_routes.trigger_fulfillment.messages`](#obj-transition_routestrigger_fulfillmentmessages) * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagesnew) + * [`obj transition_routes.trigger_fulfillment.messages.conversation_success`](#obj-transition_routestrigger_fulfillmentmessagesconversation_success) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagesconversation_successnew) + * [`obj transition_routes.trigger_fulfillment.messages.live_agent_handoff`](#obj-transition_routestrigger_fulfillmentmessageslive_agent_handoff) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessageslive_agent_handoffnew) + * [`obj transition_routes.trigger_fulfillment.messages.output_audio_text`](#obj-transition_routestrigger_fulfillmentmessagesoutput_audio_text) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagesoutput_audio_textnew) + * [`obj transition_routes.trigger_fulfillment.messages.play_audio`](#obj-transition_routestrigger_fulfillmentmessagesplay_audio) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagesplay_audionew) + * [`obj transition_routes.trigger_fulfillment.messages.telephony_transfer_call`](#obj-transition_routestrigger_fulfillmentmessagestelephony_transfer_call) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagestelephony_transfer_callnew) * [`obj transition_routes.trigger_fulfillment.messages.text`](#obj-transition_routestrigger_fulfillmentmessagestext) * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagestextnew) + * [`obj transition_routes.trigger_fulfillment.set_parameter_actions`](#obj-transition_routestrigger_fulfillmentset_parameter_actions) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentset_parameter_actionsnew) ## Fields @@ -437,12 +465,38 @@ Terraform sub block. - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object. - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object. - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object. + - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.conditional_cases.new](#fn-event_handlersevent_handlersconditional_casesnew) constructor. - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.new](#fn-event_handlersevent_handlersmessagesnew) constructor. + - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_flow.event_handlers.trigger_fulfillment.set_parameter_actions.new](#fn-event_handlersevent_handlersset_parameter_actionsnew) constructor. **Returns**: - An attribute object that represents the `trigger_fulfillment` sub block. +## obj event_handlers.trigger_fulfillment.conditional_cases + + + +### fn event_handlers.trigger_fulfillment.conditional_cases.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases` +Terraform sub block. + + + +**Args**: + - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. +See [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conditional_cases` sub block. + + ## obj event_handlers.trigger_fulfillment.messages @@ -460,12 +514,143 @@ Terraform sub block. **Args**: + - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object. + - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object. + - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. +Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded. +* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.conversation_success.new](#fn-event_handlersevent_handlerstrigger_fulfillmentconversation_successnew) constructor. + - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent. +Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. +* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.live_agent_handoff.new](#fn-event_handlersevent_handlerstrigger_fulfillmentlive_agent_handoffnew) constructor. + - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.output_audio_text.new](#fn-event_handlersevent_handlerstrigger_fulfillmentoutput_audio_textnew) constructor. + - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.play_audio.new](#fn-event_handlersevent_handlerstrigger_fulfillmentplay_audionew) constructor. + - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new](#fn-event_handlersevent_handlerstrigger_fulfillmenttelephony_transfer_callnew) constructor. - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.text.new](#fn-event_handlersevent_handlerstrigger_fulfillmenttextnew) constructor. **Returns**: - An attribute object that represents the `messages` sub block. +## obj event_handlers.trigger_fulfillment.messages.conversation_success + + + +### fn event_handlers.trigger_fulfillment.messages.conversation_success.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conversation_success` sub block. + + +## obj event_handlers.trigger_fulfillment.messages.live_agent_handoff + + + +### fn event_handlers.trigger_fulfillment.messages.live_agent_handoff.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `live_agent_handoff` sub block. + + +## obj event_handlers.trigger_fulfillment.messages.output_audio_text + + + +### fn event_handlers.trigger_fulfillment.messages.output_audio_text.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text` +Terraform sub block. + + + +**Args**: + - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object. + - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `output_audio_text` sub block. + + +## obj event_handlers.trigger_fulfillment.messages.play_audio + + + +### fn event_handlers.trigger_fulfillment.messages.play_audio.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio` +Terraform sub block. + + + +**Args**: + - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + +**Returns**: + - An attribute object that represents the `play_audio` sub block. + + +## obj event_handlers.trigger_fulfillment.messages.telephony_transfer_call + + + +### fn event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call` +Terraform sub block. + + + +**Args**: + - `phone_number` (`string`): Transfer the call to a phone number in E.164 format. + +**Returns**: + - An attribute object that represents the `telephony_transfer_call` sub block. + + ## obj event_handlers.trigger_fulfillment.messages.text @@ -489,6 +674,30 @@ Terraform sub block. - An attribute object that represents the `text` sub block. +## obj event_handlers.trigger_fulfillment.set_parameter_actions + + + +### fn event_handlers.trigger_fulfillment.set_parameter_actions.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.event_handlers.trigger_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions` +Terraform sub block. + + + +**Args**: + - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object. + - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `set_parameter_actions` sub block. + + ## obj nlu_settings @@ -595,12 +804,38 @@ Terraform sub block. - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object. - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object. - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object. + - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.conditional_cases.new](#fn-transition_routestransition_routesconditional_casesnew) constructor. - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.new](#fn-transition_routestransition_routesmessagesnew) constructor. + - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_flow.transition_routes.trigger_fulfillment.set_parameter_actions.new](#fn-transition_routestransition_routesset_parameter_actionsnew) constructor. **Returns**: - An attribute object that represents the `trigger_fulfillment` sub block. +## obj transition_routes.trigger_fulfillment.conditional_cases + + + +### fn transition_routes.trigger_fulfillment.conditional_cases.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases` +Terraform sub block. + + + +**Args**: + - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. +See [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conditional_cases` sub block. + + ## obj transition_routes.trigger_fulfillment.messages @@ -618,12 +853,143 @@ Terraform sub block. **Args**: + - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object. + - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object. + - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. +Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded. +* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.conversation_success.new](#fn-transition_routestransition_routestrigger_fulfillmentconversation_successnew) constructor. + - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent. +Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. +* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.live_agent_handoff.new](#fn-transition_routestransition_routestrigger_fulfillmentlive_agent_handoffnew) constructor. + - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.output_audio_text.new](#fn-transition_routestransition_routestrigger_fulfillmentoutput_audio_textnew) constructor. + - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.play_audio.new](#fn-transition_routestransition_routestrigger_fulfillmentplay_audionew) constructor. + - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new](#fn-transition_routestransition_routestrigger_fulfillmenttelephony_transfer_callnew) constructor. - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.text.new](#fn-transition_routestransition_routestrigger_fulfillmenttextnew) constructor. **Returns**: - An attribute object that represents the `messages` sub block. +## obj transition_routes.trigger_fulfillment.messages.conversation_success + + + +### fn transition_routes.trigger_fulfillment.messages.conversation_success.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conversation_success` sub block. + + +## obj transition_routes.trigger_fulfillment.messages.live_agent_handoff + + + +### fn transition_routes.trigger_fulfillment.messages.live_agent_handoff.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `live_agent_handoff` sub block. + + +## obj transition_routes.trigger_fulfillment.messages.output_audio_text + + + +### fn transition_routes.trigger_fulfillment.messages.output_audio_text.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text` +Terraform sub block. + + + +**Args**: + - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object. + - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `output_audio_text` sub block. + + +## obj transition_routes.trigger_fulfillment.messages.play_audio + + + +### fn transition_routes.trigger_fulfillment.messages.play_audio.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio` +Terraform sub block. + + + +**Args**: + - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + +**Returns**: + - An attribute object that represents the `play_audio` sub block. + + +## obj transition_routes.trigger_fulfillment.messages.telephony_transfer_call + + + +### fn transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call` +Terraform sub block. + + + +**Args**: + - `phone_number` (`string`): Transfer the call to a phone number in E.164 format. + +**Returns**: + - An attribute object that represents the `telephony_transfer_call` sub block. + + ## obj transition_routes.trigger_fulfillment.messages.text @@ -645,3 +1011,27 @@ Terraform sub block. **Returns**: - An attribute object that represents the `text` sub block. + + +## obj transition_routes.trigger_fulfillment.set_parameter_actions + + + +### fn transition_routes.trigger_fulfillment.set_parameter_actions.new + +```ts +new() +``` + + +`google.dialogflow_cx_flow.transition_routes.trigger_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions` +Terraform sub block. + + + +**Args**: + - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object. + - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `set_parameter_actions` sub block. diff --git a/docs/4.x/dialogflow_cx_page.md b/docs/4.x/dialogflow_cx_page.md index 3b177e6..72a555c 100644 --- a/docs/4.x/dialogflow_cx_page.md +++ b/docs/4.x/dialogflow_cx_page.md @@ -31,18 +31,46 @@ This package contains functions and utilities for setting up the resource using * [`fn withTransitionRoutesMixin()`](#fn-withtransitionroutesmixin) * [`obj entry_fulfillment`](#obj-entry_fulfillment) * [`fn new()`](#fn-entry_fulfillmentnew) + * [`obj entry_fulfillment.conditional_cases`](#obj-entry_fulfillmentconditional_cases) + * [`fn new()`](#fn-entry_fulfillmentconditional_casesnew) * [`obj entry_fulfillment.messages`](#obj-entry_fulfillmentmessages) * [`fn new()`](#fn-entry_fulfillmentmessagesnew) + * [`obj entry_fulfillment.messages.conversation_success`](#obj-entry_fulfillmentmessagesconversation_success) + * [`fn new()`](#fn-entry_fulfillmentmessagesconversation_successnew) + * [`obj entry_fulfillment.messages.live_agent_handoff`](#obj-entry_fulfillmentmessageslive_agent_handoff) + * [`fn new()`](#fn-entry_fulfillmentmessageslive_agent_handoffnew) + * [`obj entry_fulfillment.messages.output_audio_text`](#obj-entry_fulfillmentmessagesoutput_audio_text) + * [`fn new()`](#fn-entry_fulfillmentmessagesoutput_audio_textnew) + * [`obj entry_fulfillment.messages.play_audio`](#obj-entry_fulfillmentmessagesplay_audio) + * [`fn new()`](#fn-entry_fulfillmentmessagesplay_audionew) + * [`obj entry_fulfillment.messages.telephony_transfer_call`](#obj-entry_fulfillmentmessagestelephony_transfer_call) + * [`fn new()`](#fn-entry_fulfillmentmessagestelephony_transfer_callnew) * [`obj entry_fulfillment.messages.text`](#obj-entry_fulfillmentmessagestext) * [`fn new()`](#fn-entry_fulfillmentmessagestextnew) + * [`obj entry_fulfillment.set_parameter_actions`](#obj-entry_fulfillmentset_parameter_actions) + * [`fn new()`](#fn-entry_fulfillmentset_parameter_actionsnew) * [`obj event_handlers`](#obj-event_handlers) * [`fn new()`](#fn-event_handlersnew) * [`obj event_handlers.trigger_fulfillment`](#obj-event_handlerstrigger_fulfillment) * [`fn new()`](#fn-event_handlerstrigger_fulfillmentnew) + * [`obj event_handlers.trigger_fulfillment.conditional_cases`](#obj-event_handlerstrigger_fulfillmentconditional_cases) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentconditional_casesnew) * [`obj event_handlers.trigger_fulfillment.messages`](#obj-event_handlerstrigger_fulfillmentmessages) * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagesnew) + * [`obj event_handlers.trigger_fulfillment.messages.conversation_success`](#obj-event_handlerstrigger_fulfillmentmessagesconversation_success) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagesconversation_successnew) + * [`obj event_handlers.trigger_fulfillment.messages.live_agent_handoff`](#obj-event_handlerstrigger_fulfillmentmessageslive_agent_handoff) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessageslive_agent_handoffnew) + * [`obj event_handlers.trigger_fulfillment.messages.output_audio_text`](#obj-event_handlerstrigger_fulfillmentmessagesoutput_audio_text) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagesoutput_audio_textnew) + * [`obj event_handlers.trigger_fulfillment.messages.play_audio`](#obj-event_handlerstrigger_fulfillmentmessagesplay_audio) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagesplay_audionew) + * [`obj event_handlers.trigger_fulfillment.messages.telephony_transfer_call`](#obj-event_handlerstrigger_fulfillmentmessagestelephony_transfer_call) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagestelephony_transfer_callnew) * [`obj event_handlers.trigger_fulfillment.messages.text`](#obj-event_handlerstrigger_fulfillmentmessagestext) * [`fn new()`](#fn-event_handlerstrigger_fulfillmentmessagestextnew) + * [`obj event_handlers.trigger_fulfillment.set_parameter_actions`](#obj-event_handlerstrigger_fulfillmentset_parameter_actions) + * [`fn new()`](#fn-event_handlerstrigger_fulfillmentset_parameter_actionsnew) * [`obj form`](#obj-form) * [`fn new()`](#fn-formnew) * [`obj form.parameters`](#obj-formparameters) @@ -51,20 +79,70 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-formparametersfill_behaviornew) * [`obj form.parameters.fill_behavior.initial_prompt_fulfillment`](#obj-formparametersfill_behaviorinitial_prompt_fulfillment) * [`fn new()`](#fn-formparametersfill_behaviorinitial_prompt_fulfillmentnew) + * [`obj form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases`](#obj-formparametersfill_behaviorinitial_prompt_fulfillmentconditional_cases) + * [`fn new()`](#fn-formparametersfill_behaviorinitial_prompt_fulfillmentconditional_casesnew) * [`obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages`](#obj-formparametersfill_behaviorinitial_prompt_fulfillmentmessages) * [`fn new()`](#fn-formparametersfill_behaviorinitial_prompt_fulfillmentmessagesnew) + * [`obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.conversation_success`](#obj-formparametersfill_behaviorinitial_prompt_fulfillmentmessagesconversation_success) + * [`fn new()`](#fn-formparametersfill_behaviorinitial_prompt_fulfillmentmessagesconversation_successnew) + * [`obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.live_agent_handoff`](#obj-formparametersfill_behaviorinitial_prompt_fulfillmentmessageslive_agent_handoff) + * [`fn new()`](#fn-formparametersfill_behaviorinitial_prompt_fulfillmentmessageslive_agent_handoffnew) + * [`obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.output_audio_text`](#obj-formparametersfill_behaviorinitial_prompt_fulfillmentmessagesoutput_audio_text) + * [`fn new()`](#fn-formparametersfill_behaviorinitial_prompt_fulfillmentmessagesoutput_audio_textnew) + * [`obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.play_audio`](#obj-formparametersfill_behaviorinitial_prompt_fulfillmentmessagesplay_audio) + * [`fn new()`](#fn-formparametersfill_behaviorinitial_prompt_fulfillmentmessagesplay_audionew) + * [`obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.telephony_transfer_call`](#obj-formparametersfill_behaviorinitial_prompt_fulfillmentmessagestelephony_transfer_call) + * [`fn new()`](#fn-formparametersfill_behaviorinitial_prompt_fulfillmentmessagestelephony_transfer_callnew) * [`obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text`](#obj-formparametersfill_behaviorinitial_prompt_fulfillmentmessagestext) * [`fn new()`](#fn-formparametersfill_behaviorinitial_prompt_fulfillmentmessagestextnew) + * [`obj form.parameters.fill_behavior.initial_prompt_fulfillment.set_parameter_actions`](#obj-formparametersfill_behaviorinitial_prompt_fulfillmentset_parameter_actions) + * [`fn new()`](#fn-formparametersfill_behaviorinitial_prompt_fulfillmentset_parameter_actionsnew) + * [`obj form.parameters.fill_behavior.reprompt_event_handlers`](#obj-formparametersfill_behaviorreprompt_event_handlers) + * [`fn new()`](#fn-formparametersfill_behaviorreprompt_event_handlersnew) + * [`obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment`](#obj-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillment) + * [`fn new()`](#fn-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentnew) + * [`obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.conditional_cases`](#obj-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentconditional_cases) + * [`fn new()`](#fn-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentconditional_casesnew) + * [`obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages`](#obj-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessages) + * [`fn new()`](#fn-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessagesnew) + * [`obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.conversation_success`](#obj-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessagesconversation_success) + * [`fn new()`](#fn-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessagesconversation_successnew) + * [`obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.live_agent_handoff`](#obj-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessageslive_agent_handoff) + * [`fn new()`](#fn-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessageslive_agent_handoffnew) + * [`obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.output_audio_text`](#obj-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessagesoutput_audio_text) + * [`fn new()`](#fn-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessagesoutput_audio_textnew) + * [`obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.play_audio`](#obj-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessagesplay_audio) + * [`fn new()`](#fn-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessagesplay_audionew) + * [`obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.telephony_transfer_call`](#obj-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessagestelephony_transfer_call) + * [`fn new()`](#fn-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessagestelephony_transfer_callnew) + * [`obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.text`](#obj-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessagestext) + * [`fn new()`](#fn-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentmessagestextnew) + * [`obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.set_parameter_actions`](#obj-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentset_parameter_actions) + * [`fn new()`](#fn-formparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentset_parameter_actionsnew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) * [`obj transition_routes`](#obj-transition_routes) * [`fn new()`](#fn-transition_routesnew) * [`obj transition_routes.trigger_fulfillment`](#obj-transition_routestrigger_fulfillment) * [`fn new()`](#fn-transition_routestrigger_fulfillmentnew) + * [`obj transition_routes.trigger_fulfillment.conditional_cases`](#obj-transition_routestrigger_fulfillmentconditional_cases) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentconditional_casesnew) * [`obj transition_routes.trigger_fulfillment.messages`](#obj-transition_routestrigger_fulfillmentmessages) * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagesnew) + * [`obj transition_routes.trigger_fulfillment.messages.conversation_success`](#obj-transition_routestrigger_fulfillmentmessagesconversation_success) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagesconversation_successnew) + * [`obj transition_routes.trigger_fulfillment.messages.live_agent_handoff`](#obj-transition_routestrigger_fulfillmentmessageslive_agent_handoff) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessageslive_agent_handoffnew) + * [`obj transition_routes.trigger_fulfillment.messages.output_audio_text`](#obj-transition_routestrigger_fulfillmentmessagesoutput_audio_text) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagesoutput_audio_textnew) + * [`obj transition_routes.trigger_fulfillment.messages.play_audio`](#obj-transition_routestrigger_fulfillmentmessagesplay_audio) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagesplay_audionew) + * [`obj transition_routes.trigger_fulfillment.messages.telephony_transfer_call`](#obj-transition_routestrigger_fulfillmentmessagestelephony_transfer_call) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagestelephony_transfer_callnew) * [`obj transition_routes.trigger_fulfillment.messages.text`](#obj-transition_routestrigger_fulfillmentmessagestext) * [`fn new()`](#fn-transition_routestrigger_fulfillmentmessagestextnew) + * [`obj transition_routes.trigger_fulfillment.set_parameter_actions`](#obj-transition_routestrigger_fulfillmentset_parameter_actions) + * [`fn new()`](#fn-transition_routestrigger_fulfillmentset_parameter_actionsnew) ## Fields @@ -455,47 +533,827 @@ Terraform sub block. - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object. - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object. - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object. + - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.conditional_cases.new](#fn-entry_fulfillmentconditional_casesnew) constructor. - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.new](#fn-entry_fulfillmentmessagesnew) constructor. + - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_page.entry_fulfillment.set_parameter_actions.new](#fn-entry_fulfillmentset_parameter_actionsnew) constructor. **Returns**: - An attribute object that represents the `entry_fulfillment` sub block. +## obj entry_fulfillment.conditional_cases + + + +### fn entry_fulfillment.conditional_cases.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.entry_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases` +Terraform sub block. + + + +**Args**: + - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. +See [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conditional_cases` sub block. + + ## obj entry_fulfillment.messages -### fn entry_fulfillment.messages.new +### fn entry_fulfillment.messages.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.entry_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages` +Terraform sub block. + + + +**Args**: + - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object. + - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object. + - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. +Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded. +* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.conversation_success.new](#fn-entry_fulfillmententry_fulfillmentconversation_successnew) constructor. + - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent. +Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. +* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.live_agent_handoff.new](#fn-entry_fulfillmententry_fulfillmentlive_agent_handoffnew) constructor. + - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.output_audio_text.new](#fn-entry_fulfillmententry_fulfillmentoutput_audio_textnew) constructor. + - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.play_audio.new](#fn-entry_fulfillmententry_fulfillmentplay_audionew) constructor. + - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.telephony_transfer_call.new](#fn-entry_fulfillmententry_fulfillmenttelephony_transfer_callnew) constructor. + - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.text.new](#fn-entry_fulfillmententry_fulfillmenttextnew) constructor. + +**Returns**: + - An attribute object that represents the `messages` sub block. + + +## obj entry_fulfillment.messages.conversation_success + + + +### fn entry_fulfillment.messages.conversation_success.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.entry_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conversation_success` sub block. + + +## obj entry_fulfillment.messages.live_agent_handoff + + + +### fn entry_fulfillment.messages.live_agent_handoff.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.entry_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `live_agent_handoff` sub block. + + +## obj entry_fulfillment.messages.output_audio_text + + + +### fn entry_fulfillment.messages.output_audio_text.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.entry_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text` +Terraform sub block. + + + +**Args**: + - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object. + - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `output_audio_text` sub block. + + +## obj entry_fulfillment.messages.play_audio + + + +### fn entry_fulfillment.messages.play_audio.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.entry_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio` +Terraform sub block. + + + +**Args**: + - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + +**Returns**: + - An attribute object that represents the `play_audio` sub block. + + +## obj entry_fulfillment.messages.telephony_transfer_call + + + +### fn entry_fulfillment.messages.telephony_transfer_call.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.entry_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call` +Terraform sub block. + + + +**Args**: + - `phone_number` (`string`): Transfer the call to a phone number in E.164 format. + +**Returns**: + - An attribute object that represents the `telephony_transfer_call` sub block. + + +## obj entry_fulfillment.messages.text + + + +### fn entry_fulfillment.messages.text.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.entry_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text` +Terraform sub block. + + + +**Args**: + - `text` (`list`): A collection of text responses. When `null`, the `text` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `text` sub block. + + +## obj entry_fulfillment.set_parameter_actions + + + +### fn entry_fulfillment.set_parameter_actions.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.entry_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions` +Terraform sub block. + + + +**Args**: + - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object. + - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `set_parameter_actions` sub block. + + +## obj event_handlers + + + +### fn event_handlers.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.event_handlers.new` constructs a new object with attributes and blocks configured for the `event_handlers` +Terraform sub block. + + + +**Args**: + - `event` (`string`): The name of the event to handle. When `null`, the `event` field will be omitted from the resulting object. + - `target_flow` (`string`): The target flow to transition to. +Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. When `null`, the `target_flow` field will be omitted from the resulting object. + - `target_page` (`string`): The target page to transition to. +Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. When `null`, the `target_page` field will be omitted from the resulting object. + - `trigger_fulfillment` (`list[obj]`): The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. When `null`, the `trigger_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.new](#fn-event_handlerstrigger_fulfillmentnew) constructor. + +**Returns**: + - An attribute object that represents the `event_handlers` sub block. + + +## obj event_handlers.trigger_fulfillment + + + +### fn event_handlers.trigger_fulfillment.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment` +Terraform sub block. + + + +**Args**: + - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object. + - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object. + - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object. + - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.conditional_cases.new](#fn-event_handlersevent_handlersconditional_casesnew) constructor. + - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.new](#fn-event_handlersevent_handlersmessagesnew) constructor. + - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_page.event_handlers.trigger_fulfillment.set_parameter_actions.new](#fn-event_handlersevent_handlersset_parameter_actionsnew) constructor. + +**Returns**: + - An attribute object that represents the `trigger_fulfillment` sub block. + + +## obj event_handlers.trigger_fulfillment.conditional_cases + + + +### fn event_handlers.trigger_fulfillment.conditional_cases.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases` +Terraform sub block. + + + +**Args**: + - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. +See [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conditional_cases` sub block. + + +## obj event_handlers.trigger_fulfillment.messages + + + +### fn event_handlers.trigger_fulfillment.messages.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages` +Terraform sub block. + + + +**Args**: + - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object. + - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object. + - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. +Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded. +* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.conversation_success.new](#fn-event_handlersevent_handlerstrigger_fulfillmentconversation_successnew) constructor. + - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent. +Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. +* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.live_agent_handoff.new](#fn-event_handlersevent_handlerstrigger_fulfillmentlive_agent_handoffnew) constructor. + - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.output_audio_text.new](#fn-event_handlersevent_handlerstrigger_fulfillmentoutput_audio_textnew) constructor. + - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.play_audio.new](#fn-event_handlersevent_handlerstrigger_fulfillmentplay_audionew) constructor. + - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new](#fn-event_handlersevent_handlerstrigger_fulfillmenttelephony_transfer_callnew) constructor. + - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.text.new](#fn-event_handlersevent_handlerstrigger_fulfillmenttextnew) constructor. + +**Returns**: + - An attribute object that represents the `messages` sub block. + + +## obj event_handlers.trigger_fulfillment.messages.conversation_success + + + +### fn event_handlers.trigger_fulfillment.messages.conversation_success.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conversation_success` sub block. + + +## obj event_handlers.trigger_fulfillment.messages.live_agent_handoff + + + +### fn event_handlers.trigger_fulfillment.messages.live_agent_handoff.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `live_agent_handoff` sub block. + + +## obj event_handlers.trigger_fulfillment.messages.output_audio_text + + + +### fn event_handlers.trigger_fulfillment.messages.output_audio_text.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text` +Terraform sub block. + + + +**Args**: + - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object. + - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `output_audio_text` sub block. + + +## obj event_handlers.trigger_fulfillment.messages.play_audio + + + +### fn event_handlers.trigger_fulfillment.messages.play_audio.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio` +Terraform sub block. + + + +**Args**: + - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + +**Returns**: + - An attribute object that represents the `play_audio` sub block. + + +## obj event_handlers.trigger_fulfillment.messages.telephony_transfer_call + + + +### fn event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call` +Terraform sub block. + + + +**Args**: + - `phone_number` (`string`): Transfer the call to a phone number in E.164 format. + +**Returns**: + - An attribute object that represents the `telephony_transfer_call` sub block. + + +## obj event_handlers.trigger_fulfillment.messages.text + + + +### fn event_handlers.trigger_fulfillment.messages.text.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text` +Terraform sub block. + + + +**Args**: + - `text` (`list`): A collection of text responses. When `null`, the `text` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `text` sub block. + + +## obj event_handlers.trigger_fulfillment.set_parameter_actions + + + +### fn event_handlers.trigger_fulfillment.set_parameter_actions.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions` +Terraform sub block. + + + +**Args**: + - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object. + - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `set_parameter_actions` sub block. + + +## obj form + + + +### fn form.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.new` constructs a new object with attributes and blocks configured for the `form` +Terraform sub block. + + + +**Args**: + - `parameters` (`list[obj]`): Parameters to collect from the user. When `null`, the `parameters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.new](#fn-formparametersnew) constructor. + +**Returns**: + - An attribute object that represents the `form` sub block. + + +## obj form.parameters + + + +### fn form.parameters.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.parameters.new` constructs a new object with attributes and blocks configured for the `parameters` +Terraform sub block. + + + +**Args**: + - `default_value` (`string`): The default value of an optional parameter. If the parameter is required, the default value will be ignored. When `null`, the `default_value` field will be omitted from the resulting object. + - `display_name` (`string`): The human-readable name of the parameter, unique within the form. When `null`, the `display_name` field will be omitted from the resulting object. + - `entity_type` (`string`): The entity type of the parameter. +Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types. When `null`, the `entity_type` field will be omitted from the resulting object. + - `is_list` (`bool`): Indicates whether the parameter represents a list of values. When `null`, the `is_list` field will be omitted from the resulting object. + - `redact` (`bool`): Indicates whether the parameter content should be redacted in log. +If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. When `null`, the `redact` field will be omitted from the resulting object. + - `required` (`bool`): Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. +Required parameters must be filled before form filling concludes. When `null`, the `required` field will be omitted from the resulting object. + - `fill_behavior` (`list[obj]`): Defines fill behavior for the parameter. When `null`, the `fill_behavior` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.new](#fn-formformfill_behaviornew) constructor. + +**Returns**: + - An attribute object that represents the `parameters` sub block. + + +## obj form.parameters.fill_behavior + + + +### fn form.parameters.fill_behavior.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.parameters.fill_behavior.new` constructs a new object with attributes and blocks configured for the `fill_behavior` +Terraform sub block. + + + +**Args**: + - `initial_prompt_fulfillment` (`list[obj]`): The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. When `null`, the `initial_prompt_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.new](#fn-formformparametersinitial_prompt_fulfillmentnew) constructor. + - `reprompt_event_handlers` (`list[obj]`): The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: +* sys.no-match-<N>, where N can be from 1 to 6 +* sys.no-match-default +* sys.no-input-<N>, where N can be from 1 to 6 +* sys.no-input-default +* sys.invalid-parameter +[initialPromptFulfillment][initialPromptFulfillment] provides the first prompt for the parameter. +If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. +A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. +A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. +If the event handler for the corresponding event can't be found on the parameter, initialPromptFulfillment will be re-prompted. When `null`, the `reprompt_event_handlers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.new](#fn-formformparametersreprompt_event_handlersnew) constructor. + +**Returns**: + - An attribute object that represents the `fill_behavior` sub block. + + +## obj form.parameters.fill_behavior.initial_prompt_fulfillment + + + +### fn form.parameters.fill_behavior.initial_prompt_fulfillment.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.new` constructs a new object with attributes and blocks configured for the `initial_prompt_fulfillment` +Terraform sub block. + + + +**Args**: + - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object. + - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object. + - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object. + - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases.new](#fn-formformparametersfill_behaviorconditional_casesnew) constructor. + - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.new](#fn-formformparametersfill_behaviormessagesnew) constructor. + - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.set_parameter_actions.new](#fn-formformparametersfill_behaviorset_parameter_actionsnew) constructor. + +**Returns**: + - An attribute object that represents the `initial_prompt_fulfillment` sub block. + + +## obj form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases + + + +### fn form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases` +Terraform sub block. + + + +**Args**: + - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. +See [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conditional_cases` sub block. + + +## obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages + + + +### fn form.parameters.fill_behavior.initial_prompt_fulfillment.messages.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages` +Terraform sub block. + + + +**Args**: + - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object. + - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object. + - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. +Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded. +* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.conversation_success.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmentconversation_successnew) constructor. + - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent. +Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. +* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.live_agent_handoff.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmentlive_agent_handoffnew) constructor. + - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.output_audio_text.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmentoutput_audio_textnew) constructor. + - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.play_audio.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmentplay_audionew) constructor. + - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.telephony_transfer_call.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmenttelephony_transfer_callnew) constructor. + - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmenttextnew) constructor. + +**Returns**: + - An attribute object that represents the `messages` sub block. + + +## obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.conversation_success + + + +### fn form.parameters.fill_behavior.initial_prompt_fulfillment.messages.conversation_success.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conversation_success` sub block. + + +## obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.live_agent_handoff + + + +### fn form.parameters.fill_behavior.initial_prompt_fulfillment.messages.live_agent_handoff.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `live_agent_handoff` sub block. + + +## obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.output_audio_text + + + +### fn form.parameters.fill_behavior.initial_prompt_fulfillment.messages.output_audio_text.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text` +Terraform sub block. + + + +**Args**: + - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object. + - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `output_audio_text` sub block. + + +## obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.play_audio + + + +### fn form.parameters.fill_behavior.initial_prompt_fulfillment.messages.play_audio.new ```ts new() ``` -`google.dialogflow_cx_page.entry_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages` +`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio` Terraform sub block. **Args**: - - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.entry_fulfillment.messages.text.new](#fn-entry_fulfillmententry_fulfillmenttextnew) constructor. + - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. **Returns**: - - An attribute object that represents the `messages` sub block. + - An attribute object that represents the `play_audio` sub block. -## obj entry_fulfillment.messages.text +## obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.telephony_transfer_call -### fn entry_fulfillment.messages.text.new +### fn form.parameters.fill_behavior.initial_prompt_fulfillment.messages.telephony_transfer_call.new ```ts new() ``` -`google.dialogflow_cx_page.entry_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text` +`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call` +Terraform sub block. + + + +**Args**: + - `phone_number` (`string`): Transfer the call to a phone number in E.164 format. + +**Returns**: + - An attribute object that represents the `telephony_transfer_call` sub block. + + +## obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text + + + +### fn form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text` Terraform sub block. @@ -507,18 +1365,42 @@ Terraform sub block. - An attribute object that represents the `text` sub block. -## obj event_handlers +## obj form.parameters.fill_behavior.initial_prompt_fulfillment.set_parameter_actions -### fn event_handlers.new +### fn form.parameters.fill_behavior.initial_prompt_fulfillment.set_parameter_actions.new ```ts new() ``` -`google.dialogflow_cx_page.event_handlers.new` constructs a new object with attributes and blocks configured for the `event_handlers` +`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions` +Terraform sub block. + + + +**Args**: + - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object. + - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `set_parameter_actions` sub block. + + +## obj form.parameters.fill_behavior.reprompt_event_handlers + + + +### fn form.parameters.fill_behavior.reprompt_event_handlers.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.new` constructs a new object with attributes and blocks configured for the `reprompt_event_handlers` Terraform sub block. @@ -529,24 +1411,24 @@ Terraform sub block. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. When `null`, the `target_flow` field will be omitted from the resulting object. - `target_page` (`string`): The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. When `null`, the `target_page` field will be omitted from the resulting object. - - `trigger_fulfillment` (`list[obj]`): The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. When `null`, the `trigger_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.new](#fn-event_handlerstrigger_fulfillmentnew) constructor. + - `trigger_fulfillment` (`list[obj]`): The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. When `null`, the `trigger_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.new](#fn-formformparametersfill_behaviortrigger_fulfillmentnew) constructor. **Returns**: - - An attribute object that represents the `event_handlers` sub block. + - An attribute object that represents the `reprompt_event_handlers` sub block. -## obj event_handlers.trigger_fulfillment +## obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment -### fn event_handlers.trigger_fulfillment.new +### fn form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.new ```ts new() ``` -`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment` +`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.new` constructs a new object with attributes and blocks configured for the `trigger_fulfillment` Terraform sub block. @@ -555,196 +1437,204 @@ Terraform sub block. - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object. - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object. - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object. - - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.new](#fn-event_handlersevent_handlersmessagesnew) constructor. + - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.conditional_cases.new](#fn-formformparametersfill_behaviorreprompt_event_handlersconditional_casesnew) constructor. + - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.new](#fn-formformparametersfill_behaviorreprompt_event_handlersmessagesnew) constructor. + - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.set_parameter_actions.new](#fn-formformparametersfill_behaviorreprompt_event_handlersset_parameter_actionsnew) constructor. **Returns**: - An attribute object that represents the `trigger_fulfillment` sub block. -## obj event_handlers.trigger_fulfillment.messages +## obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.conditional_cases -### fn event_handlers.trigger_fulfillment.messages.new +### fn form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.conditional_cases.new ```ts new() ``` -`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages` +`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases` Terraform sub block. **Args**: - - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.text.new](#fn-event_handlersevent_handlerstrigger_fulfillmenttextnew) constructor. + - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. +See [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object. **Returns**: - - An attribute object that represents the `messages` sub block. + - An attribute object that represents the `conditional_cases` sub block. -## obj event_handlers.trigger_fulfillment.messages.text +## obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages -### fn event_handlers.trigger_fulfillment.messages.text.new +### fn form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.new ```ts new() ``` -`google.dialogflow_cx_page.event_handlers.trigger_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text` +`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages` Terraform sub block. **Args**: - - `text` (`list`): A collection of text responses. When `null`, the `text` field will be omitted from the resulting object. + - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object. + - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object. + - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. +Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded. +* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.conversation_success.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentconversation_successnew) constructor. + - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent. +Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. +* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.live_agent_handoff.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentlive_agent_handoffnew) constructor. + - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.output_audio_text.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentoutput_audio_textnew) constructor. + - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.play_audio.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmentplay_audionew) constructor. + - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmenttelephony_transfer_callnew) constructor. + - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.text.new](#fn-formformparametersfill_behaviorreprompt_event_handlerstrigger_fulfillmenttextnew) constructor. **Returns**: - - An attribute object that represents the `text` sub block. + - An attribute object that represents the `messages` sub block. -## obj form +## obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.conversation_success -### fn form.new +### fn form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.conversation_success.new ```ts new() ``` -`google.dialogflow_cx_page.form.new` constructs a new object with attributes and blocks configured for the `form` +`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success` Terraform sub block. **Args**: - - `parameters` (`list[obj]`): Parameters to collect from the user. When `null`, the `parameters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.new](#fn-formparametersnew) constructor. + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. **Returns**: - - An attribute object that represents the `form` sub block. + - An attribute object that represents the `conversation_success` sub block. -## obj form.parameters +## obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.live_agent_handoff -### fn form.parameters.new +### fn form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.live_agent_handoff.new ```ts new() ``` -`google.dialogflow_cx_page.form.parameters.new` constructs a new object with attributes and blocks configured for the `parameters` +`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff` Terraform sub block. **Args**: - - `display_name` (`string`): The human-readable name of the parameter, unique within the form. When `null`, the `display_name` field will be omitted from the resulting object. - - `entity_type` (`string`): The entity type of the parameter. -Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types. When `null`, the `entity_type` field will be omitted from the resulting object. - - `is_list` (`bool`): Indicates whether the parameter represents a list of values. When `null`, the `is_list` field will be omitted from the resulting object. - - `redact` (`bool`): Indicates whether the parameter content should be redacted in log. -If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. When `null`, the `redact` field will be omitted from the resulting object. - - `required` (`bool`): Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. -Required parameters must be filled before form filling concludes. When `null`, the `required` field will be omitted from the resulting object. - - `fill_behavior` (`list[obj]`): Defines fill behavior for the parameter. When `null`, the `fill_behavior` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.new](#fn-formformfill_behaviornew) constructor. + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. **Returns**: - - An attribute object that represents the `parameters` sub block. + - An attribute object that represents the `live_agent_handoff` sub block. -## obj form.parameters.fill_behavior +## obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.output_audio_text -### fn form.parameters.fill_behavior.new +### fn form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.output_audio_text.new ```ts new() ``` -`google.dialogflow_cx_page.form.parameters.fill_behavior.new` constructs a new object with attributes and blocks configured for the `fill_behavior` +`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text` Terraform sub block. **Args**: - - `initial_prompt_fulfillment` (`list[obj]`): The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. When `null`, the `initial_prompt_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.new](#fn-formformparametersinitial_prompt_fulfillmentnew) constructor. + - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object. + - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object. **Returns**: - - An attribute object that represents the `fill_behavior` sub block. + - An attribute object that represents the `output_audio_text` sub block. -## obj form.parameters.fill_behavior.initial_prompt_fulfillment +## obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.play_audio -### fn form.parameters.fill_behavior.initial_prompt_fulfillment.new +### fn form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.play_audio.new ```ts new() ``` -`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.new` constructs a new object with attributes and blocks configured for the `initial_prompt_fulfillment` +`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio` Terraform sub block. **Args**: - - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object. - - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object. - - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object. - - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.new](#fn-formformparametersfill_behaviormessagesnew) constructor. + - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. **Returns**: - - An attribute object that represents the `initial_prompt_fulfillment` sub block. + - An attribute object that represents the `play_audio` sub block. -## obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages +## obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.telephony_transfer_call -### fn form.parameters.fill_behavior.initial_prompt_fulfillment.messages.new +### fn form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new ```ts new() ``` -`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.new` constructs a new object with attributes and blocks configured for the `messages` +`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call` Terraform sub block. **Args**: - - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text.new](#fn-formformparametersfill_behaviorinitial_prompt_fulfillmenttextnew) constructor. + - `phone_number` (`string`): Transfer the call to a phone number in E.164 format. **Returns**: - - An attribute object that represents the `messages` sub block. + - An attribute object that represents the `telephony_transfer_call` sub block. -## obj form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text +## obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.text -### fn form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text.new +### fn form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.text.new ```ts new() ``` -`google.dialogflow_cx_page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text` +`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.messages.text.new` constructs a new object with attributes and blocks configured for the `text` Terraform sub block. @@ -756,6 +1646,30 @@ Terraform sub block. - An attribute object that represents the `text` sub block. +## obj form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.set_parameter_actions + + + +### fn form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.set_parameter_actions.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.form.parameters.fill_behavior.reprompt_event_handlers.trigger_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions` +Terraform sub block. + + + +**Args**: + - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object. + - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `set_parameter_actions` sub block. + + ## obj timeouts @@ -806,7 +1720,7 @@ Format: projects/<Project ID>/locations/<Location ID>/agents/<Age Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. When `null`, the `target_flow` field will be omitted from the resulting object. - `target_page` (`string`): The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. When `null`, the `target_page` field will be omitted from the resulting object. - - `trigger_fulfillment` (`list[obj]`): The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. When `null`, the `trigger_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.new](#fn-transition_routestrigger_fulfillmentnew) constructor. + - `trigger_fulfillment` (`list[obj]`): The fulfillment to call when the condition is satisfied. At least one of triggerFulfillment and target must be specified. When both are defined, triggerFulfillment is executed first. When `null`, the `trigger_fulfillment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.new](#fn-transition_routestrigger_fulfillmentnew) constructor. **Returns**: - An attribute object that represents the `transition_routes` sub block. @@ -832,12 +1746,38 @@ Terraform sub block. - `return_partial_responses` (`bool`): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. When `null`, the `return_partial_responses` field will be omitted from the resulting object. - `tag` (`string`): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. When `null`, the `tag` field will be omitted from the resulting object. - `webhook` (`string`): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. When `null`, the `webhook` field will be omitted from the resulting object. + - `conditional_cases` (`list[obj]`): Conditional cases for this fulfillment. When `null`, the `conditional_cases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.conditional_cases.new](#fn-transition_routestransition_routesconditional_casesnew) constructor. - `messages` (`list[obj]`): The list of rich message responses to present to the user. When `null`, the `messages` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.new](#fn-transition_routestransition_routesmessagesnew) constructor. + - `set_parameter_actions` (`list[obj]`): Set parameter values before executing the webhook. When `null`, the `set_parameter_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.dialogflow_cx_page.transition_routes.trigger_fulfillment.set_parameter_actions.new](#fn-transition_routestransition_routesset_parameter_actionsnew) constructor. **Returns**: - An attribute object that represents the `trigger_fulfillment` sub block. +## obj transition_routes.trigger_fulfillment.conditional_cases + + + +### fn transition_routes.trigger_fulfillment.conditional_cases.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.conditional_cases.new` constructs a new object with attributes and blocks configured for the `conditional_cases` +Terraform sub block. + + + +**Args**: + - `cases` (`string`): A JSON encoded list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. +See [Case](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#case) for the schema. When `null`, the `cases` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conditional_cases` sub block. + + ## obj transition_routes.trigger_fulfillment.messages @@ -855,12 +1795,143 @@ Terraform sub block. **Args**: + - `channel` (`string`): The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. When `null`, the `channel` field will be omitted from the resulting object. + - `payload` (`string`): A custom, platform-specific payload. When `null`, the `payload` field will be omitted from the resulting object. + - `conversation_success` (`list[obj]`): Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. +Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded. +* In a webhook response when you determine that you handled the customer issue. When `null`, the `conversation_success` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.conversation_success.new](#fn-transition_routestransition_routestrigger_fulfillmentconversation_successnew) constructor. + - `live_agent_handoff` (`list[obj]`): Indicates that the conversation should be handed off to a live agent. +Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. +You may set this, for example: +* In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. +* In a webhook response when you determine that the customer issue can only be handled by a human. When `null`, the `live_agent_handoff` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.live_agent_handoff.new](#fn-transition_routestransition_routestrigger_fulfillmentlive_agent_handoffnew) constructor. + - `output_audio_text` (`list[obj]`): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. When `null`, the `output_audio_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.output_audio_text.new](#fn-transition_routestransition_routestrigger_fulfillmentoutput_audio_textnew) constructor. + - `play_audio` (`list[obj]`): Specifies an audio clip to be played by the client as part of the response. When `null`, the `play_audio` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.play_audio.new](#fn-transition_routestransition_routestrigger_fulfillmentplay_audionew) constructor. + - `telephony_transfer_call` (`list[obj]`): Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. When `null`, the `telephony_transfer_call` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new](#fn-transition_routestransition_routestrigger_fulfillmenttelephony_transfer_callnew) constructor. - `text` (`list[obj]`): The text response message. When `null`, the `text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.text.new](#fn-transition_routestransition_routestrigger_fulfillmenttextnew) constructor. **Returns**: - An attribute object that represents the `messages` sub block. +## obj transition_routes.trigger_fulfillment.messages.conversation_success + + + +### fn transition_routes.trigger_fulfillment.messages.conversation_success.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.conversation_success.new` constructs a new object with attributes and blocks configured for the `conversation_success` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conversation_success` sub block. + + +## obj transition_routes.trigger_fulfillment.messages.live_agent_handoff + + + +### fn transition_routes.trigger_fulfillment.messages.live_agent_handoff.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.live_agent_handoff.new` constructs a new object with attributes and blocks configured for the `live_agent_handoff` +Terraform sub block. + + + +**Args**: + - `metadata` (`string`): Custom metadata. Dialogflow doesn't impose any structure on this. When `null`, the `metadata` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `live_agent_handoff` sub block. + + +## obj transition_routes.trigger_fulfillment.messages.output_audio_text + + + +### fn transition_routes.trigger_fulfillment.messages.output_audio_text.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.output_audio_text.new` constructs a new object with attributes and blocks configured for the `output_audio_text` +Terraform sub block. + + + +**Args**: + - `ssml` (`string`): The SSML text to be synthesized. For more information, see SSML. When `null`, the `ssml` field will be omitted from the resulting object. + - `text` (`string`): The raw text to be synthesized. When `null`, the `text` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `output_audio_text` sub block. + + +## obj transition_routes.trigger_fulfillment.messages.play_audio + + + +### fn transition_routes.trigger_fulfillment.messages.play_audio.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.play_audio.new` constructs a new object with attributes and blocks configured for the `play_audio` +Terraform sub block. + + + +**Args**: + - `audio_uri` (`string`): URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + +**Returns**: + - An attribute object that represents the `play_audio` sub block. + + +## obj transition_routes.trigger_fulfillment.messages.telephony_transfer_call + + + +### fn transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.messages.telephony_transfer_call.new` constructs a new object with attributes and blocks configured for the `telephony_transfer_call` +Terraform sub block. + + + +**Args**: + - `phone_number` (`string`): Transfer the call to a phone number in E.164 format. + +**Returns**: + - An attribute object that represents the `telephony_transfer_call` sub block. + + ## obj transition_routes.trigger_fulfillment.messages.text @@ -882,3 +1953,27 @@ Terraform sub block. **Returns**: - An attribute object that represents the `text` sub block. + + +## obj transition_routes.trigger_fulfillment.set_parameter_actions + + + +### fn transition_routes.trigger_fulfillment.set_parameter_actions.new + +```ts +new() +``` + + +`google.dialogflow_cx_page.transition_routes.trigger_fulfillment.set_parameter_actions.new` constructs a new object with attributes and blocks configured for the `set_parameter_actions` +Terraform sub block. + + + +**Args**: + - `parameter` (`string`): Display name of the parameter. When `null`, the `parameter` field will be omitted from the resulting object. + - `value` (`string`): The new JSON-encoded value of the parameter. A null value clears the parameter. When `null`, the `value` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `set_parameter_actions` sub block. diff --git a/docs/4.x/gke_hub_membership_binding.md b/docs/4.x/gke_hub_membership_binding.md new file mode 100644 index 0000000..49d2ebe --- /dev/null +++ b/docs/4.x/gke_hub_membership_binding.md @@ -0,0 +1,237 @@ +--- +permalink: /gke_hub_membership_binding/ +--- + +# gke_hub_membership_binding + +`gke_hub_membership_binding` represents the `google_gke_hub_membership_binding` 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 withLocation()`](#fn-withlocation) +* [`fn withMembershipBindingId()`](#fn-withmembershipbindingid) +* [`fn withMembershipId()`](#fn-withmembershipid) +* [`fn withProject()`](#fn-withproject) +* [`fn withScope()`](#fn-withscope) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.gke_hub_membership_binding.new` injects a new `google_gke_hub_membership_binding` 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.gke_hub_membership_binding.new('some_id') + +You can get the reference to the `id` field of the created `google.gke_hub_membership_binding` using the reference: + + $._ref.google_gke_hub_membership_binding.some_id.get('id') + +This is the same as directly entering `"${ google_gke_hub_membership_binding.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. + - `location` (`string`): Location of the membership + - `membership_binding_id` (`string`): The client-provided identifier of the membership binding. + - `membership_id` (`string`): Id of the membership + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `scope` (`string`): A Workspace resource name in the format +'projects/*/locations/*/scopes/*'. + - `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.gke_hub_membership_binding.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.gke_hub_membership_binding.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_membership_binding` +Terraform resource. + +Unlike [google.gke_hub_membership_binding.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**: + - `location` (`string`): Location of the membership + - `membership_binding_id` (`string`): The client-provided identifier of the membership binding. + - `membership_id` (`string`): Id of the membership + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `scope` (`string`): A Workspace resource name in the format +'projects/*/locations/*/scopes/*'. + - `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.gke_hub_membership_binding.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 `gke_hub_membership_binding` resource into the root Terraform configuration. + + +### fn withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withMembershipBindingId + +```ts +withMembershipBindingId() +``` + +`google.string.withMembershipBindingId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the membership_binding_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `membership_binding_id` field. + + +### fn withMembershipId + +```ts +withMembershipId() +``` + +`google.string.withMembershipId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the membership_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `membership_id` 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 withScope + +```ts +withScope() +``` + +`google.string.withScope` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the scope field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope` 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.gke_hub_membership_binding.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/gke_hub_namespace.md b/docs/4.x/gke_hub_namespace.md new file mode 100644 index 0000000..cf7354e --- /dev/null +++ b/docs/4.x/gke_hub_namespace.md @@ -0,0 +1,215 @@ +--- +permalink: /gke_hub_namespace/ +--- + +# gke_hub_namespace + +`gke_hub_namespace` represents the `google_gke_hub_namespace` 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 withProject()`](#fn-withproject) +* [`fn withScope()`](#fn-withscope) +* [`fn withScopeId()`](#fn-withscopeid) +* [`fn withScopeNamespaceId()`](#fn-withscopenamespaceid) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.gke_hub_namespace.new` injects a new `google_gke_hub_namespace` 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.gke_hub_namespace.new('some_id') + +You can get the reference to the `id` field of the created `google.gke_hub_namespace` using the reference: + + $._ref.google_gke_hub_namespace.some_id.get('id') + +This is the same as directly entering `"${ google_gke_hub_namespace.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. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `scope` (`string`): The name of the Scope instance. + - `scope_id` (`string`): Id of the scope + - `scope_namespace_id` (`string`): The client-provided identifier of the namespace. + - `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.gke_hub_namespace.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.gke_hub_namespace.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_namespace` +Terraform resource. + +Unlike [google.gke_hub_namespace.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**: + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `scope` (`string`): The name of the Scope instance. + - `scope_id` (`string`): Id of the scope + - `scope_namespace_id` (`string`): The client-provided identifier of the namespace. + - `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.gke_hub_namespace.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 `gke_hub_namespace` resource into the root Terraform configuration. + + +### 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 withScope + +```ts +withScope() +``` + +`google.string.withScope` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the scope field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope` field. + + +### fn withScopeId + +```ts +withScopeId() +``` + +`google.string.withScopeId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the scope_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope_id` field. + + +### fn withScopeNamespaceId + +```ts +withScopeNamespaceId() +``` + +`google.string.withScopeNamespaceId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the scope_namespace_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope_namespace_id` 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.gke_hub_namespace.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/gke_hub_scope.md b/docs/4.x/gke_hub_scope.md new file mode 100644 index 0000000..c9ebc33 --- /dev/null +++ b/docs/4.x/gke_hub_scope.md @@ -0,0 +1,177 @@ +--- +permalink: /gke_hub_scope/ +--- + +# gke_hub_scope + +`gke_hub_scope` represents the `google_gke_hub_scope` 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 withProject()`](#fn-withproject) +* [`fn withScopeId()`](#fn-withscopeid) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.gke_hub_scope.new` injects a new `google_gke_hub_scope` 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.gke_hub_scope.new('some_id') + +You can get the reference to the `id` field of the created `google.gke_hub_scope` using the reference: + + $._ref.google_gke_hub_scope.some_id.get('id') + +This is the same as directly entering `"${ google_gke_hub_scope.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. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `scope_id` (`string`): The client-provided identifier of the scope. + - `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.gke_hub_scope.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.gke_hub_scope.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope` +Terraform resource. + +Unlike [google.gke_hub_scope.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**: + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `scope_id` (`string`): The client-provided identifier of the scope. + - `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.gke_hub_scope.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 `gke_hub_scope` resource into the root Terraform configuration. + + +### 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 withScopeId + +```ts +withScopeId() +``` + +`google.string.withScopeId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the scope_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope_id` 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.gke_hub_scope.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/gke_hub_scope_iam_binding.md b/docs/4.x/gke_hub_scope_iam_binding.md new file mode 100644 index 0000000..de0dbb5 --- /dev/null +++ b/docs/4.x/gke_hub_scope_iam_binding.md @@ -0,0 +1,217 @@ +--- +permalink: /gke_hub_scope_iam_binding/ +--- + +# gke_hub_scope_iam_binding + +`gke_hub_scope_iam_binding` represents the `google_gke_hub_scope_iam_binding` 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 withCondition()`](#fn-withcondition) +* [`fn withConditionMixin()`](#fn-withconditionmixin) +* [`fn withMembers()`](#fn-withmembers) +* [`fn withProject()`](#fn-withproject) +* [`fn withRole()`](#fn-withrole) +* [`fn withScopeId()`](#fn-withscopeid) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.gke_hub_scope_iam_binding.new` injects a new `google_gke_hub_scope_iam_binding` 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.gke_hub_scope_iam_binding.new('some_id') + +You can get the reference to the `id` field of the created `google.gke_hub_scope_iam_binding` using the reference: + + $._ref.google_gke_hub_scope_iam_binding.some_id.get('id') + +This is the same as directly entering `"${ google_gke_hub_scope_iam_binding.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. + - `members` (`list`): Set the `members` field on the resulting resource block. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `role` (`string`): Set the `role` field on the resulting resource block. + - `scope_id` (`string`): Set the `scope_id` field on the resulting resource block. + - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_iam_binding.condition.new](#fn-conditionnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.gke_hub_scope_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope_iam_binding` +Terraform resource. + +Unlike [google.gke_hub_scope_iam_binding.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**: + - `members` (`list`): Set the `members` field on 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. + - `role` (`string`): Set the `role` field on the resulting object. + - `scope_id` (`string`): Set the `scope_id` field on the resulting object. + - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_iam_binding.condition.new](#fn-conditionnew) 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 `gke_hub_scope_iam_binding` resource into the root Terraform configuration. + + +### fn withCondition + +```ts +withCondition() +``` + +`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withConditionMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withConditionMixin + +```ts +withConditionMixin() +``` + +`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withCondition](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withMembers + +```ts +withMembers() +``` + +`google.list.withMembers` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the members field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `members` 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 withRole + +```ts +withRole() +``` + +`google.string.withRole` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role` field. + + +### fn withScopeId + +```ts +withScopeId() +``` + +`google.string.withScopeId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the scope_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope_id` field. + + +## obj condition + + + +### fn condition.new + +```ts +new() +``` + + +`google.gke_hub_scope_iam_binding.condition.new` constructs a new object with attributes and blocks configured for the `condition` +Terraform sub block. + + + +**Args**: + - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. + - `expression` (`string`): Set the `expression` field on the resulting object. + - `title` (`string`): Set the `title` field on the resulting object. + +**Returns**: + - An attribute object that represents the `condition` sub block. diff --git a/docs/4.x/gke_hub_scope_iam_member.md b/docs/4.x/gke_hub_scope_iam_member.md new file mode 100644 index 0000000..41a5f92 --- /dev/null +++ b/docs/4.x/gke_hub_scope_iam_member.md @@ -0,0 +1,217 @@ +--- +permalink: /gke_hub_scope_iam_member/ +--- + +# gke_hub_scope_iam_member + +`gke_hub_scope_iam_member` represents the `google_gke_hub_scope_iam_member` 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 withCondition()`](#fn-withcondition) +* [`fn withConditionMixin()`](#fn-withconditionmixin) +* [`fn withMember()`](#fn-withmember) +* [`fn withProject()`](#fn-withproject) +* [`fn withRole()`](#fn-withrole) +* [`fn withScopeId()`](#fn-withscopeid) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.gke_hub_scope_iam_member.new` injects a new `google_gke_hub_scope_iam_member` 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.gke_hub_scope_iam_member.new('some_id') + +You can get the reference to the `id` field of the created `google.gke_hub_scope_iam_member` using the reference: + + $._ref.google_gke_hub_scope_iam_member.some_id.get('id') + +This is the same as directly entering `"${ google_gke_hub_scope_iam_member.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. + - `member` (`string`): Set the `member` field on the resulting resource block. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `role` (`string`): Set the `role` field on the resulting resource block. + - `scope_id` (`string`): Set the `scope_id` field on the resulting resource block. + - `condition` (`list[obj]`): Set the `condition` field on the resulting resource block. When `null`, the `condition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_iam_member.condition.new](#fn-conditionnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.gke_hub_scope_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope_iam_member` +Terraform resource. + +Unlike [google.gke_hub_scope_iam_member.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**: + - `member` (`string`): Set the `member` field on 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. + - `role` (`string`): Set the `role` field on the resulting object. + - `scope_id` (`string`): Set the `scope_id` field on the resulting object. + - `condition` (`list[obj]`): Set the `condition` field on the resulting object. When `null`, the `condition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_iam_member.condition.new](#fn-conditionnew) 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 `gke_hub_scope_iam_member` resource into the root Terraform configuration. + + +### fn withCondition + +```ts +withCondition() +``` + +`google.list[obj].withCondition` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withConditionMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withConditionMixin + +```ts +withConditionMixin() +``` + +`google.list[obj].withConditionMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the condition 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].withCondition](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `condition` field. + + +### fn withMember + +```ts +withMember() +``` + +`google.string.withMember` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the member field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `member` 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 withRole + +```ts +withRole() +``` + +`google.string.withRole` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role` field. + + +### fn withScopeId + +```ts +withScopeId() +``` + +`google.string.withScopeId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the scope_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope_id` field. + + +## obj condition + + + +### fn condition.new + +```ts +new() +``` + + +`google.gke_hub_scope_iam_member.condition.new` constructs a new object with attributes and blocks configured for the `condition` +Terraform sub block. + + + +**Args**: + - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. + - `expression` (`string`): Set the `expression` field on the resulting object. + - `title` (`string`): Set the `title` field on the resulting object. + +**Returns**: + - An attribute object that represents the `condition` sub block. diff --git a/docs/4.x/gke_hub_scope_iam_policy.md b/docs/4.x/gke_hub_scope_iam_policy.md new file mode 100644 index 0000000..6b7cfae --- /dev/null +++ b/docs/4.x/gke_hub_scope_iam_policy.md @@ -0,0 +1,130 @@ +--- +permalink: /gke_hub_scope_iam_policy/ +--- + +# gke_hub_scope_iam_policy + +`gke_hub_scope_iam_policy` represents the `google_gke_hub_scope_iam_policy` 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 withPolicyData()`](#fn-withpolicydata) +* [`fn withProject()`](#fn-withproject) +* [`fn withScopeId()`](#fn-withscopeid) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.gke_hub_scope_iam_policy.new` injects a new `google_gke_hub_scope_iam_policy` 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.gke_hub_scope_iam_policy.new('some_id') + +You can get the reference to the `id` field of the created `google.gke_hub_scope_iam_policy` using the reference: + + $._ref.google_gke_hub_scope_iam_policy.some_id.get('id') + +This is the same as directly entering `"${ google_gke_hub_scope_iam_policy.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. + - `policy_data` (`string`): Set the `policy_data` field on the resulting resource block. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `scope_id` (`string`): Set the `scope_id` field on the resulting resource block. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.gke_hub_scope_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope_iam_policy` +Terraform resource. + +Unlike [google.gke_hub_scope_iam_policy.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**: + - `policy_data` (`string`): Set the `policy_data` field on 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. + - `scope_id` (`string`): Set the `scope_id` field on the resulting object. + +**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 `gke_hub_scope_iam_policy` resource into the root Terraform configuration. + + +### fn withPolicyData + +```ts +withPolicyData() +``` + +`google.string.withPolicyData` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the policy_data field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `policy_data` 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 withScopeId + +```ts +withScopeId() +``` + +`google.string.withScopeId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the scope_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope_id` field. diff --git a/docs/4.x/gke_hub_scope_rbac_role_binding.md b/docs/4.x/gke_hub_scope_rbac_role_binding.md new file mode 100644 index 0000000..c5df7ce --- /dev/null +++ b/docs/4.x/gke_hub_scope_rbac_role_binding.md @@ -0,0 +1,311 @@ +--- +permalink: /gke_hub_scope_rbac_role_binding/ +--- + +# gke_hub_scope_rbac_role_binding + +`gke_hub_scope_rbac_role_binding` represents the `google_gke_hub_scope_rbac_role_binding` 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 withGroup()`](#fn-withgroup) +* [`fn withProject()`](#fn-withproject) +* [`fn withRole()`](#fn-withrole) +* [`fn withRoleMixin()`](#fn-withrolemixin) +* [`fn withScopeId()`](#fn-withscopeid) +* [`fn withScopeRbacRoleBindingId()`](#fn-withscoperbacrolebindingid) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withUser()`](#fn-withuser) +* [`obj role`](#obj-role) + * [`fn new()`](#fn-rolenew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.gke_hub_scope_rbac_role_binding.new` injects a new `google_gke_hub_scope_rbac_role_binding` 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.gke_hub_scope_rbac_role_binding.new('some_id') + +You can get the reference to the `id` field of the created `google.gke_hub_scope_rbac_role_binding` using the reference: + + $._ref.google_gke_hub_scope_rbac_role_binding.some_id.get('id') + +This is the same as directly entering `"${ google_gke_hub_scope_rbac_role_binding.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. + - `group` (`string`): Principal that is be authorized in the cluster (at least of one the oneof +is required). Updating one will unset the other automatically. +group is the group, as seen by the kubernetes cluster. When `null`, the `group` 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. + - `scope_id` (`string`): Id of the scope + - `scope_rbac_role_binding_id` (`string`): The client-provided identifier of the RBAC Role Binding. + - `user` (`string`): Principal that is be authorized in the cluster (at least of one the oneof +is required). Updating one will unset the other automatically. +user is the name of the user as seen by the kubernetes cluster, example +"alice" or "alice@domain.tld" When `null`, the `user` field will be omitted from the resulting object. + - `role` (`list[obj]`): Role to bind to the principal. When `null`, the `role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_rbac_role_binding.role.new](#fn-rolenew) 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.gke_hub_scope_rbac_role_binding.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.gke_hub_scope_rbac_role_binding.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_scope_rbac_role_binding` +Terraform resource. + +Unlike [google.gke_hub_scope_rbac_role_binding.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**: + - `group` (`string`): Principal that is be authorized in the cluster (at least of one the oneof +is required). Updating one will unset the other automatically. +group is the group, as seen by the kubernetes cluster. When `null`, the `group` 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. + - `scope_id` (`string`): Id of the scope + - `scope_rbac_role_binding_id` (`string`): The client-provided identifier of the RBAC Role Binding. + - `user` (`string`): Principal that is be authorized in the cluster (at least of one the oneof +is required). Updating one will unset the other automatically. +user is the name of the user as seen by the kubernetes cluster, example +"alice" or "alice@domain.tld" When `null`, the `user` field will be omitted from the resulting object. + - `role` (`list[obj]`): Role to bind to the principal. When `null`, the `role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_scope_rbac_role_binding.role.new](#fn-rolenew) 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.gke_hub_scope_rbac_role_binding.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 `gke_hub_scope_rbac_role_binding` resource into the root Terraform configuration. + + +### fn withGroup + +```ts +withGroup() +``` + +`google.string.withGroup` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the group field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `group` 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 withRole + +```ts +withRole() +``` + +`google.list[obj].withRole` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the role 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].withRoleMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `role` field. + + +### fn withRoleMixin + +```ts +withRoleMixin() +``` + +`google.list[obj].withRoleMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the role 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].withRole](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `role` field. + + +### fn withScopeId + +```ts +withScopeId() +``` + +`google.string.withScopeId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the scope_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope_id` field. + + +### fn withScopeRbacRoleBindingId + +```ts +withScopeRbacRoleBindingId() +``` + +`google.string.withScopeRbacRoleBindingId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the scope_rbac_role_binding_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope_rbac_role_binding_id` 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 withUser + +```ts +withUser() +``` + +`google.string.withUser` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the user field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `user` field. + + +## obj role + + + +### fn role.new + +```ts +new() +``` + + +`google.gke_hub_scope_rbac_role_binding.role.new` constructs a new object with attributes and blocks configured for the `role` +Terraform sub block. + + + +**Args**: + - `predefined_role` (`string`): PredefinedRole is an ENUM representation of the default Kubernetes Roles Possible values: ["UNKNOWN", "ADMIN", "EDIT", "VIEW"] When `null`, the `predefined_role` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `role` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.gke_hub_scope_rbac_role_binding.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/iam_workforce_pool_provider.md b/docs/4.x/iam_workforce_pool_provider.md index 569996b..b160536 100644 --- a/docs/4.x/iam_workforce_pool_provider.md +++ b/docs/4.x/iam_workforce_pool_provider.md @@ -596,6 +596,8 @@ Terraform sub block. **Args**: + - `additional_scopes` (`list`): Additional scopes to request for in the OIDC authentication request on top of scopes requested by default. By default, the 'openid', 'profile' and 'email' scopes that are supported by the identity provider are requested. +Each additional scope may be at most 256 characters. A maximum of 10 additional scopes may be configured. When `null`, the `additional_scopes` field will be omitted from the resulting object. - `assertion_claims_behavior` (`string`): The behavior for how OIDC Claims are included in the 'assertion' object used for attribute mapping and attribute condition. * MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS: Merge the UserInfo Endpoint Claims with ID Token Claims, preferring UserInfo Claim Values for the same Claim Name. This option is available only for the Authorization Code Flow. * ONLY_ID_TOKEN_CLAIMS: Only include ID Token Claims. Possible values: ["MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS", "ONLY_ID_TOKEN_CLAIMS"] diff --git a/docs/4.x/monitoring_uptime_check_config.md b/docs/4.x/monitoring_uptime_check_config.md index 3b0bb80..ef93b69 100644 --- a/docs/4.x/monitoring_uptime_check_config.md +++ b/docs/4.x/monitoring_uptime_check_config.md @@ -28,6 +28,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withResourceGroup()`](#fn-withresourcegroup) * [`fn withResourceGroupMixin()`](#fn-withresourcegroupmixin) * [`fn withSelectedRegions()`](#fn-withselectedregions) +* [`fn withSyntheticMonitor()`](#fn-withsyntheticmonitor) +* [`fn withSyntheticMonitorMixin()`](#fn-withsyntheticmonitormixin) * [`fn withTcpCheck()`](#fn-withtcpcheck) * [`fn withTcpCheckMixin()`](#fn-withtcpcheckmixin) * [`fn withTimeout()`](#fn-withtimeout) @@ -47,6 +49,10 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-monitored_resourcenew) * [`obj resource_group`](#obj-resource_group) * [`fn new()`](#fn-resource_groupnew) +* [`obj synthetic_monitor`](#obj-synthetic_monitor) + * [`fn new()`](#fn-synthetic_monitornew) + * [`obj synthetic_monitor.cloud_function_v2`](#obj-synthetic_monitorcloud_function_v2) + * [`fn new()`](#fn-synthetic_monitorcloud_function_v2new) * [`obj tcp_check`](#obj-tcp_check) * [`fn new()`](#fn-tcp_checknew) * [`obj timeouts`](#obj-timeouts) @@ -91,6 +97,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor. - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor. - `resource_group` (`list[obj]`): The group resource associated with the configuration. When `null`, the `resource_group` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.resource_group.new](#fn-resource_groupnew) constructor. + - `synthetic_monitor` (`list[obj]`): A Synthetic Monitor deployed to a Cloud Functions V2 instance. When `null`, the `synthetic_monitor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.synthetic_monitor.new](#fn-synthetic_monitornew) constructor. - `tcp_check` (`list[obj]`): Contains information needed to make a TCP check. When `null`, the `tcp_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.new](#fn-tcp_checknew) 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.monitoring_uptime_check_config.timeouts.new](#fn-timeoutsnew) constructor. @@ -126,6 +133,7 @@ injecting into a complete block. - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor. - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor. - `resource_group` (`list[obj]`): The group resource associated with the configuration. When `null`, the `resource_group` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.resource_group.new](#fn-resource_groupnew) constructor. + - `synthetic_monitor` (`list[obj]`): A Synthetic Monitor deployed to a Cloud Functions V2 instance. When `null`, the `synthetic_monitor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.synthetic_monitor.new](#fn-synthetic_monitornew) constructor. - `tcp_check` (`list[obj]`): Contains information needed to make a TCP check. When `null`, the `tcp_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.new](#fn-tcp_checknew) 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.monitoring_uptime_check_config.timeouts.new](#fn-timeoutsnew) constructor. @@ -361,6 +369,43 @@ Terraform resource block to set or update the selected_regions field. - `value` (`list`): The value to set for the `selected_regions` field. +### fn withSyntheticMonitor + +```ts +withSyntheticMonitor() +``` + +`google.list[obj].withSyntheticMonitor` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the synthetic_monitor 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].withSyntheticMonitorMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `synthetic_monitor` field. + + +### fn withSyntheticMonitorMixin + +```ts +withSyntheticMonitorMixin() +``` + +`google.list[obj].withSyntheticMonitorMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the synthetic_monitor 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].withSyntheticMonitor](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `synthetic_monitor` field. + + ### fn withTcpCheck ```ts @@ -628,6 +673,52 @@ Terraform sub block. - An attribute object that represents the `resource_group` sub block. +## obj synthetic_monitor + + + +### fn synthetic_monitor.new + +```ts +new() +``` + + +`google.monitoring_uptime_check_config.synthetic_monitor.new` constructs a new object with attributes and blocks configured for the `synthetic_monitor` +Terraform sub block. + + + +**Args**: + - `cloud_function_v2` (`list[obj]`): Target a Synthetic Monitor GCFv2 Instance When `null`, the `cloud_function_v2` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.synthetic_monitor.cloud_function_v2.new](#fn-synthetic_monitorcloud_function_v2new) constructor. + +**Returns**: + - An attribute object that represents the `synthetic_monitor` sub block. + + +## obj synthetic_monitor.cloud_function_v2 + + + +### fn synthetic_monitor.cloud_function_v2.new + +```ts +new() +``` + + +`google.monitoring_uptime_check_config.synthetic_monitor.cloud_function_v2.new` constructs a new object with attributes and blocks configured for the `cloud_function_v2` +Terraform sub block. + + + +**Args**: + - `name` (`string`): The fully qualified name of the cloud function resource. + +**Returns**: + - An attribute object that represents the `cloud_function_v2` sub block. + + ## obj tcp_check diff --git a/docs/4.x/provider.md b/docs/4.x/provider.md index 160d2ae..be24550 100644 --- a/docs/4.x/provider.md +++ b/docs/4.x/provider.md @@ -47,6 +47,7 @@ the `src` and/or `version` parameters are set. - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting provider block. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object. - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting provider block. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object. - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting provider block. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object. + - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting provider block. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object. - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object. - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object. - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object. @@ -207,6 +208,7 @@ injecting into a complete block. - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting object. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object. - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting object. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object. - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting object. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object. + - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting object. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object. - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting object. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object. - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting object. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object. - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting object. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.