Try to clarify scheduler docs on pubsub (#2904)

Merged PR #2904.
GoogleCloudPlatform · Jan 2, 2020 · 2e43da8 · 2e43da8
1 parent 8cddcb7
commit 2e43da8
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 7 deletions.
diff --git a/build/ansible b/build/ansible
diff --git a/build/inspec b/build/inspec
diff --git a/build/terraform b/build/terraform
diff --git a/build/terraform-beta b/build/terraform-beta
diff --git a/products/cloudscheduler/api.yaml b/products/cloudscheduler/api.yaml
@@ -166,9 +166,10 @@ objects:
           - !ruby/object:Api::Type::String
             name: topicName
             description: |
-              The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. 
-              The topic name must be in the same format as required by PubSub's PublishRequest.name, 
-              for example projects/PROJECT_ID/topics/TOPIC_ID.
+              The full resource name for the Cloud Pub/Sub topic to which
+              messages will be published when a job is delivered. ~>**NOTE**:
+              The topic name must be in the same format as required by PubSub's
+              PublishRequest.name, e.g. `projects/my-project/topics/my-topic`.
             required: true
             input: true
           - !ruby/object:Api::Type::String

diff --git a/templates/terraform/examples/scheduler_job_pubsub.tf.erb b/templates/terraform/examples/scheduler_job_pubsub.tf.erb
@@ -8,6 +8,7 @@ resource "google_cloud_scheduler_job" "job" {
   schedule    = "*/2 * * * *"
 
   pubsub_target {
+    # topic.id is the topic's full resource name.
     topic_name = google_pubsub_topic.topic.id
     data       = base64encode("test")
   }