add new fields and update examples

[kefang2]

Release Note Template for Downstream PRs (will be copied)

See Write release notes for guidance.

discoveryengine: added `connector_modes`, `sync_mode`, `incremental_refresh_interval`, `auto_run_disabled`, and `incremental_sync_disabled` fields to `google_discovery_engine_data_connector` resource

discoveryengine: added `kms_key_name` field to `google_discovery_engine_search_engine` resource

discoveryengine: fixed bug where it wasn't possible to specify values for `knowledgeBaseSysId` or `catalogSysId` in `google_discovery_engine_data_connector.entities.params`.

discoveryengine: changed type of `google_discovery_engine_data_connector.entities.params`. Previously, it was a map of string keys to string values; now, it must be a [JSON-encoded](https://developer.hashicorp.com/terraform/language/functions/jsonencode) string containing an object. This change is being made in a minor release because the field wasn't usable as intended – specifically, all current valid uses require mapping strings to _lists_ of strings.

[github-actions]

Hello! I am a robot. Tests will require approval from a repository maintainer to run.

Googlers: For automatic test runs see go/terraform-auto-test-runs.

@melinath, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 7 files changed, 276 insertions(+), 100 deletions(-))
google-beta provider: Diff ( 7 files changed, 276 insertions(+), 100 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 50 insertions(+))
Open in Cloud Shell: Diff ( 5 files changed, 131 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_discovery_engine_data_connector (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_discovery_engine_data_connector" "primary" {
  auto_run_disabled         = # value needed
  incremental_sync_disabled = # value needed
}

[modular-magician]

Non-exercised tests

🔴 Tests were added that are skipped in VCR:

• TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample_update

Tests analytics

Total tests: 27
Passed tests: 22
Skipped tests: 1
Affected tests: 4

Click here to see the affected service packages

• discoveryengine

Action taken

Found 4 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample
• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update
• TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample
• TestAccDiscoveryEngineSearchEngine_discoveryengineSearchengineAgentspaceBasicExample

Get to know how VCR tests work

[modular-magician]

🟢 Tests passed during RECORDING mode:
TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample [Debug log]
TestAccDiscoveryEngineSearchEngine_discoveryengineSearchengineAgentspaceBasicExample [Debug log]

🟢 No issues found for passed tests after REPLAYING rerun.

---

🔴 Tests failed during RECORDING mode:
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample [Error message] [Debug log]
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 9 files changed, 323 insertions(+), 100 deletions(-))
google-beta provider: Diff ( 9 files changed, 323 insertions(+), 100 deletions(-))
terraform-google-conversion: Diff ( 2 files changed, 60 insertions(+))
Open in Cloud Shell: Diff ( 5 files changed, 131 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_discovery_engine_data_connector (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_discovery_engine_data_connector" "primary" {
  auto_run_disabled         = # value needed
  incremental_sync_disabled = # value needed
}

Resource: google_discovery_engine_search_engine (4 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_discovery_engine_search_engine" "primary" {
  kms_key_name = # value needed
}

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 9 files changed, 323 insertions(+), 100 deletions(-))
google-beta provider: Diff ( 9 files changed, 323 insertions(+), 100 deletions(-))
terraform-google-conversion: Diff ( 2 files changed, 60 insertions(+))
Open in Cloud Shell: Diff ( 5 files changed, 131 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_discovery_engine_data_connector (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_discovery_engine_data_connector" "primary" {
  auto_run_disabled         = # value needed
  incremental_sync_disabled = # value needed
}

Resource: google_discovery_engine_search_engine (4 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_discovery_engine_search_engine" "primary" {
  kms_key_name = # value needed
}

[modular-magician]

Non-exercised tests

🔴 Tests were added that are skipped in VCR:

• TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample_update

Tests analytics

Total tests: 27
Passed tests: 24
Skipped tests: 1
Affected tests: 2

Click here to see the affected service packages

• discoveryengine

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample
• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update

Get to know how VCR tests work

[modular-magician]

🔴 Tests failed during RECORDING mode:
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample [Error message] [Debug log]
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

[modular-magician]

Non-exercised tests

🔴 Tests were added that are skipped in VCR:

• TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample_update

Tests analytics

Total tests: 27
Passed tests: 24
Skipped tests: 1
Affected tests: 2

Click here to see the affected service packages

• discoveryengine

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample
• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update

Get to know how VCR tests work

[modular-magician]

🔴 Tests failed during RECORDING mode:
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample [Error message] [Debug log]
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

[github-actions]

@malhotrasagar2212 This PR has been waiting for review for 3 weekdays. Please take a look! Use the label disable-review-reminders to disable these notifications.

[github-actions]

@GoogleCloudPlatform/terraform-team @malhotrasagar2212 This PR has been waiting for review for 1 week. Please take a look! Use the label disable-review-reminders to disable these notifications.

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 9 files changed, 432 insertions(+), 111 deletions(-))
google-beta provider: Diff ( 9 files changed, 432 insertions(+), 111 deletions(-))
terraform-google-conversion: Diff ( 2 files changed, 68 insertions(+), 6 deletions(-))
Open in Cloud Shell: Diff ( 5 files changed, 152 insertions(+))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

