Skip to content

Added missing fields to google_colab_schedule and marked google_vertex_ai_schedule as deprecated#18303

Open
melinath wants to merge 17 commits into
GoogleCloudPlatform:mainfrom
melinath:colab-schedule-missing-fields
Open

Added missing fields to google_colab_schedule and marked google_vertex_ai_schedule as deprecated#18303
melinath wants to merge 17 commits into
GoogleCloudPlatform:mainfrom
melinath:colab-schedule-missing-fields

Conversation

@melinath

@melinath melinath commented Jul 15, 2026

Copy link
Copy Markdown
Member

Interesting design notes:

  • parent has to be O+C because it was being set implicitly on google_colab_schedule, but was required on google_vertex_ai_schedule. (We could also do diff suppression but I think that would be more confusing. We could also not add the parent field, but that also seems confusing and it's not immediately clear whether the parent field can take values different than what we're calculating.)
  • max_concurrent_run_count has to be optional because it can't be set if createNotebookExecutionJobRequest is set.
  • didn't implement createPipelineJobRequest.runtimeConfig.inputArtifacts because the implementation on vertex ai Schedule doesn't seem to actually work - the field is implemented as a KeyValuePairs field, but it should be a Map with nested object that contains an artifactId field pointing to an artifact resource - see https://docs.cloud.google.com/gemini-enterprise-agent-platform/reference/rest/v1/projects.locations.pipelineJobs#PipelineJob.RuntimeConfig. (Note: the artifact resource also isn't supported in Terraform so we'd need to add support for that first.)
  • No tests for reservation_affinity - reservations are difficult to create in tests, so we can't test this block.
  • Made pipeline_job_id output-only on Colab schedule - trying to create a resource with it set caused the error: create_pipeline_job_request.pipeline_job_id should not be set. I looked into it and it looks like this isn't settable on scheduled jobs, only directly created jobs.
    • Same for create_notebook_execution_job_request.notebook_execution_job_id

Release Note Template for Downstream PRs (will be copied)

See Write release notes for guidance.

colab: added `create_pipeline_job_request`, `max_concurrent_active_run_count`, `catch_up`, `last_pause_time`, `last_resume_time`, `last_scheduled_run_response`, `next_run_time`, `started_run_count`, `create_time`, `update_time`, and missing sub-fields under `create_notebook_execution_job_request` (`custom_environment_spec`, `direct_notebook_source`, `encryption_spec`, `job_state`, `kernel_name`, `labels`, `parameters`, `schedule_resource_name`, `workbench_runtime`, `notebook_execution_job_id`, `parent`) to `google_colab_schedule`
vertexai: deprecated `google_vertex_ai_schedule`, an accidentally-added duplicate resource. Use `google_colab_schedule` instead.

@modular-magician

This comment was marked as outdated.

@modular-magician

This comment was marked as outdated.

@modular-magician

This comment was marked as outdated.

@modular-magician

This comment was marked as outdated.

@melinath

Copy link
Copy Markdown
Member Author

/gcbrun

@modular-magician

This comment was marked as outdated.

@modular-magician

This comment was marked as outdated.

@modular-magician

This comment was marked as outdated.

@modular-magician

This comment was marked as outdated.

@modular-magician

modular-magician commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

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

Diff report

Your PR generated the following diffs in downstream repositories:

Repository Diff Link Changes
google provider View Diff 6 files changed, 3426 insertions(+), 335 deletions(-)
google-beta provider View Diff 6 files changed, 3274 insertions(+), 342 deletions(-)
terraform-google-conversion View Diff 1 file changed, 1037 insertions(+), 88 deletions(-)
Open in Cloud Shell View Diff 4 files changed, 176 insertions(+)

Missing test report

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

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

resource "google_colab_schedule" "primary" {
  create_notebook_execution_job_request {
    notebook_execution_job {
      custom_environment_spec {
        machine_spec {
          reservation_affinity {
            key                       = # value needed
            reservation_affinity_type = # value needed
            use_reservation_pool      = # value needed
            values                    = # value needed
          }
        }
      }
    }
  }
}

Test report

Important

Manual Verification Required (GA-only additions)

The following tests are GA-only additions and cannot be run by VCR in Beta mode. Please verify them manually:

🔴 TestAccColabSchedule_colabScheduleFullExample

Analytics

Total Tests Passed Skipped Affected
125 119 5 1
Affected Service Packages
  • colab
  • vertexai

Learn how VCR tests work


Step 1: Replaying Mode

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit.

Click here to see the affected tests
  • TestAccColabSchedule_colabScheduleNotebookFullExample

View the replaying VCR build log


Step 2: Recording Mode

Recording Mode Replaying Rerun Test Name
❌ Error · Log - TestAccColabSchedule_colabScheduleNotebookFullExample

Caution

Issues requiring attention before PR completion

🔴 Manual Verification Required: New tests were added that are skipped in presubmit tests. See the "Manual Verification Required" section at the top for details.

🔴 Initial Recording Failed: Some tests failed during the recording step. See the table above for details.

Please address these issues to complete your PR. If you believe these detections are incorrect or unrelated to your change, please raise the concern with your reviewer.

View the recording VCR build log or the debug logs folder for detailed results.

@melinath VCR tests complete for 8c108bd!

@melinath

melinath commented Jul 17, 2026

Copy link
Copy Markdown
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants