diff --git a/Monitoring/metadata/V3/QueryService.php b/Monitoring/metadata/V3/QueryService.php index 9c53d1193e14..fb4ffd3bc28d 100644 --- a/Monitoring/metadata/V3/QueryService.php +++ b/Monitoring/metadata/V3/QueryService.php @@ -15,12 +15,12 @@ public static function initOnce() { return; } \GPBMetadata\Google\Api\Annotations::initOnce(); - \GPBMetadata\Google\Monitoring\V3\MetricService::initOnce(); \GPBMetadata\Google\Api\Client::initOnce(); + \GPBMetadata\Google\Monitoring\V3\MetricService::initOnce(); $pool->internalAddGeneratedFile( ' ¼ -(google/monitoring/v3/query_service.protogoogle.monitoring.v3)google/monitoring/v3/metric_service.protogoogle/api/client.proto2Þ +(google/monitoring/v3/query_service.protogoogle.monitoring.v3google/api/client.proto)google/monitoring/v3/metric_service.proto2Þ QueryService¡ QueryTimeSeries,.google.monitoring.v3.QueryTimeSeriesRequest-.google.monitoring.v3.QueryTimeSeriesResponse"1‚Óä“+"&/v3/{name=projects/*}/timeSeries:query:*©ÊAmonitoring.googleapis.comÒA‰https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/monitoring,https://www.googleapis.com/auth/monitoring.readBÌ com.google.monitoring.v3BQueryServiceProtoPZAcloud.google.com/go/monitoring/apiv3/v2/monitoringpb;monitoringpbªGoogle.Cloud.Monitoring.V3ÊGoogle\\Cloud\\Monitoring\\V3êGoogle::Cloud::Monitoring::V3bproto3' diff --git a/Monitoring/samples/V3/GroupServiceClient/create_group.php b/Monitoring/samples/V3/GroupServiceClient/create_group.php index 4953ccecd48b..8a1a90022d25 100644 --- 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 index a3163d527f75..9824913c1906 100644 --- 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 index eb3f9be5c9a1..6bd13a39d0f9 100644 --- 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 index db344b7c17e7..598599ca2956 100644 --- 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 index 530044e80e9c..419488c9c128 100644 --- 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 index 30db5fe24e7b..538faf02b3b3 100644 --- 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 index ffc75671b31e..4913db2b07bd 100644 --- 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 index d4a3b1b36b6e..05b69a6ca05c 100644 --- 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 index 26d849faaa28..476bec0cbdca 100644 --- 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 index a36f8135a3cd..f4e75cb9811d 100644 --- 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 index 5e2f4c21d744..83960d35fa49 100644 --- 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 index e3db84e1685b..3f8272a75e9b 100644 --- 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 index 92d46e77dc16..8add387c880a 100644 --- 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 index 764eb5e72d05..739ce6177f4f 100644 --- 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 index eceb135a0533..e2ec5ada72ce 100644 --- 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 index 493891218a90..7ae396e0621f 100644 --- 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 index 71537bd274ba..3fdc2d333216 100644 --- 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 index 4669c0e483cd..24a90b27adea 100644 --- a/Monitoring/src/V3/AlertPolicy/Condition/MetricThreshold.php +++ b/Monitoring/src/V3/AlertPolicy/Condition/MetricThreshold.php @@ -127,7 +127,8 @@ class MetricThreshold extends \Google\Protobuf\Internal\Message private $trigger = null; /** * A condition control that determines how metric-threshold conditions - * are evaluated when data stops arriving. + * are evaluated when data stops arriving. To use this control, the value + * of the `duration` field must be greater than or equal to 60 seconds. * * Generated from protobuf field .google.monitoring.v3.AlertPolicy.Condition.EvaluationMissingData evaluation_missing_data = 11; */ @@ -214,7 +215,8 @@ class MetricThreshold extends \Google\Protobuf\Internal\Message * are specified. * @type int $evaluation_missing_data * A condition control that determines how metric-threshold conditions - * are evaluated when data stops arriving. + * are evaluated when data stops arriving. To use this control, the value + * of the `duration` field must be greater than or equal to 60 seconds. * } */ public function __construct($data = NULL) { @@ -598,7 +600,8 @@ public function setTrigger($var) /** * A condition control that determines how metric-threshold conditions - * are evaluated when data stops arriving. + * are evaluated when data stops arriving. To use this control, the value + * of the `duration` field must be greater than or equal to 60 seconds. * * Generated from protobuf field .google.monitoring.v3.AlertPolicy.Condition.EvaluationMissingData evaluation_missing_data = 11; * @return int @@ -610,7 +613,8 @@ public function getEvaluationMissingData() /** * A condition control that determines how metric-threshold conditions - * are evaluated when data stops arriving. + * are evaluated when data stops arriving. To use this control, the value + * of the `duration` field must be greater than or equal to 60 seconds. * * Generated from protobuf field .google.monitoring.v3.AlertPolicy.Condition.EvaluationMissingData evaluation_missing_data = 11; * @param int $var diff --git a/Monitoring/src/V3/AlertPolicy/Documentation.php b/Monitoring/src/V3/AlertPolicy/Documentation.php index b76d3a9d11f5..f5ee62c1c8e2 100644 --- a/Monitoring/src/V3/AlertPolicy/Documentation.php +++ b/Monitoring/src/V3/AlertPolicy/Documentation.php @@ -9,8 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * A content string and a MIME type that describes the content string's - * format. + * Documentation that is included in the notifications and incidents + * pertaining to this policy. * * Generated from protobuf message google.monitoring.v3.AlertPolicy.Documentation */ diff --git a/Monitoring/src/V3/Client/MetricServiceClient.php b/Monitoring/src/V3/Client/MetricServiceClient.php index 545fc28600b3..768b64becf4d 100644 --- 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 index eaf902d1ac70..747ac7297018 100644 --- 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()} . * diff --git a/Monitoring/src/V3/Client/ServiceMonitoringServiceClient.php b/Monitoring/src/V3/Client/ServiceMonitoringServiceClient.php index 67cafe33953b..d45da317e3a0 100644 --- a/Monitoring/src/V3/Client/ServiceMonitoringServiceClient.php +++ b/Monitoring/src/V3/Client/ServiceMonitoringServiceClient.php @@ -49,9 +49,9 @@ /** * Service Description: The Cloud Monitoring Service-Oriented Monitoring API has endpoints for - * managing and querying aspects of a workspace's services. These include the - * `Service`'s monitored resources, its Service-Level Objectives, and a taxonomy - * of categorized Health Metrics. + * managing and querying aspects of a Metrics Scope's services. These include + * the `Service`'s monitored resources, its Service-Level Objectives, and a + * taxonomy of categorized Health Metrics. * * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. @@ -553,7 +553,7 @@ public function listServiceLevelObjectives(ListServiceLevelObjectivesRequest $re } /** - * List `Service`s for this workspace. + * List `Service`s for this Metrics Scope. * * The async variant is {@see ServiceMonitoringServiceClient::listServicesAsync()} * . diff --git a/Monitoring/src/V3/CreateGroupRequest.php b/Monitoring/src/V3/CreateGroupRequest.php index 5ddfdf2983b6..da3b15c245e6 100644 --- a/Monitoring/src/V3/CreateGroupRequest.php +++ b/Monitoring/src/V3/CreateGroupRequest.php @@ -16,16 +16,17 @@ class CreateGroupRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in - * which to create the group. The format is: + * Required. 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] * * Generated from protobuf field string name = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ private $name = ''; /** - * Required. A group definition. It is an error to define the `name` field because - * the system assigns the name. + * Required. A group definition. It is an error to define the `name` field + * because the system assigns the name. * * Generated from protobuf field .google.monitoring.v3.Group group = 2 [(.google.api.field_behavior) = REQUIRED]; */ @@ -38,12 +39,13 @@ class CreateGroupRequest extends \Google\Protobuf\Internal\Message private $validate_only = false; /** - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in - * which to create the group. The format is: + * @param string $name Required. 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] - * @param \Google\Cloud\Monitoring\V3\Group $group Required. A group definition. It is an error to define the `name` field because - * the system assigns the name. + * @param \Google\Cloud\Monitoring\V3\Group $group Required. A group definition. It is an error to define the `name` field + * because the system assigns the name. * * @return \Google\Cloud\Monitoring\V3\CreateGroupRequest * @@ -63,12 +65,13 @@ public static function build(string $name, \Google\Cloud\Monitoring\V3\Group $gr * Optional. Data for populating the Message object. * * @type string $name - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in - * which to create the group. The format is: + * Required. 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] * @type \Google\Cloud\Monitoring\V3\Group $group - * Required. A group definition. It is an error to define the `name` field because - * the system assigns the name. + * Required. A group definition. It is an error to define the `name` field + * because the system assigns the name. * @type bool $validate_only * If true, validate this request but do not create the group. * } @@ -79,8 +82,9 @@ public function __construct($data = NULL) { } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in - * which to create the group. The format is: + * Required. 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] * * Generated from protobuf field string name = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -92,8 +96,9 @@ public function getName() } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in - * which to create the group. The format is: + * Required. 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] * * Generated from protobuf field string name = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -109,8 +114,8 @@ public function setName($var) } /** - * Required. A group definition. It is an error to define the `name` field because - * the system assigns the name. + * Required. A group definition. It is an error to define the `name` field + * because the system assigns the name. * * Generated from protobuf field .google.monitoring.v3.Group group = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\Monitoring\V3\Group|null @@ -131,8 +136,8 @@ public function clearGroup() } /** - * Required. A group definition. It is an error to define the `name` field because - * the system assigns the name. + * Required. A group definition. It is an error to define the `name` field + * because the system assigns the name. * * Generated from protobuf field .google.monitoring.v3.Group group = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\Monitoring\V3\Group $var diff --git a/Monitoring/src/V3/CreateMetricDescriptorRequest.php b/Monitoring/src/V3/CreateMetricDescriptorRequest.php index 050fa446956e..7fc72af2e7df 100644 --- a/Monitoring/src/V3/CreateMetricDescriptorRequest.php +++ b/Monitoring/src/V3/CreateMetricDescriptorRequest.php @@ -16,8 +16,9 @@ class CreateMetricDescriptorRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * @@ -25,20 +26,21 @@ class CreateMetricDescriptorRequest extends \Google\Protobuf\Internal\Message */ private $name = ''; /** - * Required. The new [custom metric](https://cloud.google.com/monitoring/custom-metrics) - * descriptor. + * Required. The new [custom + * metric](https://cloud.google.com/monitoring/custom-metrics) descriptor. * * Generated from protobuf field .google.api.MetricDescriptor metric_descriptor = 2 [(.google.api.field_behavior) = REQUIRED]; */ private $metric_descriptor = null; /** - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * @param string $name Required. 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] - * @param \Google\Api\MetricDescriptor $metricDescriptor Required. The new [custom metric](https://cloud.google.com/monitoring/custom-metrics) - * descriptor. + * @param \Google\Api\MetricDescriptor $metricDescriptor Required. The new [custom + * metric](https://cloud.google.com/monitoring/custom-metrics) descriptor. * * @return \Google\Cloud\Monitoring\V3\CreateMetricDescriptorRequest * @@ -58,13 +60,14 @@ public static function build(string $name, \Google\Api\MetricDescriptor $metricD * Optional. Data for populating the Message object. * * @type string $name - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * @type \Google\Api\MetricDescriptor $metric_descriptor - * Required. The new [custom metric](https://cloud.google.com/monitoring/custom-metrics) - * descriptor. + * Required. The new [custom + * metric](https://cloud.google.com/monitoring/custom-metrics) descriptor. * } */ public function __construct($data = NULL) { @@ -73,8 +76,9 @@ public function __construct($data = NULL) { } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * @@ -87,8 +91,9 @@ public function getName() } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * @@ -105,8 +110,8 @@ public function setName($var) } /** - * Required. The new [custom metric](https://cloud.google.com/monitoring/custom-metrics) - * descriptor. + * Required. The new [custom + * metric](https://cloud.google.com/monitoring/custom-metrics) descriptor. * * Generated from protobuf field .google.api.MetricDescriptor metric_descriptor = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Api\MetricDescriptor|null @@ -127,8 +132,8 @@ public function clearMetricDescriptor() } /** - * Required. The new [custom metric](https://cloud.google.com/monitoring/custom-metrics) - * descriptor. + * Required. The new [custom + * metric](https://cloud.google.com/monitoring/custom-metrics) descriptor. * * Generated from protobuf field .google.api.MetricDescriptor metric_descriptor = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Api\MetricDescriptor $var diff --git a/Monitoring/src/V3/CreateServiceLevelObjectiveRequest.php b/Monitoring/src/V3/CreateServiceLevelObjectiveRequest.php index da1d61558c40..5a1e46c56934 100644 --- a/Monitoring/src/V3/CreateServiceLevelObjectiveRequest.php +++ b/Monitoring/src/V3/CreateServiceLevelObjectiveRequest.php @@ -25,7 +25,7 @@ class CreateServiceLevelObjectiveRequest extends \Google\Protobuf\Internal\Messa /** * Optional. The ServiceLevelObjective id to use for this * ServiceLevelObjective. If omitted, an id will be generated instead. Must - * match the pattern `[a-z0-9\-]+` + * match the pattern `^[a-zA-Z0-9-_:.]+$` * * Generated from protobuf field string service_level_objective_id = 3; */ @@ -71,7 +71,7 @@ public static function build(string $parent, \Google\Cloud\Monitoring\V3\Service * @type string $service_level_objective_id * Optional. The ServiceLevelObjective id to use for this * ServiceLevelObjective. If omitted, an id will be generated instead. Must - * match the pattern `[a-z0-9\-]+` + * match the pattern `^[a-zA-Z0-9-_:.]+$` * @type \Google\Cloud\Monitoring\V3\ServiceLevelObjective $service_level_objective * Required. The `ServiceLevelObjective` to create. * The provided `name` will be respected if no `ServiceLevelObjective` exists @@ -114,7 +114,7 @@ public function setParent($var) /** * Optional. The ServiceLevelObjective id to use for this * ServiceLevelObjective. If omitted, an id will be generated instead. Must - * match the pattern `[a-z0-9\-]+` + * match the pattern `^[a-zA-Z0-9-_:.]+$` * * Generated from protobuf field string service_level_objective_id = 3; * @return string @@ -127,7 +127,7 @@ public function getServiceLevelObjectiveId() /** * Optional. The ServiceLevelObjective id to use for this * ServiceLevelObjective. If omitted, an id will be generated instead. Must - * match the pattern `[a-z0-9\-]+` + * match the pattern `^[a-zA-Z0-9-_:.]+$` * * Generated from protobuf field string service_level_objective_id = 3; * @param string $var diff --git a/Monitoring/src/V3/CreateServiceRequest.php b/Monitoring/src/V3/CreateServiceRequest.php index 97d782da716d..de39b2357f38 100644 --- a/Monitoring/src/V3/CreateServiceRequest.php +++ b/Monitoring/src/V3/CreateServiceRequest.php @@ -16,8 +16,9 @@ class CreateServiceRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Resource [name](https://cloud.google.com/monitoring/api/v3#project_name) of - * the parent workspace. The format is: + * Required. Resource + * [name](https://cloud.google.com/monitoring/api/v3#project_name) of the + * parent Metrics Scope. The format is: * projects/[PROJECT_ID_OR_NUMBER] * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -38,8 +39,9 @@ class CreateServiceRequest extends \Google\Protobuf\Internal\Message private $service = null; /** - * @param string $parent Required. Resource [name](https://cloud.google.com/monitoring/api/v3#project_name) of - * the parent workspace. The format is: + * @param string $parent Required. Resource + * [name](https://cloud.google.com/monitoring/api/v3#project_name) of the + * parent Metrics Scope. The format is: * * projects/[PROJECT_ID_OR_NUMBER] * @param \Google\Cloud\Monitoring\V3\Service $service Required. The `Service` to create. @@ -62,8 +64,9 @@ public static function build(string $parent, \Google\Cloud\Monitoring\V3\Service * Optional. Data for populating the Message object. * * @type string $parent - * Required. Resource [name](https://cloud.google.com/monitoring/api/v3#project_name) of - * the parent workspace. The format is: + * Required. Resource + * [name](https://cloud.google.com/monitoring/api/v3#project_name) of the + * parent Metrics Scope. The format is: * projects/[PROJECT_ID_OR_NUMBER] * @type string $service_id * Optional. The Service id to use for this Service. If omitted, an id will be @@ -78,8 +81,9 @@ public function __construct($data = NULL) { } /** - * Required. Resource [name](https://cloud.google.com/monitoring/api/v3#project_name) of - * the parent workspace. The format is: + * Required. Resource + * [name](https://cloud.google.com/monitoring/api/v3#project_name) of the + * parent Metrics Scope. The format is: * projects/[PROJECT_ID_OR_NUMBER] * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -91,8 +95,9 @@ public function getParent() } /** - * Required. Resource [name](https://cloud.google.com/monitoring/api/v3#project_name) of - * the parent workspace. The format is: + * Required. Resource + * [name](https://cloud.google.com/monitoring/api/v3#project_name) of the + * parent Metrics Scope. The format is: * projects/[PROJECT_ID_OR_NUMBER] * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/Monitoring/src/V3/CreateTimeSeriesRequest.php b/Monitoring/src/V3/CreateTimeSeriesRequest.php index 1da2e80f2aa5..783056dd8aa6 100644 --- a/Monitoring/src/V3/CreateTimeSeriesRequest.php +++ b/Monitoring/src/V3/CreateTimeSeriesRequest.php @@ -16,8 +16,9 @@ class CreateTimeSeriesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -36,8 +37,9 @@ class CreateTimeSeriesRequest extends \Google\Protobuf\Internal\Message private $time_series; /** - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * @param string $name Required. 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. @@ -67,8 +69,9 @@ public static function build(string $name, array $timeSeries): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * @type array<\Google\Cloud\Monitoring\V3\TimeSeries>|\Google\Protobuf\Internal\RepeatedField $time_series * Required. The new data to be added to a list of time series. @@ -85,8 +88,9 @@ public function __construct($data = NULL) { } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -98,8 +102,9 @@ public function getName() } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/Monitoring/src/V3/DeleteMetricDescriptorRequest.php b/Monitoring/src/V3/DeleteMetricDescriptorRequest.php index e77fea1c80ab..3073c5261b98 100644 --- a/Monitoring/src/V3/DeleteMetricDescriptorRequest.php +++ b/Monitoring/src/V3/DeleteMetricDescriptorRequest.php @@ -16,7 +16,8 @@ class DeleteMetricDescriptorRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The metric descriptor on which to execute the request. The format is: + * Required. The metric descriptor on which to execute the request. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * An example of `[METRIC_ID]` is: * `"custom.googleapis.com/my_test_metric"`. @@ -26,7 +27,8 @@ class DeleteMetricDescriptorRequest extends \Google\Protobuf\Internal\Message private $name = ''; /** - * @param string $name Required. The metric descriptor on which to execute the request. The format is: + * @param string $name Required. The metric descriptor on which to execute the request. The format + * is: * * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * @@ -51,7 +53,8 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The metric descriptor on which to execute the request. The format is: + * Required. The metric descriptor on which to execute the request. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * An example of `[METRIC_ID]` is: * `"custom.googleapis.com/my_test_metric"`. @@ -63,7 +66,8 @@ public function __construct($data = NULL) { } /** - * Required. The metric descriptor on which to execute the request. The format is: + * Required. The metric descriptor on which to execute the request. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * An example of `[METRIC_ID]` is: * `"custom.googleapis.com/my_test_metric"`. @@ -77,7 +81,8 @@ public function getName() } /** - * Required. The metric descriptor on which to execute the request. The format is: + * Required. The metric descriptor on which to execute the request. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * An example of `[METRIC_ID]` is: * `"custom.googleapis.com/my_test_metric"`. diff --git a/Monitoring/src/V3/DeleteServiceLevelObjectiveRequest.php b/Monitoring/src/V3/DeleteServiceLevelObjectiveRequest.php index 42450ed2b8c0..8f402e110815 100644 --- a/Monitoring/src/V3/DeleteServiceLevelObjectiveRequest.php +++ b/Monitoring/src/V3/DeleteServiceLevelObjectiveRequest.php @@ -16,7 +16,8 @@ class DeleteServiceLevelObjectiveRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Resource name of the `ServiceLevelObjective` to delete. The format is: + * Required. Resource name of the `ServiceLevelObjective` to delete. The + * format is: * projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -24,7 +25,8 @@ class DeleteServiceLevelObjectiveRequest extends \Google\Protobuf\Internal\Messa private $name = ''; /** - * @param string $name Required. Resource name of the `ServiceLevelObjective` to delete. The format is: + * @param string $name Required. 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. @@ -46,7 +48,8 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. Resource name of the `ServiceLevelObjective` to delete. The format is: + * Required. Resource name of the `ServiceLevelObjective` to delete. The + * format is: * projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * } */ @@ -56,7 +59,8 @@ public function __construct($data = NULL) { } /** - * Required. Resource name of the `ServiceLevelObjective` to delete. The format is: + * Required. Resource name of the `ServiceLevelObjective` to delete. The + * format is: * projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -68,7 +72,8 @@ public function getName() } /** - * Required. Resource name of the `ServiceLevelObjective` to delete. The format is: + * Required. Resource name of the `ServiceLevelObjective` to delete. The + * format is: * projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/Monitoring/src/V3/Gapic/GroupServiceGapicClient.php b/Monitoring/src/V3/Gapic/GroupServiceGapicClient.php index b5c257d69f46..3cef0b7effc8 100644 --- a/Monitoring/src/V3/Gapic/GroupServiceGapicClient.php +++ b/Monitoring/src/V3/Gapic/GroupServiceGapicClient.php @@ -376,12 +376,13 @@ public function __construct(array $options = []) * } * ``` * - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in - * which to create the group. The format is: + * @param string $name Required. 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] - * @param Group $group Required. A group definition. It is an error to define the `name` field because - * the system assigns the name. + * @param Group $group Required. A group definition. It is an error to define the `name` field + * because the system assigns the name. * @param array $optionalArgs { * Optional. * @@ -619,8 +620,9 @@ public function listGroupMembers($name, array $optionalArgs = []) * } * ``` * - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) - * whose groups are to be listed. The format is: + * @param string $name Required. 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] * @param array $optionalArgs { @@ -715,8 +717,9 @@ public function listGroups($name, array $optionalArgs = []) * } * ``` * - * @param Group $group Required. The new definition of the group. All fields of the existing group, - * excepting `name`, are replaced with the corresponding fields of this group. + * @param Group $group Required. The new definition of the group. All fields of the existing + * group, excepting `name`, are replaced with the corresponding fields of this + * group. * @param array $optionalArgs { * Optional. * diff --git a/Monitoring/src/V3/Gapic/MetricServiceGapicClient.php b/Monitoring/src/V3/Gapic/MetricServiceGapicClient.php index 47049fc615da..00bf31992651 100644 --- a/Monitoring/src/V3/Gapic/MetricServiceGapicClient.php +++ b/Monitoring/src/V3/Gapic/MetricServiceGapicClient.php @@ -593,10 +593,11 @@ public function __construct(array $options = []) /** * 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. * * Sample code: * ``` @@ -610,12 +611,13 @@ public function __construct(array $options = []) * } * ``` * - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * @param string $name Required. 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] - * @param MetricDescriptor $metricDescriptor Required. The new [custom metric](https://cloud.google.com/monitoring/custom-metrics) - * descriptor. + * @param MetricDescriptor $metricDescriptor Required. The new [custom + * metric](https://cloud.google.com/monitoring/custom-metrics) descriptor. * @param array $optionalArgs { * Optional. * @@ -664,8 +666,9 @@ public function createMetricDescriptor($name, $metricDescriptor, array $optional * } * ``` * - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * @param string $name Required. 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 TimeSeries[] $timeSeries Required. The new data to be added to a list of time series. @@ -703,6 +706,9 @@ public function createServiceTimeSeries($name, $timeSeries, array $optionalArgs * 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). * * Sample code: * ``` @@ -716,8 +722,9 @@ public function createServiceTimeSeries($name, $timeSeries, array $optionalArgs * } * ``` * - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * @param string $name Required. 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 TimeSeries[] $timeSeries Required. The new data to be added to a list of time series. @@ -766,7 +773,8 @@ public function createTimeSeries($name, $timeSeries, array $optionalArgs = []) * } * ``` * - * @param string $name Required. The metric descriptor on which to execute the request. The format is: + * @param string $name Required. The metric descriptor on which to execute the request. The format + * is: * * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * @@ -795,7 +803,7 @@ public function deleteMetricDescriptor($name, array $optionalArgs = []) } /** - * Gets a single metric descriptor. This method does not require a Workspace. + * Gets a single metric descriptor. * * Sample code: * ``` @@ -808,7 +816,8 @@ public function deleteMetricDescriptor($name, array $optionalArgs = []) * } * ``` * - * @param string $name Required. The metric descriptor on which to execute the request. The format is: + * @param string $name Required. The metric descriptor on which to execute the request. The format + * is: * * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * @@ -839,7 +848,7 @@ public function getMetricDescriptor($name, array $optionalArgs = []) } /** - * Gets a single monitored resource descriptor. This method does not require a Workspace. + * Gets a single monitored resource descriptor. * * Sample code: * ``` @@ -883,7 +892,7 @@ public function getMonitoredResourceDescriptor($name, array $optionalArgs = []) } /** - * Lists metric descriptors that match a filter. This method does not require a Workspace. + * Lists metric descriptors that match a filter. * * Sample code: * ``` @@ -908,8 +917,9 @@ public function getMonitoredResourceDescriptor($name, array $optionalArgs = []) * } * ``` * - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * @param string $name Required. 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 array $optionalArgs { @@ -967,7 +977,7 @@ public function listMetricDescriptors($name, array $optionalArgs = []) } /** - * Lists monitored resource descriptors that match a filter. This method does not require a Workspace. + * Lists monitored resource descriptors that match a filter. * * Sample code: * ``` @@ -992,8 +1002,9 @@ public function listMetricDescriptors($name, array $optionalArgs = []) * } * ``` * - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * @param string $name Required. 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 array $optionalArgs { @@ -1049,7 +1060,7 @@ public function listMonitoredResourceDescriptors($name, array $optionalArgs = [] } /** - * Lists time series that match a filter. This method does not require a Workspace. + * Lists time series that match a filter. * * Sample code: * ``` @@ -1077,22 +1088,24 @@ public function listMonitoredResourceDescriptors($name, array $optionalArgs = [] * } * ``` * - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name), + * @param string $name Required. 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] - * @param string $filter Required. 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 Required. 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" - * @param TimeInterval $interval Required. The time interval for which results should be returned. Only time series - * that contain data points in the specified interval are included - * in the response. + * @param TimeInterval $interval Required. The time interval for which results should be returned. Only time + * series that contain data points in the specified interval are included in + * the response. * @param int $view Required. Specifies which information is returned about the time series. * For allowed values, use constants defined on {@see \Google\Cloud\Monitoring\V3\ListTimeSeriesRequest\TimeSeriesView} * @param array $optionalArgs { diff --git a/Monitoring/src/V3/Gapic/QueryServiceGapicClient.php b/Monitoring/src/V3/Gapic/QueryServiceGapicClient.php index 225861575f43..cd386575a623 100644 --- a/Monitoring/src/V3/Gapic/QueryServiceGapicClient.php +++ b/Monitoring/src/V3/Gapic/QueryServiceGapicClient.php @@ -36,7 +36,7 @@ use Google\Cloud\Monitoring\V3\QueryTimeSeriesResponse; /** - * 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. * @@ -178,7 +178,7 @@ public function __construct(array $options = []) } /** - * Queries time series using Monitoring Query Language. This method does not require a Workspace. + * Queries time series using Monitoring Query Language. * * Sample code: * ``` @@ -204,8 +204,9 @@ public function __construct(array $options = []) * } * ``` * - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * @param string $name Required. 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 Required. The query in the [Monitoring Query diff --git a/Monitoring/src/V3/Gapic/ServiceMonitoringServiceGapicClient.php b/Monitoring/src/V3/Gapic/ServiceMonitoringServiceGapicClient.php index d837f556bc80..cbcf467f943b 100644 --- a/Monitoring/src/V3/Gapic/ServiceMonitoringServiceGapicClient.php +++ b/Monitoring/src/V3/Gapic/ServiceMonitoringServiceGapicClient.php @@ -53,9 +53,9 @@ /** * Service Description: The Cloud Monitoring Service-Oriented Monitoring API has endpoints for - * managing and querying aspects of a workspace's services. These include the - * `Service`'s monitored resources, its Service-Level Objectives, and a taxonomy - * of categorized Health Metrics. + * managing and querying aspects of a Metrics Scope's services. These include + * the `Service`'s monitored resources, its Service-Level Objectives, and a + * taxonomy of categorized Health Metrics. * * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. Sample code to get started: @@ -502,8 +502,9 @@ public function __construct(array $options = []) * } * ``` * - * @param string $parent Required. Resource [name](https://cloud.google.com/monitoring/api/v3#project_name) of - * the parent workspace. The format is: + * @param string $parent Required. Resource + * [name](https://cloud.google.com/monitoring/api/v3#project_name) of the + * parent Metrics Scope. The format is: * * projects/[PROJECT_ID_OR_NUMBER] * @param Service $service Required. The `Service` to create. @@ -566,7 +567,7 @@ public function createService($parent, $service, array $optionalArgs = []) * @type string $serviceLevelObjectiveId * Optional. The ServiceLevelObjective id to use for this * ServiceLevelObjective. If omitted, an id will be generated instead. Must - * match the pattern `[a-z0-9\-]+` + * match the pattern `^[a-zA-Z0-9-_:.]+$` * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on @@ -646,7 +647,8 @@ public function deleteService($name, array $optionalArgs = []) * } * ``` * - * @param string $name Required. Resource name of the `ServiceLevelObjective` to delete. The format is: + * @param string $name Required. Resource name of the `ServiceLevelObjective` to delete. The + * format is: * * projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * @param array $optionalArgs { @@ -726,7 +728,8 @@ public function getService($name, array $optionalArgs = []) * } * ``` * - * @param string $name Required. Resource name of the `ServiceLevelObjective` to get. The format is: + * @param string $name Required. Resource name of the `ServiceLevelObjective` to get. The format + * is: * * projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * @param array $optionalArgs { @@ -790,7 +793,7 @@ public function getServiceLevelObjective($name, array $optionalArgs = []) * ``` * * @param string $parent Required. 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/- @@ -852,7 +855,7 @@ public function listServiceLevelObjectives($parent, array $optionalArgs = []) } /** - * List `Service`s for this workspace. + * List `Service`s for this Metrics Scope. * * Sample code: * ``` @@ -877,9 +880,9 @@ public function listServiceLevelObjectives($parent, array $optionalArgs = []) * } * ``` * - * @param string $parent Required. 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 Required. 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] @@ -887,25 +890,24 @@ public function listServiceLevelObjectives($parent, array $optionalArgs = []) * Optional. * * @type string $filter - * A filter specifying what `Service`s to return. The filter currently - * supports the following fields: - * - * - `identifier_case` - * - `app_engine.module_id` - * - `cloud_endpoints.service` (reserved for future use) - * - `mesh_istio.mesh_uid` - * - `mesh_istio.service_namespace` - * - `mesh_istio.service_name` - * - `cluster_istio.location` (deprecated) - * - `cluster_istio.cluster_name` (deprecated) - * - `cluster_istio.service_namespace` (deprecated) - * - `cluster_istio.service_name` (deprecated) - * - * `identifier_case` refers to which option in the identifier oneof is - * populated. For example, the filter `identifier_case = "CUSTOM"` would match - * all services with a value for the `custom` field. Valid options are - * "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated) - * and "CLOUD_ENDPOINTS" (reserved for future use). + * A filter specifying what `Service`s to return. The filter supports + * filtering on a particular service-identifier type or one of its attributes. + * + * To filter on a particular service-identifier type, the `identifier_case` + * refers to which option in the `identifier` field is populated. For example, + * the filter `identifier_case = "CUSTOM"` would match all services with a + * value for the `custom` field. Valid options include "CUSTOM", "APP_ENGINE", + * "MESH_ISTIO", and the other options listed at + * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service + * + * To filter on an attribute of a service-identifier type, apply the filter + * name by using the snake case of the service-identifier type and the + * attribute of that service-identifier type, and join the two with a period. + * For example, to filter by the `meshUid` field of the `MeshIstio` + * service-identifier type, you must filter on `mesh_istio.mesh_uid = + * "123"` to match all services with mesh UID "123". Service-identifier types + * and their attributes are described at + * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service * @type int $pageSize * The maximum number of resources contained in the underlying API * response. The API may return fewer values in a page, even if diff --git a/Monitoring/src/V3/GetMetricDescriptorRequest.php b/Monitoring/src/V3/GetMetricDescriptorRequest.php index c4113dd41daa..d079c76ee2c6 100644 --- a/Monitoring/src/V3/GetMetricDescriptorRequest.php +++ b/Monitoring/src/V3/GetMetricDescriptorRequest.php @@ -16,7 +16,8 @@ class GetMetricDescriptorRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The metric descriptor on which to execute the request. The format is: + * Required. The metric descriptor on which to execute the request. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * An example value of `[METRIC_ID]` is * `"compute.googleapis.com/instance/disk/read_bytes_count"`. @@ -26,7 +27,8 @@ class GetMetricDescriptorRequest extends \Google\Protobuf\Internal\Message private $name = ''; /** - * @param string $name Required. The metric descriptor on which to execute the request. The format is: + * @param string $name Required. The metric descriptor on which to execute the request. The format + * is: * * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * @@ -51,7 +53,8 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The metric descriptor on which to execute the request. The format is: + * Required. The metric descriptor on which to execute the request. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * An example value of `[METRIC_ID]` is * `"compute.googleapis.com/instance/disk/read_bytes_count"`. @@ -63,7 +66,8 @@ public function __construct($data = NULL) { } /** - * Required. The metric descriptor on which to execute the request. The format is: + * Required. The metric descriptor on which to execute the request. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * An example value of `[METRIC_ID]` is * `"compute.googleapis.com/instance/disk/read_bytes_count"`. @@ -77,7 +81,8 @@ public function getName() } /** - * Required. The metric descriptor on which to execute the request. The format is: + * Required. The metric descriptor on which to execute the request. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] * An example value of `[METRIC_ID]` is * `"compute.googleapis.com/instance/disk/read_bytes_count"`. diff --git a/Monitoring/src/V3/GetServiceLevelObjectiveRequest.php b/Monitoring/src/V3/GetServiceLevelObjectiveRequest.php index ac5f7784e21a..aec4619ddfaa 100644 --- a/Monitoring/src/V3/GetServiceLevelObjectiveRequest.php +++ b/Monitoring/src/V3/GetServiceLevelObjectiveRequest.php @@ -16,7 +16,8 @@ class GetServiceLevelObjectiveRequest extends \Google\Protobuf\Internal\Message { /** - * Required. Resource name of the `ServiceLevelObjective` to get. The format is: + * Required. Resource name of the `ServiceLevelObjective` to get. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -33,7 +34,8 @@ class GetServiceLevelObjectiveRequest extends \Google\Protobuf\Internal\Message private $view = 0; /** - * @param string $name Required. Resource name of the `ServiceLevelObjective` to get. The format is: + * @param string $name Required. 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. @@ -55,7 +57,8 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. Resource name of the `ServiceLevelObjective` to get. The format is: + * Required. Resource name of the `ServiceLevelObjective` to get. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * @type int $view * View of the `ServiceLevelObjective` to return. If `DEFAULT`, return the @@ -70,7 +73,8 @@ public function __construct($data = NULL) { } /** - * Required. Resource name of the `ServiceLevelObjective` to get. The format is: + * Required. Resource name of the `ServiceLevelObjective` to get. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -82,7 +86,8 @@ public function getName() } /** - * Required. Resource name of the `ServiceLevelObjective` to get. The format is: + * Required. Resource name of the `ServiceLevelObjective` to get. The format + * is: * projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/Monitoring/src/V3/ListGroupsRequest.php b/Monitoring/src/V3/ListGroupsRequest.php index ec98c867f53b..0e3a7bd47bd6 100644 --- a/Monitoring/src/V3/ListGroupsRequest.php +++ b/Monitoring/src/V3/ListGroupsRequest.php @@ -16,8 +16,9 @@ class ListGroupsRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) - * whose groups are to be listed. The format is: + * Required. 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] * * Generated from protobuf field string name = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -40,8 +41,9 @@ class ListGroupsRequest extends \Google\Protobuf\Internal\Message protected $filter; /** - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) - * whose groups are to be listed. The format is: + * @param string $name Required. 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] * @@ -62,8 +64,9 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) - * whose groups are to be listed. The format is: + * Required. 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] * @type string $children_of_group * A group name. The format is: @@ -97,8 +100,9 @@ public function __construct($data = NULL) { } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) - * whose groups are to be listed. The format is: + * Required. 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] * * Generated from protobuf field string name = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -110,8 +114,9 @@ public function getName() } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) - * whose groups are to be listed. The format is: + * Required. 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] * * Generated from protobuf field string name = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/Monitoring/src/V3/ListMetricDescriptorsRequest.php b/Monitoring/src/V3/ListMetricDescriptorsRequest.php index 12386c8e8543..50cd5a457517 100644 --- a/Monitoring/src/V3/ListMetricDescriptorsRequest.php +++ b/Monitoring/src/V3/ListMetricDescriptorsRequest.php @@ -16,8 +16,9 @@ class ListMetricDescriptorsRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -36,7 +37,9 @@ class ListMetricDescriptorsRequest extends \Google\Protobuf\Internal\Message */ private $filter = ''; /** - * A positive number that is the maximum number of results to return. + * A positive number that is the maximum number of results to return. The + * default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is + * submitted, will instead return a maximum of 10,000 results. * * Generated from protobuf field int32 page_size = 3; */ @@ -51,8 +54,9 @@ class ListMetricDescriptorsRequest extends \Google\Protobuf\Internal\Message private $page_token = ''; /** - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * @param string $name Required. 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] * @@ -73,8 +77,9 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * @type string $filter * If this field is empty, all custom and @@ -85,7 +90,9 @@ public static function build(string $name): self * [custom metrics](https://cloud.google.com/monitoring/custom-metrics): * metric.type = starts_with("custom.googleapis.com/") * @type int $page_size - * A positive number that is the maximum number of results to return. + * A positive number that is the maximum number of results to return. The + * default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is + * submitted, will instead return a maximum of 10,000 results. * @type string $page_token * If this field is not empty then it must contain the `nextPageToken` value * returned by a previous call to this method. Using this field causes the @@ -98,8 +105,9 @@ public function __construct($data = NULL) { } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -111,8 +119,9 @@ public function getName() } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -166,7 +175,9 @@ public function setFilter($var) } /** - * A positive number that is the maximum number of results to return. + * A positive number that is the maximum number of results to return. The + * default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is + * submitted, will instead return a maximum of 10,000 results. * * Generated from protobuf field int32 page_size = 3; * @return int @@ -177,7 +188,9 @@ public function getPageSize() } /** - * A positive number that is the maximum number of results to return. + * A positive number that is the maximum number of results to return. The + * default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is + * submitted, will instead return a maximum of 10,000 results. * * Generated from protobuf field int32 page_size = 3; * @param int $var diff --git a/Monitoring/src/V3/ListMonitoredResourceDescriptorsRequest.php b/Monitoring/src/V3/ListMonitoredResourceDescriptorsRequest.php index 598c01dc32ca..7df803eb2d82 100644 --- a/Monitoring/src/V3/ListMonitoredResourceDescriptorsRequest.php +++ b/Monitoring/src/V3/ListMonitoredResourceDescriptorsRequest.php @@ -16,8 +16,9 @@ class ListMonitoredResourceDescriptorsRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -49,8 +50,9 @@ class ListMonitoredResourceDescriptorsRequest extends \Google\Protobuf\Internal\ private $page_token = ''; /** - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * @param string $name Required. 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] * @@ -71,8 +73,9 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * @type string $filter * An optional [filter](https://cloud.google.com/monitoring/api/v3/filters) @@ -94,8 +97,9 @@ public function __construct($data = NULL) { } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -107,8 +111,9 @@ public function getName() } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/Monitoring/src/V3/ListServiceLevelObjectivesRequest.php b/Monitoring/src/V3/ListServiceLevelObjectivesRequest.php index 9dbc95acf9fc..5dd4cf9d214e 100644 --- a/Monitoring/src/V3/ListServiceLevelObjectivesRequest.php +++ b/Monitoring/src/V3/ListServiceLevelObjectivesRequest.php @@ -17,7 +17,7 @@ class ListServiceLevelObjectivesRequest extends \Google\Protobuf\Internal\Messag { /** * Required. 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/- * @@ -57,7 +57,7 @@ class ListServiceLevelObjectivesRequest extends \Google\Protobuf\Internal\Messag /** * @param string $parent Required. 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/- @@ -81,7 +81,7 @@ public static function build(string $parent): self * * @type string $parent * Required. 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/- * @type string $filter @@ -107,7 +107,7 @@ public function __construct($data = NULL) { /** * Required. 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/- * @@ -121,7 +121,7 @@ public function getParent() /** * Required. 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/src/V3/ListServicesRequest.php b/Monitoring/src/V3/ListServicesRequest.php index a533582545c0..89af60783741 100644 --- a/Monitoring/src/V3/ListServicesRequest.php +++ b/Monitoring/src/V3/ListServicesRequest.php @@ -16,9 +16,9 @@ class ListServicesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. 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: + * Required. 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] * @@ -26,23 +26,22 @@ class ListServicesRequest extends \Google\Protobuf\Internal\Message */ private $parent = ''; /** - * A filter specifying what `Service`s to return. The filter currently - * supports the following fields: - * - `identifier_case` - * - `app_engine.module_id` - * - `cloud_endpoints.service` (reserved for future use) - * - `mesh_istio.mesh_uid` - * - `mesh_istio.service_namespace` - * - `mesh_istio.service_name` - * - `cluster_istio.location` (deprecated) - * - `cluster_istio.cluster_name` (deprecated) - * - `cluster_istio.service_namespace` (deprecated) - * - `cluster_istio.service_name` (deprecated) - * `identifier_case` refers to which option in the identifier oneof is - * populated. For example, the filter `identifier_case = "CUSTOM"` would match - * all services with a value for the `custom` field. Valid options are - * "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated) - * and "CLOUD_ENDPOINTS" (reserved for future use). + * A filter specifying what `Service`s to return. The filter supports + * filtering on a particular service-identifier type or one of its attributes. + * To filter on a particular service-identifier type, the `identifier_case` + * refers to which option in the `identifier` field is populated. For example, + * the filter `identifier_case = "CUSTOM"` would match all services with a + * value for the `custom` field. Valid options include "CUSTOM", "APP_ENGINE", + * "MESH_ISTIO", and the other options listed at + * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service + * To filter on an attribute of a service-identifier type, apply the filter + * name by using the snake case of the service-identifier type and the + * attribute of that service-identifier type, and join the two with a period. + * For example, to filter by the `meshUid` field of the `MeshIstio` + * service-identifier type, you must filter on `mesh_istio.mesh_uid = + * "123"` to match all services with mesh UID "123". Service-identifier types + * and their attributes are described at + * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service * * Generated from protobuf field string filter = 2; */ @@ -64,9 +63,9 @@ class ListServicesRequest extends \Google\Protobuf\Internal\Message private $page_token = ''; /** - * @param string $parent Required. 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 Required. 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] @@ -88,29 +87,28 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. 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: + * Required. 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] * @type string $filter - * A filter specifying what `Service`s to return. The filter currently - * supports the following fields: - * - `identifier_case` - * - `app_engine.module_id` - * - `cloud_endpoints.service` (reserved for future use) - * - `mesh_istio.mesh_uid` - * - `mesh_istio.service_namespace` - * - `mesh_istio.service_name` - * - `cluster_istio.location` (deprecated) - * - `cluster_istio.cluster_name` (deprecated) - * - `cluster_istio.service_namespace` (deprecated) - * - `cluster_istio.service_name` (deprecated) - * `identifier_case` refers to which option in the identifier oneof is - * populated. For example, the filter `identifier_case = "CUSTOM"` would match - * all services with a value for the `custom` field. Valid options are - * "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated) - * and "CLOUD_ENDPOINTS" (reserved for future use). + * A filter specifying what `Service`s to return. The filter supports + * filtering on a particular service-identifier type or one of its attributes. + * To filter on a particular service-identifier type, the `identifier_case` + * refers to which option in the `identifier` field is populated. For example, + * the filter `identifier_case = "CUSTOM"` would match all services with a + * value for the `custom` field. Valid options include "CUSTOM", "APP_ENGINE", + * "MESH_ISTIO", and the other options listed at + * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service + * To filter on an attribute of a service-identifier type, apply the filter + * name by using the snake case of the service-identifier type and the + * attribute of that service-identifier type, and join the two with a period. + * For example, to filter by the `meshUid` field of the `MeshIstio` + * service-identifier type, you must filter on `mesh_istio.mesh_uid = + * "123"` to match all services with mesh UID "123". Service-identifier types + * and their attributes are described at + * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service * @type int $page_size * A non-negative number that is the maximum number of results to return. * When 0, use default page size. @@ -126,9 +124,9 @@ public function __construct($data = NULL) { } /** - * Required. 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: + * Required. 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] * @@ -141,9 +139,9 @@ public function getParent() } /** - * Required. 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: + * Required. 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] * @@ -160,23 +158,22 @@ public function setParent($var) } /** - * A filter specifying what `Service`s to return. The filter currently - * supports the following fields: - * - `identifier_case` - * - `app_engine.module_id` - * - `cloud_endpoints.service` (reserved for future use) - * - `mesh_istio.mesh_uid` - * - `mesh_istio.service_namespace` - * - `mesh_istio.service_name` - * - `cluster_istio.location` (deprecated) - * - `cluster_istio.cluster_name` (deprecated) - * - `cluster_istio.service_namespace` (deprecated) - * - `cluster_istio.service_name` (deprecated) - * `identifier_case` refers to which option in the identifier oneof is - * populated. For example, the filter `identifier_case = "CUSTOM"` would match - * all services with a value for the `custom` field. Valid options are - * "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated) - * and "CLOUD_ENDPOINTS" (reserved for future use). + * A filter specifying what `Service`s to return. The filter supports + * filtering on a particular service-identifier type or one of its attributes. + * To filter on a particular service-identifier type, the `identifier_case` + * refers to which option in the `identifier` field is populated. For example, + * the filter `identifier_case = "CUSTOM"` would match all services with a + * value for the `custom` field. Valid options include "CUSTOM", "APP_ENGINE", + * "MESH_ISTIO", and the other options listed at + * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service + * To filter on an attribute of a service-identifier type, apply the filter + * name by using the snake case of the service-identifier type and the + * attribute of that service-identifier type, and join the two with a period. + * For example, to filter by the `meshUid` field of the `MeshIstio` + * service-identifier type, you must filter on `mesh_istio.mesh_uid = + * "123"` to match all services with mesh UID "123". Service-identifier types + * and their attributes are described at + * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service * * Generated from protobuf field string filter = 2; * @return string @@ -187,23 +184,22 @@ public function getFilter() } /** - * A filter specifying what `Service`s to return. The filter currently - * supports the following fields: - * - `identifier_case` - * - `app_engine.module_id` - * - `cloud_endpoints.service` (reserved for future use) - * - `mesh_istio.mesh_uid` - * - `mesh_istio.service_namespace` - * - `mesh_istio.service_name` - * - `cluster_istio.location` (deprecated) - * - `cluster_istio.cluster_name` (deprecated) - * - `cluster_istio.service_namespace` (deprecated) - * - `cluster_istio.service_name` (deprecated) - * `identifier_case` refers to which option in the identifier oneof is - * populated. For example, the filter `identifier_case = "CUSTOM"` would match - * all services with a value for the `custom` field. Valid options are - * "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated) - * and "CLOUD_ENDPOINTS" (reserved for future use). + * A filter specifying what `Service`s to return. The filter supports + * filtering on a particular service-identifier type or one of its attributes. + * To filter on a particular service-identifier type, the `identifier_case` + * refers to which option in the `identifier` field is populated. For example, + * the filter `identifier_case = "CUSTOM"` would match all services with a + * value for the `custom` field. Valid options include "CUSTOM", "APP_ENGINE", + * "MESH_ISTIO", and the other options listed at + * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service + * To filter on an attribute of a service-identifier type, apply the filter + * name by using the snake case of the service-identifier type and the + * attribute of that service-identifier type, and join the two with a period. + * For example, to filter by the `meshUid` field of the `MeshIstio` + * service-identifier type, you must filter on `mesh_istio.mesh_uid = + * "123"` to match all services with mesh UID "123". Service-identifier types + * and their attributes are described at + * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service * * Generated from protobuf field string filter = 2; * @param string $var diff --git a/Monitoring/src/V3/ListTimeSeriesRequest.php b/Monitoring/src/V3/ListTimeSeriesRequest.php index 6bbd831a415c..ca008690aa8d 100644 --- a/Monitoring/src/V3/ListTimeSeriesRequest.php +++ b/Monitoring/src/V3/ListTimeSeriesRequest.php @@ -16,7 +16,8 @@ class ListTimeSeriesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name), + * Required. 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] @@ -26,10 +27,11 @@ class ListTimeSeriesRequest extends \Google\Protobuf\Internal\Message */ private $name = ''; /** - * Required. 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: + * Required. 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" * @@ -37,9 +39,9 @@ class ListTimeSeriesRequest extends \Google\Protobuf\Internal\Message */ private $filter = ''; /** - * Required. The time interval for which results should be returned. Only time series - * that contain data points in the specified interval are included - * in the response. + * Required. The time interval for which results should be returned. Only time + * series that contain data points in the specified interval are included in + * the response. * * Generated from protobuf field .google.monitoring.v3.TimeInterval interval = 4 [(.google.api.field_behavior) = REQUIRED]; */ @@ -93,23 +95,25 @@ class ListTimeSeriesRequest extends \Google\Protobuf\Internal\Message private $page_token = ''; /** - * @param string $name Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name), + * @param string $name Required. 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 Required. 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 Required. 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" - * @param \Google\Cloud\Monitoring\V3\TimeInterval $interval Required. The time interval for which results should be returned. Only time series - * that contain data points in the specified interval are included - * in the response. + * @param \Google\Cloud\Monitoring\V3\TimeInterval $interval Required. The time interval for which results should be returned. Only time + * series that contain data points in the specified interval are included in + * the response. * @param int $view Required. Specifies which information is returned about the time series. * For allowed values, use constants defined on {@see \Google\Cloud\Monitoring\V3\ListTimeSeriesRequest\TimeSeriesView} * @@ -133,22 +137,24 @@ public static function build(string $name, string $filter, \Google\Cloud\Monitor * Optional. Data for populating the Message object. * * @type string $name - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name), + * Required. 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] * @type string $filter - * Required. 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: + * Required. 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" * @type \Google\Cloud\Monitoring\V3\TimeInterval $interval - * Required. The time interval for which results should be returned. Only time series - * that contain data points in the specified interval are included - * in the response. + * Required. The time interval for which results should be returned. Only time + * series that contain data points in the specified interval are included in + * the response. * @type \Google\Cloud\Monitoring\V3\Aggregation $aggregation * Specifies the alignment of data points in individual time series as * well as how to combine the retrieved time series across specified labels. @@ -180,7 +186,8 @@ public function __construct($data = NULL) { } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name), + * Required. 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] @@ -195,7 +202,8 @@ public function getName() } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name), + * Required. 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] @@ -214,10 +222,11 @@ public function setName($var) } /** - * Required. 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: + * Required. 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" * @@ -230,10 +239,11 @@ public function getFilter() } /** - * Required. 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: + * Required. 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" * @@ -250,9 +260,9 @@ public function setFilter($var) } /** - * Required. The time interval for which results should be returned. Only time series - * that contain data points in the specified interval are included - * in the response. + * Required. The time interval for which results should be returned. Only time + * series that contain data points in the specified interval are included in + * the response. * * Generated from protobuf field .google.monitoring.v3.TimeInterval interval = 4 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\Monitoring\V3\TimeInterval|null @@ -273,9 +283,9 @@ public function clearInterval() } /** - * Required. The time interval for which results should be returned. Only time series - * that contain data points in the specified interval are included - * in the response. + * Required. The time interval for which results should be returned. Only time + * series that contain data points in the specified interval are included in + * the response. * * Generated from protobuf field .google.monitoring.v3.TimeInterval interval = 4 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\Monitoring\V3\TimeInterval $var diff --git a/Monitoring/src/V3/ListTimeSeriesRequest/TimeSeriesView.php b/Monitoring/src/V3/ListTimeSeriesRequest/TimeSeriesView.php index 4055777eb6db..cd4d2c1bcc55 100644 --- a/Monitoring/src/V3/ListTimeSeriesRequest/TimeSeriesView.php +++ b/Monitoring/src/V3/ListTimeSeriesRequest/TimeSeriesView.php @@ -7,7 +7,7 @@ use UnexpectedValueException; /** - * Controls which fields are returned by `ListTimeSeries`. + * Controls which fields are returned by `ListTimeSeries*`. * * Protobuf type google.monitoring.v3.ListTimeSeriesRequest.TimeSeriesView */ diff --git a/Monitoring/src/V3/QueryTimeSeriesRequest.php b/Monitoring/src/V3/QueryTimeSeriesRequest.php index 9e1e3bcf747d..1c2545b7a036 100644 --- a/Monitoring/src/V3/QueryTimeSeriesRequest.php +++ b/Monitoring/src/V3/QueryTimeSeriesRequest.php @@ -16,8 +16,9 @@ class QueryTimeSeriesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -53,8 +54,9 @@ class QueryTimeSeriesRequest extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * @type string $query * Required. The query in the [Monitoring Query @@ -74,8 +76,9 @@ public function __construct($data = NULL) { } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -87,8 +90,9 @@ public function getName() } /** - * Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - * which to execute the request. The format is: + * Required. 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] * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; diff --git a/Monitoring/src/V3/ServiceTier.php b/Monitoring/src/V3/ServiceTier.php index 928b55ace91d..906682308486 100644 --- a/Monitoring/src/V3/ServiceTier.php +++ b/Monitoring/src/V3/ServiceTier.php @@ -8,7 +8,7 @@ /** * @deprecated - * The tier of service for a Workspace. Please see the + * The tier of service for a Metrics Scope. Please see the * [service tiers * documentation](https://cloud.google.com/monitoring/workspaces/tiers) for more * details. @@ -25,7 +25,7 @@ class ServiceTier */ const SERVICE_TIER_UNSPECIFIED = 0; /** - * The Stackdriver Basic tier, a free tier of service that provides basic + * The Cloud Monitoring Basic tier, a free tier of service that provides basic * features, a moderate allotment of logs, and access to built-in metrics. * A number of features are not available in this tier. For more details, * see [the service tiers @@ -35,10 +35,10 @@ class ServiceTier */ const SERVICE_TIER_BASIC = 1; /** - * The Stackdriver Premium tier, a higher, more expensive tier of service - * that provides access to all Stackdriver features, lets you use Stackdriver - * with AWS accounts, and has a larger allotments for logs and metrics. For - * more details, see [the service tiers + * The Cloud Monitoring Premium tier, a higher, more expensive tier of service + * that provides access to all Cloud Monitoring features, lets you use Cloud + * Monitoring with AWS accounts, and has a larger allotments for logs and + * metrics. For more details, see [the service tiers * documentation](https://cloud.google.com/monitoring/workspaces/tiers). * * Generated from protobuf enum SERVICE_TIER_PREMIUM = 2; diff --git a/Monitoring/src/V3/TimeInterval.php b/Monitoring/src/V3/TimeInterval.php index 532a64739b00..f22cbd83de14 100644 --- a/Monitoring/src/V3/TimeInterval.php +++ b/Monitoring/src/V3/TimeInterval.php @@ -9,30 +9,43 @@ use Google\Protobuf\Internal\GPBUtil; /** - * A closed time interval. It extends from the start time to the end time, and includes both: `[startTime, endTime]`. Valid time intervals depend on the [`MetricKind`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future. - * * For `GAUGE` metrics, the `startTime` value is technically optional; if - * no value is specified, the start time defaults to the value of the - * end time, and the interval represents a single point in time. If both - * start and end times are specified, they must be identical. Such an - * interval is valid only for `GAUGE` metrics, which are point-in-time - * measurements. The end time of a new interval must be at least a - * millisecond after the end time of the previous interval. - * * For `DELTA` metrics, the start time and end time must specify a - * non-zero interval, with subsequent points specifying contiguous and - * non-overlapping intervals. For `DELTA` metrics, the start time of - * the next interval must be at least a millisecond after the end time - * of the previous interval. - * * For `CUMULATIVE` metrics, the start time and end time must specify a - * non-zero interval, with subsequent points specifying the same - * start time and increasing end times, until an event resets the - * cumulative value to zero and sets a new start time for the following - * points. The new start time must be at least a millisecond after the - * end time of the previous interval. - * * The start time of a new interval must be at least a millisecond after the - * end time of the previous interval because intervals are closed. If the - * start time of a new interval is the same as the end time of the previous - * interval, then data written at the new start time could overwrite data - * written at the previous end time. + * Describes a time interval: + * * Reads: A half-open time interval. It includes the end time but + * excludes the start time: `(startTime, endTime]`. The start time + * must be specified, must be earlier than the end time, and should be + * no older than the data retention period for the metric. + * * Writes: A closed time interval. It extends from the start time to the end + * time, + * and includes both: `[startTime, endTime]`. Valid time intervals + * depend on the + * [`MetricKind`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) + * of the metric value. The end time must not be earlier than the start + * time, and the end time must not be more than 25 hours in the past or more + * than five minutes in the future. + * * For `GAUGE` metrics, the `startTime` value is technically optional; if + * no value is specified, the start time defaults to the value of the + * end time, and the interval represents a single point in time. If both + * start and end times are specified, they must be identical. Such an + * interval is valid only for `GAUGE` metrics, which are point-in-time + * measurements. The end time of a new interval must be at least a + * millisecond after the end time of the previous interval. + * * For `DELTA` metrics, the start time and end time must specify a + * non-zero interval, with subsequent points specifying contiguous and + * non-overlapping intervals. For `DELTA` metrics, the start time of + * the next interval must be at least a millisecond after the end time + * of the previous interval. + * * For `CUMULATIVE` metrics, the start time and end time must specify a + * non-zero interval, with subsequent points specifying the same + * start time and increasing end times, until an event resets the + * cumulative value to zero and sets a new start time for the following + * points. The new start time must be at least a millisecond after the + * end time of the previous interval. + * * The start time of a new interval must be at least a millisecond after + * the + * end time of the previous interval because intervals are closed. If the + * start time of a new interval is the same as the end time of the + * previous interval, then data written at the new start time could + * overwrite data written at the previous end time. * * Generated from protobuf message google.monitoring.v3.TimeInterval */ diff --git a/Monitoring/src/V3/UpdateGroupRequest.php b/Monitoring/src/V3/UpdateGroupRequest.php index 0efe302c2d4f..9a41bfe72392 100644 --- a/Monitoring/src/V3/UpdateGroupRequest.php +++ b/Monitoring/src/V3/UpdateGroupRequest.php @@ -16,8 +16,9 @@ class UpdateGroupRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The new definition of the group. All fields of the existing group, - * excepting `name`, are replaced with the corresponding fields of this group. + * Required. The new definition of the group. All fields of the existing + * group, excepting `name`, are replaced with the corresponding fields of this + * group. * * Generated from protobuf field .google.monitoring.v3.Group group = 2 [(.google.api.field_behavior) = REQUIRED]; */ @@ -30,8 +31,9 @@ class UpdateGroupRequest extends \Google\Protobuf\Internal\Message private $validate_only = false; /** - * @param \Google\Cloud\Monitoring\V3\Group $group Required. The new definition of the group. All fields of the existing group, - * excepting `name`, are replaced with the corresponding fields of this group. + * @param \Google\Cloud\Monitoring\V3\Group $group Required. The new definition of the group. All fields of the existing + * group, excepting `name`, are replaced with the corresponding fields of this + * group. * * @return \Google\Cloud\Monitoring\V3\UpdateGroupRequest * @@ -50,8 +52,9 @@ public static function build(\Google\Cloud\Monitoring\V3\Group $group): self * Optional. Data for populating the Message object. * * @type \Google\Cloud\Monitoring\V3\Group $group - * Required. The new definition of the group. All fields of the existing group, - * excepting `name`, are replaced with the corresponding fields of this group. + * Required. The new definition of the group. All fields of the existing + * group, excepting `name`, are replaced with the corresponding fields of this + * group. * @type bool $validate_only * If true, validate this request but do not update the existing group. * } @@ -62,8 +65,9 @@ public function __construct($data = NULL) { } /** - * Required. The new definition of the group. All fields of the existing group, - * excepting `name`, are replaced with the corresponding fields of this group. + * Required. The new definition of the group. All fields of the existing + * group, excepting `name`, are replaced with the corresponding fields of this + * group. * * Generated from protobuf field .google.monitoring.v3.Group group = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\Monitoring\V3\Group|null @@ -84,8 +88,9 @@ public function clearGroup() } /** - * Required. The new definition of the group. All fields of the existing group, - * excepting `name`, are replaced with the corresponding fields of this group. + * Required. The new definition of the group. All fields of the existing + * group, excepting `name`, are replaced with the corresponding fields of this + * group. * * Generated from protobuf field .google.monitoring.v3.Group group = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\Monitoring\V3\Group $var diff --git a/Monitoring/src/V3/resources/alert_policy_service_descriptor_config.php b/Monitoring/src/V3/resources/alert_policy_service_descriptor_config.php index bb7fe884827d..995f07d75413 100644 --- a/Monitoring/src/V3/resources/alert_policy_service_descriptor_config.php +++ b/Monitoring/src/V3/resources/alert_policy_service_descriptor_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/alert_policy_service_rest_client_config.php b/Monitoring/src/V3/resources/alert_policy_service_rest_client_config.php index dffb1c026b48..bb65ee95b1d7 100644 --- a/Monitoring/src/V3/resources/alert_policy_service_rest_client_config.php +++ b/Monitoring/src/V3/resources/alert_policy_service_rest_client_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/group_service_descriptor_config.php b/Monitoring/src/V3/resources/group_service_descriptor_config.php index ff6efe326c8f..dba3498cf7f6 100644 --- a/Monitoring/src/V3/resources/group_service_descriptor_config.php +++ b/Monitoring/src/V3/resources/group_service_descriptor_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/group_service_rest_client_config.php b/Monitoring/src/V3/resources/group_service_rest_client_config.php index 2d4763692def..1ec3e238ee16 100644 --- a/Monitoring/src/V3/resources/group_service_rest_client_config.php +++ b/Monitoring/src/V3/resources/group_service_rest_client_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/metric_service_descriptor_config.php b/Monitoring/src/V3/resources/metric_service_descriptor_config.php index 537f2edc969b..7b8896801ebc 100644 --- a/Monitoring/src/V3/resources/metric_service_descriptor_config.php +++ b/Monitoring/src/V3/resources/metric_service_descriptor_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/metric_service_rest_client_config.php b/Monitoring/src/V3/resources/metric_service_rest_client_config.php index 741468a73ec1..0367626add51 100644 --- a/Monitoring/src/V3/resources/metric_service_rest_client_config.php +++ b/Monitoring/src/V3/resources/metric_service_rest_client_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/notification_channel_service_descriptor_config.php b/Monitoring/src/V3/resources/notification_channel_service_descriptor_config.php index 212e17ef7469..6088b2f89bf7 100644 --- a/Monitoring/src/V3/resources/notification_channel_service_descriptor_config.php +++ b/Monitoring/src/V3/resources/notification_channel_service_descriptor_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/notification_channel_service_rest_client_config.php b/Monitoring/src/V3/resources/notification_channel_service_rest_client_config.php index 3c782d2b3a64..822c7ebc9340 100644 --- a/Monitoring/src/V3/resources/notification_channel_service_rest_client_config.php +++ b/Monitoring/src/V3/resources/notification_channel_service_rest_client_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/query_service_descriptor_config.php b/Monitoring/src/V3/resources/query_service_descriptor_config.php index a3c68187c231..4b6dc680ebc6 100644 --- a/Monitoring/src/V3/resources/query_service_descriptor_config.php +++ b/Monitoring/src/V3/resources/query_service_descriptor_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/query_service_rest_client_config.php b/Monitoring/src/V3/resources/query_service_rest_client_config.php index f258f2c56388..38b688dbab52 100644 --- a/Monitoring/src/V3/resources/query_service_rest_client_config.php +++ b/Monitoring/src/V3/resources/query_service_rest_client_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/service_monitoring_service_descriptor_config.php b/Monitoring/src/V3/resources/service_monitoring_service_descriptor_config.php index ab57f32e711c..739ca8709340 100644 --- a/Monitoring/src/V3/resources/service_monitoring_service_descriptor_config.php +++ b/Monitoring/src/V3/resources/service_monitoring_service_descriptor_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/service_monitoring_service_rest_client_config.php b/Monitoring/src/V3/resources/service_monitoring_service_rest_client_config.php index ddefc86e0a72..f7ca03dded7a 100644 --- a/Monitoring/src/V3/resources/service_monitoring_service_rest_client_config.php +++ b/Monitoring/src/V3/resources/service_monitoring_service_rest_client_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/snooze_service_descriptor_config.php b/Monitoring/src/V3/resources/snooze_service_descriptor_config.php index a476bb046700..57e5c8ab3863 100644 --- a/Monitoring/src/V3/resources/snooze_service_descriptor_config.php +++ b/Monitoring/src/V3/resources/snooze_service_descriptor_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/snooze_service_rest_client_config.php b/Monitoring/src/V3/resources/snooze_service_rest_client_config.php index de2890fcd300..a3b5e3574b8e 100644 --- a/Monitoring/src/V3/resources/snooze_service_rest_client_config.php +++ b/Monitoring/src/V3/resources/snooze_service_rest_client_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/uptime_check_service_descriptor_config.php b/Monitoring/src/V3/resources/uptime_check_service_descriptor_config.php index f69c027e8c7b..a9dbc7aa7817 100644 --- a/Monitoring/src/V3/resources/uptime_check_service_descriptor_config.php +++ b/Monitoring/src/V3/resources/uptime_check_service_descriptor_config.php @@ -1,4 +1,24 @@ [ diff --git a/Monitoring/src/V3/resources/uptime_check_service_rest_client_config.php b/Monitoring/src/V3/resources/uptime_check_service_rest_client_config.php index 48eea72dcebf..4c50c3cd46b1 100644 --- a/Monitoring/src/V3/resources/uptime_check_service_rest_client_config.php +++ b/Monitoring/src/V3/resources/uptime_check_service_rest_client_config.php @@ -1,4 +1,24 @@ [