• Field entities.params changed from TypeMap to TypeString on google_discovery_engine_data_connector - reference

If you believe this detection to be incorrect please raise the concern with your reviewer.
If you intend to make this change you will need to wait for a major release window.
An override-breaking-change label can be added to allow merging.

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_discovery_engine_data_connector (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_discovery_engine_data_connector" "primary" {
  auto_run_disabled         = # value needed
  incremental_sync_disabled = # value needed
}

Resource: google_discovery_engine_search_engine (4 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_discovery_engine_search_engine" "primary" {
  kms_key_name = # value needed
}

[modular-magician]

Non-exercised tests

🔴 Tests were added that are skipped in VCR:

• TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample_update

Tests analytics

Total tests: 29
Passed tests: 25
Skipped tests: 1
Affected tests: 3

Click here to see the affected service packages

• discoveryengine

Action taken

Found 3 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample
• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update
• TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample

Get to know how VCR tests work

[modular-magician]

🟢 Tests passed during RECORDING mode:
TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample [Debug log]

🟢 No issues found for passed tests after REPLAYING rerun.

---

🔴 Tests failed during RECORDING mode:
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample [Error message] [Debug log]
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

[melinath]

@modular-magician reassign-reviewer @melinath

[melinath]

Could you add the missing field tests described in #15296 (comment)? It would also be good to have the update test update auto_run_disabled and incremental_sync_disabled from true to false just to make sure that works. That should resolve the missing tests for those fields.

kms_key_name might be trickier, depending on the requirements. It looks like the discoveryengine CMEKConfig tests are failing right now. I'd be fine merging with just manual tests for this field if you can confirm it works locally?

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 9 files changed, 432 insertions(+), 111 deletions(-))
google-beta provider: Diff ( 9 files changed, 432 insertions(+), 111 deletions(-))
terraform-google-conversion: Diff ( 2 files changed, 68 insertions(+), 6 deletions(-))
Open in Cloud Shell: Diff ( 5 files changed, 152 insertions(+))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

• Field entities.params changed from TypeMap to TypeString on google_discovery_engine_data_connector - reference

If you believe this detection to be incorrect please raise the concern with your reviewer.
If you intend to make this change you will need to wait for a major release window.
An override-breaking-change label can be added to allow merging.

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_discovery_engine_data_connector (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_discovery_engine_data_connector" "primary" {
  auto_run_disabled         = # value needed
  incremental_sync_disabled = # value needed
}

Resource: google_discovery_engine_search_engine (4 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_discovery_engine_search_engine" "primary" {
  kms_key_name = # value needed
}

[modular-magician]

Non-exercised tests

🔴 Tests were added that are skipped in VCR:

• TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample_update

Tests analytics

Total tests: 29
Passed tests: 26
Skipped tests: 1
Affected tests: 2

Click here to see the affected service packages

• discoveryengine

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample
• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update

Get to know how VCR tests work

[modular-magician]

🔴 Tests failed during RECORDING mode:
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample [Error message] [Debug log]
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

[modular-magician]

🔴 Tests failed during RECORDING mode:
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample [Error message] [Debug log]
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update [Error message] [Debug log]
TestAccDiscoveryEngineSearchEngine_discoveryengineSearchengineBasicExample_update [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 10 files changed, 437 insertions(+), 113 deletions(-))
google-beta provider: Diff ( 10 files changed, 437 insertions(+), 113 deletions(-))
terraform-google-conversion: Diff ( 2 files changed, 68 insertions(+), 6 deletions(-))
Open in Cloud Shell: Diff ( 5 files changed, 152 insertions(+))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

