chore: add license and generated code headers to generated resource f…

…iles (#7222) docs: Various updates PiperOrigin-RevId: 624233552 Source-Link: googleapis/googleapis@1413b13 Source-Link: googleapis/googleapis-gen@fa02723 Copy-Tag: eyJwIjoiTW9uaXRvcmluZy8uT3dsQm90LnlhbWwiLCJoIjoiZmEwMjcyM2NkYmNmMGRiNDRlYmRmZTQxODU4ZDBmZTQxMDA5NDVhZCJ9 docs: updated comments PiperOrigin-RevId: 624277410 Source-Link: googleapis/googleapis@2d881be Source-Link: googleapis/googleapis-gen@1d063f9 Copy-Tag: eyJwIjoiTW9uaXRvcmluZy8uT3dsQm90LnlhbWwiLCJoIjoiMWQwNjNmOTM1M2FlZmZiOWE5NjhmMWEwMGYxZDEwNWIwYzE0YTQyZCJ9
googleapis · Apr 13, 2024 · 2060f2d · 2060f2d
1 parent fae9bd3
commit 2060f2d
Show file tree

Hide file tree

Showing 63 changed files with 886 additions and 429 deletions.
diff --git a/Monitoring/metadata/V3/QueryService.php b/Monitoring/metadata/V3/QueryService.php
diff --git a/Monitoring/samples/V3/GroupServiceClient/create_group.php b/Monitoring/samples/V3/GroupServiceClient/create_group.php
@@ -31,8 +31,9 @@
 /**
  * Creates a new group.
  *
- * @param string $name The [project](https://cloud.google.com/monitoring/api/v3#project_name) in
- *                     which to create the group. The format is:
+ * @param string $name The
+ *                     [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
+ *                     to create the group. The format is:
  *
  *                     projects/[PROJECT_ID_OR_NUMBER]
  */

diff --git a/Monitoring/samples/V3/GroupServiceClient/list_groups.php b/Monitoring/samples/V3/GroupServiceClient/list_groups.php
@@ -32,8 +32,9 @@
 /**
  * Lists the existing groups.
  *
- * @param string $name The [project](https://cloud.google.com/monitoring/api/v3#project_name)
- *                     whose groups are to be listed. The format is:
+ * @param string $name The
+ *                     [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
+ *                     groups are to be listed. The format is:
  *
  *                     projects/[PROJECT_ID_OR_NUMBER]
  */

diff --git a/Monitoring/samples/V3/MetricServiceClient/create_metric_descriptor.php b/Monitoring/samples/V3/MetricServiceClient/create_metric_descriptor.php
@@ -30,13 +30,15 @@
 
 /**
  * Creates a new metric descriptor.
- * The creation is executed asynchronously and callers may check the returned
- * operation to track its progress.
+ * The creation is executed asynchronously.
  * User-created metric descriptors define
  * [custom metrics](https://cloud.google.com/monitoring/custom-metrics).
+ * The metric descriptor is updated if it already exists,
+ * except that metric labels are never removed.
  *
- * @param string $name The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
- *                     which to execute the request. The format is:
+ * @param string $name The
+ *                     [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
+ *                     to execute the request. The format is:
  *                     4
  *                     projects/[PROJECT_ID_OR_NUMBER]
  */

diff --git a/Monitoring/samples/V3/MetricServiceClient/create_service_time_series.php b/Monitoring/samples/V3/MetricServiceClient/create_service_time_series.php
@@ -39,8 +39,9 @@
  * [projects.timeSeries.create][google.monitoring.v3.MetricService.CreateTimeSeries]
  * instead.
  *
- * @param string $formattedName The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
- *                              which to execute the request. The format is:
+ * @param string $formattedName The
+ *                              [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
+ *                              to execute the request. The format is:
  *
  *                              projects/[PROJECT_ID_OR_NUMBER]
  *                              Please see {@see MetricServiceClient::projectName()} for help formatting this field.

diff --git a/Monitoring/samples/V3/MetricServiceClient/create_time_series.php b/Monitoring/samples/V3/MetricServiceClient/create_time_series.php
@@ -33,9 +33,13 @@
  * The response is empty if all time series in the request were written.
  * If any time series could not be written, a corresponding failure message is
  * included in the error response.
+ * This method does not support
+ * [resource locations constraint of an organization
+ * policy](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations#setting_the_organization_policy).
  *
- * @param string $formattedName The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
- *                              which to execute the request. The format is:
+ * @param string $formattedName The
+ *                              [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
+ *                              to execute the request. The format is:
  *
  *                              projects/[PROJECT_ID_OR_NUMBER]
  *                              Please see {@see MetricServiceClient::projectName()} for help formatting this field.

diff --git a/Monitoring/samples/V3/MetricServiceClient/delete_metric_descriptor.php b/Monitoring/samples/V3/MetricServiceClient/delete_metric_descriptor.php
@@ -32,7 +32,8 @@
  * [custom metrics](https://cloud.google.com/monitoring/custom-metrics) can be
  * deleted.
  *
- * @param string $formattedName The metric descriptor on which to execute the request. The format is:
+ * @param string $formattedName The metric descriptor on which to execute the request. The format
+ *                              is:
  *
  *                              projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
  *

diff --git a/Monitoring/samples/V3/MetricServiceClient/get_metric_descriptor.php b/Monitoring/samples/V3/MetricServiceClient/get_metric_descriptor.php
@@ -29,9 +29,10 @@
 use Google\Cloud\Monitoring\V3\GetMetricDescriptorRequest;
 
 /**
- * Gets a single metric descriptor. This method does not require a Workspace.
+ * Gets a single metric descriptor.
  *
- * @param string $formattedName The metric descriptor on which to execute the request. The format is:
+ * @param string $formattedName The metric descriptor on which to execute the request. The format
+ *                              is:
  *
  *                              projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
  *

diff --git a/Monitoring/samples/V3/MetricServiceClient/get_monitored_resource_descriptor.php b/Monitoring/samples/V3/MetricServiceClient/get_monitored_resource_descriptor.php
@@ -29,7 +29,7 @@
 use Google\Cloud\Monitoring\V3\GetMonitoredResourceDescriptorRequest;
 
 /**
- * Gets a single monitored resource descriptor. This method does not require a Workspace.
+ * Gets a single monitored resource descriptor.
  *
  * @param string $formattedName The monitored resource descriptor to get.  The format is:
  *

diff --git a/Monitoring/samples/V3/MetricServiceClient/list_metric_descriptors.php b/Monitoring/samples/V3/MetricServiceClient/list_metric_descriptors.php
@@ -30,10 +30,11 @@
 use Google\Cloud\Monitoring\V3\ListMetricDescriptorsRequest;
 
 /**
- * Lists metric descriptors that match a filter. This method does not require a Workspace.
+ * Lists metric descriptors that match a filter.
  *
- * @param string $name The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
- *                     which to execute the request. The format is:
+ * @param string $name The
+ *                     [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
+ *                     to execute the request. The format is:
  *
  *                     projects/[PROJECT_ID_OR_NUMBER]
  */

diff --git a/Monitoring/samples/V3/MetricServiceClient/list_monitored_resource_descriptors.php b/Monitoring/samples/V3/MetricServiceClient/list_monitored_resource_descriptors.php
@@ -30,10 +30,11 @@
 use Google\Cloud\Monitoring\V3\ListMonitoredResourceDescriptorsRequest;
 
 /**
- * Lists monitored resource descriptors that match a filter. This method does not require a Workspace.
+ * Lists monitored resource descriptors that match a filter.
  *
- * @param string $name The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
- *                     which to execute the request. The format is:
+ * @param string $name The
+ *                     [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
+ *                     to execute the request. The format is:
  *
  *                     projects/[PROJECT_ID_OR_NUMBER]
  */

diff --git a/Monitoring/samples/V3/MetricServiceClient/list_time_series.php b/Monitoring/samples/V3/MetricServiceClient/list_time_series.php
@@ -32,19 +32,21 @@
 use Google\Cloud\Monitoring\V3\TimeSeries;
 
 /**
- * Lists time series that match a filter. This method does not require a Workspace.
+ * Lists time series that match a filter.
  *
- * @param string $formattedName The [project](https://cloud.google.com/monitoring/api/v3#project_name),
+ * @param string $formattedName The
+ *                              [project](https://cloud.google.com/monitoring/api/v3#project_name),
  *                              organization or folder on which to execute the request. The format is:
  *
  *                              projects/[PROJECT_ID_OR_NUMBER]
  *                              organizations/[ORGANIZATION_ID]
  *                              folders/[FOLDER_ID]
  *                              Please see {@see MetricServiceClient::workspaceName()} for help formatting this field.
- * @param string $filter        A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
- *                              that specifies which time series should be returned.  The filter must
- *                              specify a single metric type, and can additionally specify metric labels
- *                              and other information. For example:
+ * @param string $filter        A [monitoring
+ *                              filter](https://cloud.google.com/monitoring/api/v3/filters) that specifies
+ *                              which time series should be returned.  The filter must specify a single
+ *                              metric type, and can additionally specify metric labels and other
+ *                              information. For example:
  *
  *                              metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
  *                              metric.labels.instance_name = "my-instance-name"

diff --git a/Monitoring/samples/V3/QueryServiceClient/query_time_series.php b/Monitoring/samples/V3/QueryServiceClient/query_time_series.php
@@ -30,10 +30,11 @@
 use Google\Cloud\Monitoring\V3\TimeSeriesData;
 
 /**
- * Queries time series using Monitoring Query Language. This method does not require a Workspace.
+ * Queries time series using Monitoring Query Language.
  *
- * @param string $name  The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
- *                      which to execute the request. The format is:
+ * @param string $name  The
+ *                      [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
+ *                      to execute the request. The format is:
  *
  *                      projects/[PROJECT_ID_OR_NUMBER]
  * @param string $query The query in the [Monitoring Query

diff --git a/Monitoring/samples/V3/ServiceMonitoringServiceClient/create_service.php b/Monitoring/samples/V3/ServiceMonitoringServiceClient/create_service.php
@@ -31,8 +31,9 @@
 /**
  * Create a `Service`.
  *
- * @param string $parent Resource [name](https://cloud.google.com/monitoring/api/v3#project_name) of
- *                       the parent workspace. The format is:
+ * @param string $parent Resource
+ *                       [name](https://cloud.google.com/monitoring/api/v3#project_name) of the
+ *                       parent Metrics Scope. The format is:
  *
  *                       projects/[PROJECT_ID_OR_NUMBER]
  */

diff --git a/Monitoring/samples/V3/ServiceMonitoringServiceClient/delete_service_level_objective.php b/Monitoring/samples/V3/ServiceMonitoringServiceClient/delete_service_level_objective.php
@@ -30,7 +30,8 @@
 /**
  * Delete the given `ServiceLevelObjective`.
  *
- * @param string $formattedName Resource name of the `ServiceLevelObjective` to delete. The format is:
+ * @param string $formattedName Resource name of the `ServiceLevelObjective` to delete. The
+ *                              format is:
  *
  *                              projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
  *                              Please see {@see ServiceMonitoringServiceClient::serviceLevelObjectiveName()} for help formatting this field.

diff --git a/Monitoring/samples/V3/ServiceMonitoringServiceClient/get_service_level_objective.php b/Monitoring/samples/V3/ServiceMonitoringServiceClient/get_service_level_objective.php
@@ -31,7 +31,8 @@
 /**
  * Get a `ServiceLevelObjective` by name.
  *
- * @param string $formattedName Resource name of the `ServiceLevelObjective` to get. The format is:
+ * @param string $formattedName Resource name of the `ServiceLevelObjective` to get. The format
+ *                              is:
  *
  *                              projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
  *                              Please see {@see ServiceMonitoringServiceClient::serviceLevelObjectiveName()} for help formatting this field.

diff --git a/Monitoring/samples/V3/ServiceMonitoringServiceClient/list_service_level_objectives.php b/Monitoring/samples/V3/ServiceMonitoringServiceClient/list_service_level_objectives.php
@@ -33,7 +33,7 @@
  * List the `ServiceLevelObjective`s for the given `Service`.
  *
  * @param string $formattedParent Resource name of the parent containing the listed SLOs, either a
- *                                project or a Monitoring Workspace. The formats are:
+ *                                project or a Monitoring Metrics Scope. The formats are:
  *
  *                                projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
  *                                workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-

diff --git a/Monitoring/samples/V3/ServiceMonitoringServiceClient/list_services.php b/Monitoring/samples/V3/ServiceMonitoringServiceClient/list_services.php
@@ -30,11 +30,11 @@
 use Google\Cloud\Monitoring\V3\Service;
 
 /**
- * List `Service`s for this workspace.
+ * List `Service`s for this Metrics Scope.
  *
- * @param string $parent Resource name of the parent containing the listed services, either a
- *                       [project](https://cloud.google.com/monitoring/api/v3#project_name) or a
- *                       Monitoring Workspace. The formats are:
+ * @param string $parent Resource name of the parent containing the listed services,
+ *                       either a [project](https://cloud.google.com/monitoring/api/v3#project_name)
+ *                       or a Monitoring Metrics Scope. The formats are:
  *
  *                       projects/[PROJECT_ID_OR_NUMBER]
  *                       workspaces/[HOST_PROJECT_ID_OR_NUMBER]

diff --git a/Monitoring/src/V3/AlertPolicy/Condition/MetricThreshold.php b/Monitoring/src/V3/AlertPolicy/Condition/MetricThreshold.php
diff --git a/Monitoring/src/V3/AlertPolicy/Documentation.php b/Monitoring/src/V3/AlertPolicy/Documentation.php
diff --git a/Monitoring/src/V3/Client/MetricServiceClient.php b/Monitoring/src/V3/Client/MetricServiceClient.php
@@ -423,10 +423,11 @@ public function __call($method, $args)
 
     /**
      * Creates a new metric descriptor.
-     * The creation is executed asynchronously and callers may check the returned
-     * operation to track its progress.
+     * The creation is executed asynchronously.
      * User-created metric descriptors define
      * [custom metrics](https://cloud.google.com/monitoring/custom-metrics).
+     * The metric descriptor is updated if it already exists,
+     * except that metric labels are never removed.
      *
      * The async variant is {@see MetricServiceClient::createMetricDescriptorAsync()} .
      *
@@ -489,6 +490,9 @@ public function createServiceTimeSeries(CreateTimeSeriesRequest $request, array
      * The response is empty if all time series in the request were written.
      * If any time series could not be written, a corresponding failure message is
      * included in the error response.
+     * This method does not support
+     * [resource locations constraint of an organization
+     * policy](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations#setting_the_organization_policy).
      *
      * The async variant is {@see MetricServiceClient::createTimeSeriesAsync()} .
      *
@@ -538,7 +542,7 @@ public function deleteMetricDescriptor(DeleteMetricDescriptorRequest $request, a
     }
 
     /**
-     * Gets a single metric descriptor. This method does not require a Workspace.
+     * Gets a single metric descriptor.
      *
      * The async variant is {@see MetricServiceClient::getMetricDescriptorAsync()} .
      *
@@ -564,7 +568,7 @@ public function getMetricDescriptor(GetMetricDescriptorRequest $request, array $
     }
 
     /**
-     * Gets a single monitored resource descriptor. This method does not require a Workspace.
+     * Gets a single monitored resource descriptor.
      *
      * The async variant is
      * {@see MetricServiceClient::getMonitoredResourceDescriptorAsync()} .
@@ -591,7 +595,7 @@ public function getMonitoredResourceDescriptor(GetMonitoredResourceDescriptorReq
     }
 
     /**
-     * Lists metric descriptors that match a filter. This method does not require a Workspace.
+     * Lists metric descriptors that match a filter.
      *
      * The async variant is {@see MetricServiceClient::listMetricDescriptorsAsync()} .
      *
@@ -617,7 +621,7 @@ public function listMetricDescriptors(ListMetricDescriptorsRequest $request, arr
     }
 
     /**
-     * Lists monitored resource descriptors that match a filter. This method does not require a Workspace.
+     * Lists monitored resource descriptors that match a filter.
      *
      * The async variant is
      * {@see MetricServiceClient::listMonitoredResourceDescriptorsAsync()} .
@@ -644,7 +648,7 @@ public function listMonitoredResourceDescriptors(ListMonitoredResourceDescriptor
     }
 
     /**
-     * Lists time series that match a filter. This method does not require a Workspace.
+     * Lists time series that match a filter.
      *
      * The async variant is {@see MetricServiceClient::listTimeSeriesAsync()} .
      *

diff --git a/Monitoring/src/V3/Client/QueryServiceClient.php b/Monitoring/src/V3/Client/QueryServiceClient.php
@@ -36,7 +36,7 @@
 use GuzzleHttp\Promise\PromiseInterface;
 
 /**
- * Service Description: The QueryService API is used to manage time series data in Stackdriver
+ * Service Description: The QueryService API is used to manage time series data in Cloud
  * Monitoring. Time series data is a collection of data points that describes
  * the time-varying values of a metric.
  *
@@ -166,7 +166,7 @@ public function __call($method, $args)
     }
 
     /**
-     * Queries time series using Monitoring Query Language. This method does not require a Workspace.
+     * Queries time series using Monitoring Query Language.
      *
      * The async variant is {@see QueryServiceClient::queryTimeSeriesAsync()} .
      *