Make description and displayName optional and mutable (#14328) (#10233)

[upstream:7bdafeba3bff309fc04f21411f691387330b007d]

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

.changelog/14328.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+monitoring: made `description` and `displayName` optional and mutable in `google_monitoring_metric_descriptor`
+```

google-beta/services/monitoring/resource_monitoring_metric_descriptor.go

@@ -56,18 +56,6 @@ func ResourceMonitoringMetricDescriptor() *schema.Resource {
 		),
 
 		Schema: map[string]*schema.Schema{
-			"description": {
-				Type:        schema.TypeString,
-				Required:    true,
-				ForceNew:    true,
-				Description: `A detailed description of the metric, which can be used in documentation.`,
-			},
-			"display_name": {
-				Type:        schema.TypeString,
-				Required:    true,
-				ForceNew:    true,
-				Description: `A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".`,
-			},
 			"metric_kind": {
 				Type:         schema.TypeString,
 				Required:     true,
@@ -88,6 +76,16 @@ func ResourceMonitoringMetricDescriptor() *schema.Resource {
 				ValidateFunc: verify.ValidateEnum([]string{"BOOL", "INT64", "DOUBLE", "STRING", "DISTRIBUTION"}),
 				Description:  `Whether the measurement is an integer, a floating-point number, etc. Some combinations of metricKind and valueType might not be supported. Possible values: ["BOOL", "INT64", "DOUBLE", "STRING", "DISTRIBUTION"]`,
 			},
+			"description": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: `A detailed description of the metric, which can be used in documentation.`,
+			},
+			"display_name": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: `A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".`,
+			},
 			"labels": {
 				Type:        schema.TypeSet,
 				Optional:    true,
@@ -128,7 +126,6 @@ func ResourceMonitoringMetricDescriptor() *schema.Resource {
 			"unit": {
 				Type:     schema.TypeString,
 				Optional: true,
-				ForceNew: true,
 				Description: `The units in which the metric value is reported. It is only applicable if the
 valueType is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of
 the stored metric values.

google-beta/services/monitoring/resource_monitoring_metric_descriptor_test.go

@@ -33,7 +33,7 @@ func TestAccMonitoringMetricDescriptor_update(t *testing.T) {
 		CheckDestroy:             testAccCheckMonitoringMetricDescriptorDestroyProducer(t),
 		Steps: []resource.TestStep{
 			{
-				Config: testAccMonitoringMetricDescriptor_update("30s", "30s"),
+				Config: testAccMonitoringMetricDescriptor_update("initial description", "initial display name", "30s", "30s"),
 			},
 			{
 				ResourceName:            "google_monitoring_metric_descriptor.basic",
@@ -42,23 +42,32 @@ func TestAccMonitoringMetricDescriptor_update(t *testing.T) {
 				ImportStateVerifyIgnore: []string{"metadata", "launch_stage"},
 			},
 			{
-				Config: testAccMonitoringMetricDescriptor_update("60s", "60s"),
+				Config: testAccMonitoringMetricDescriptor_update("updated description", "updated display name", "60s", "60s"),
 			},
 			{
 				ResourceName:            "google_monitoring_metric_descriptor.basic",
 				ImportState:             true,
 				ImportStateVerify:       true,
 				ImportStateVerifyIgnore: []string{"metadata", "launch_stage"},
 			},
+			{
+				Config: testAccMonitoringMetricDescriptor_omittedFields(),
+			},
+			{
+				ResourceName:            "google_monitoring_metric_descriptor.basic",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"metadata", "launch_stage", "description", "display_name"},
+			},
 		},
 	})
 }
 
-func testAccMonitoringMetricDescriptor_update(samplePeriod, ingestDelay string) string {
+func testAccMonitoringMetricDescriptor_update(description, displayName, samplePeriod, ingestDelay string) string {
 	return fmt.Sprintf(`
 resource "google_monitoring_metric_descriptor" "basic" {
-	description = "Daily sales records from all branch stores."
-	display_name = "daily sales"
+	description = "%s"
+	display_name = "%s"
 	type = "custom.googleapis.com/stores/daily_sales"
 	metric_kind = "GAUGE"
 	value_type = "DOUBLE"
@@ -74,6 +83,27 @@ resource "google_monitoring_metric_descriptor" "basic" {
 		ingest_delay = "%s"
 	}
 }
-`, samplePeriod, ingestDelay,
+`, description, displayName, samplePeriod, ingestDelay,
 	)
 }
+
+func testAccMonitoringMetricDescriptor_omittedFields() string {
+	return `
+resource "google_monitoring_metric_descriptor" "basic" {
+	type = "custom.googleapis.com/stores/daily_sales"
+	metric_kind = "GAUGE"
+	value_type = "DOUBLE"
+	unit = "{USD}"
+	labels {
+		key = "key"
+		value_type = "STRING"
+		description = "description"
+	}
+	launch_stage = "BETA"
+	metadata {
+		sample_period = "30s"
+		ingest_delay = "30s"
+	}
+}
+`
+}

website/docs/r/monitoring_metric_descriptor.html.markdown

@@ -109,14 +109,6 @@ The following arguments are supported:
   Whether the measurement is an integer, a floating-point number, etc. Some combinations of metricKind and valueType might not be supported.
   Possible values are: `BOOL`, `INT64`, `DOUBLE`, `STRING`, `DISTRIBUTION`.
 
-* `description` -
-  (Required)
-  A detailed description of the metric, which can be used in documentation.
-
-* `display_name` -
-  (Required)
-  A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
-
 
 - - -
 
@@ -146,6 +138,14 @@ The following arguments are supported:
   More info can be found in the API documentation
   (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors).
 
+* `description` -
+  (Optional)
+  A detailed description of the metric, which can be used in documentation.
+
+* `display_name` -
+  (Optional)
+  A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
+
 * `metadata` -
   (Optional)
   Metadata which can be used to guide usage of the metric.