• Field entities.params changed from TypeMap to TypeString on google_discovery_engine_data_connector - reference

If you believe this detection to be incorrect please raise the concern with your reviewer.
If you intend to make this change you will need to wait for a major release window.
An override-breaking-change label can be added to allow merging.

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_discovery_engine_data_connector (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_discovery_engine_data_connector" "primary" {
  entities {
    key_property_mappings = # value needed
  }
}

[modular-magician]

Non-exercised tests

🔴 Tests were added that are skipped in VCR:

• TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample_update

Tests analytics

Total tests: 29
Passed tests: 25
Skipped tests: 1
Affected tests: 3

Click here to see the affected service packages

• discoveryengine

Action taken

Found 3 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample
• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update
• TestAccDiscoveryEngineSearchEngine_discoveryengineSearchengineBasicExample_update

Get to know how VCR tests work

[modular-magician]

🔴 Tests failed during RECORDING mode:
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample [Error message] [Debug log]
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update [Error message] [Debug log]
TestAccDiscoveryEngineSearchEngine_discoveryengineSearchengineBasicExample_update [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

[melinath]

we can ignore the unused-template-check failure - it's not relevant for state migrations.

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 10 files changed, 779 insertions(+), 113 deletions(-))
google-beta provider: Diff ( 10 files changed, 779 insertions(+), 113 deletions(-))
terraform-google-conversion: Diff ( 2 files changed, 74 insertions(+), 6 deletions(-))
Open in Cloud Shell: Diff ( 5 files changed, 152 insertions(+))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

• Field entities.params changed from TypeMap to TypeString on google_discovery_engine_data_connector - reference

If you believe this detection to be incorrect please raise the concern with your reviewer.
If you intend to make this change you will need to wait for a major release window.
An override-breaking-change label can be added to allow merging.

[modular-magician]

Non-exercised tests

🔴 Tests were added that are skipped in VCR:

• TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample_update

Tests analytics

Total tests: 30
Passed tests: 26
Skipped tests: 1
Affected tests: 3

Click here to see the affected service packages

• discoveryengine

Action taken

Found 3 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample
• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update
• TestAccDiscoveryEngineSearchEngine_discoveryengineSearchengineBasicExample_update

Get to know how VCR tests work

[modular-magician]

🔴 Tests failed during RECORDING mode:
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample [Error message] [Debug log]
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update [Error message] [Debug log]
TestAccDiscoveryEngineSearchEngine_discoveryengineSearchengineBasicExample_update [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

[melinath]

LGTM - upgrade path seems to work (apart from the fact that the config has to be upgraded in the ways we expect.) The rest of the PR also looks good / works as far as I can tell.

[melinath]

The TestAccDiscoveryEngineCmekConfig* failures are unrelated to this PR.

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 10 files changed, 781 insertions(+), 115 deletions(-))
google-beta provider: Diff ( 10 files changed, 781 insertions(+), 115 deletions(-))
terraform-google-conversion: Diff ( 2 files changed, 74 insertions(+), 6 deletions(-))
Open in Cloud Shell: Diff ( 5 files changed, 152 insertions(+))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

• Field entities.params changed from TypeMap to TypeString on google_discovery_engine_data_connector - reference

If you believe this detection to be incorrect please raise the concern with your reviewer.
If you intend to make this change you will need to wait for a major release window.
An override-breaking-change label can be added to allow merging.

[modular-magician]

Non-exercised tests

🔴 Tests were added that are skipped in VCR:

• TestAccDiscoveryEngineDataConnector_discoveryengineDataconnectorServicenowBasicExample_update

Tests analytics

Total tests: 30
Passed tests: 26
Skipped tests: 1
Affected tests: 3

Click here to see the affected service packages

• discoveryengine

Action taken

Found 3 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample
• TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update
• TestAccDiscoveryEngineSearchEngine_discoveryengineSearchengineBasicExample_update

Get to know how VCR tests work

[modular-magician]

🟢 Tests passed during RECORDING mode:
TestAccDiscoveryEngineSearchEngine_discoveryengineSearchengineBasicExample_update [Debug log]

🟢 No issues found for passed tests after REPLAYING rerun.

---

🔴 Tests failed during RECORDING mode:
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample [Error message] [Debug log]
TestAccDiscoveryEngineCmekConfig_discoveryengineCmekconfigDefaultExample_update [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test