google-cloud-monitoring 0.29.1 → 0.29.2

data/lib/google/cloud/monitoring/v3/doc/google/protobuf/duration.rb

@@ -82,9 +82,9 @@ module Google
     #   @return [Integer]
     #     Signed fractions of a second at nanosecond resolution of the span
     #     of time. Durations less than one second are represented with a 0
-    #     +seconds+ field and a positive or negative +nanos+ field. For durations
-    #     of one second or more, a non-zero value for the +nanos+ field must be
-    #     of the same sign as the +seconds+ field. Must be from -999,999,999
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
     #     to +999,999,999 inclusive.
     class Duration; end
   end

data/lib/google/cloud/monitoring/v3/doc/google/protobuf/empty.rb

@@ -23,7 +23,7 @@ module Google
     #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
     #     }
     #
-    # The JSON representation for +Empty+ is empty JSON object +{}+.
+    # The JSON representation for `Empty` is empty JSON object `{}`.
     class Empty; end
   end
 end

data/lib/google/cloud/monitoring/v3/doc/google/protobuf/field_mask.rb

@@ -15,14 +15,14 @@
 
 module Google
   module Protobuf
-    # +FieldMask+ represents a set of symbolic field paths, for example:
+    # `FieldMask` represents a set of symbolic field paths, for example:
     #
     #     paths: "f.a"
     #     paths: "f.b.d"
     #
-    # Here +f+ represents a field in some root message, +a+ and +b+
-    # fields in the message found in +f+, and +d+ a field found in the
-    # message in +f.b+.
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
     #
     # Field masks are used to specify a subset of fields that should be
     # returned by a get operation or modified by an update operation.
@@ -85,7 +85,7 @@ module Google
     #
     # If a repeated field is specified for an update operation, the existing
     # repeated values in the target resource will be overwritten by the new values.
-    # Note that a repeated field is only allowed in the last position of a +paths+
+    # Note that a repeated field is only allowed in the last position of a `paths`
     # string.
     #
     # If a sub-message is specified in the last position of the field mask for an
@@ -177,7 +177,7 @@ module Google
     #       string address = 2;
     #     }
     #
-    # In proto a field mask for +Profile+ may look as such:
+    # In proto a field mask for `Profile` may look as such:
     #
     #     mask {
     #       paths: "user.display_name"
@@ -221,7 +221,7 @@ module Google
     #
     # The implementation of any API method which has a FieldMask type field in the
     # request should verify the included field paths, and return an
-    # +INVALID_ARGUMENT+ error if any path is duplicated or unmappable.
+    # `INVALID_ARGUMENT` error if any path is duplicated or unmappable.
     # @!attribute [rw] paths
     #   @return [Array<String>]
     #     The set of field mask paths.

data/lib/google/cloud/monitoring/v3/doc/google/protobuf/struct.rb

@@ -15,25 +15,25 @@
 
 module Google
   module Protobuf
-    # +Struct+ represents a structured data value, consisting of fields
-    # which map to dynamically typed values. In some languages, +Struct+
+    # `Struct` represents a structured data value, consisting of fields
+    # which map to dynamically typed values. In some languages, `Struct`
     # might be supported by a native representation. For example, in
     # scripting languages like JS a struct is represented as an
     # object. The details of that representation are described together
     # with the proto support for the language.
     #
-    # The JSON representation for +Struct+ is JSON object.
+    # The JSON representation for `Struct` is JSON object.
     # @!attribute [rw] fields
     #   @return [Hash{String => Google::Protobuf::Value}]
     #     Unordered map of dynamically typed values.
     class Struct; end
 
-    # +Value+ represents a dynamically typed value which can be either
+    # `Value` represents a dynamically typed value which can be either
     # null, a number, a string, a boolean, a recursive struct value, or a
     # list of values. A producer of value is expected to set one of that
     # variants, absence of any variant indicates an error.
     #
-    # The JSON representation for +Value+ is JSON value.
+    # The JSON representation for `Value` is JSON value.
     # @!attribute [rw] null_value
     #   @return [Google::Protobuf::NullValue]
     #     Represents a null value.
@@ -51,21 +51,21 @@ module Google
     #     Represents a structured value.
     # @!attribute [rw] list_value
     #   @return [Google::Protobuf::ListValue]
-    #     Represents a repeated +Value+.
+    #     Represents a repeated `Value`.
     class Value; end
 
-    # +ListValue+ is a wrapper around a repeated field of values.
+    # `ListValue` is a wrapper around a repeated field of values.
     #
-    # The JSON representation for +ListValue+ is JSON array.
+    # The JSON representation for `ListValue` is JSON array.
     # @!attribute [rw] values
     #   @return [Array<Google::Protobuf::Value>]
     #     Repeated field of dynamically typed values.
     class ListValue; end
 
-    # +NullValue+ is a singleton enumeration to represent the null value for the
-    # +Value+ type union.
+    # `NullValue` is a singleton enumeration to represent the null value for the
+    # `Value` type union.
     #
-    #  The JSON representation for +NullValue+ is JSON +null+.
+    #  The JSON representation for `NullValue` is JSON `null`.
     module NullValue
       # Null value.
       NULL_VALUE = 0

data/lib/google/cloud/monitoring/v3/doc/google/protobuf/timestamp.rb

@@ -29,13 +29,13 @@ module Google
     #
     # = Examples
     #
-    # Example 1: Compute Timestamp from POSIX +time()+.
+    # Example 1: Compute Timestamp from POSIX `time()`.
     #
     #     Timestamp timestamp;
     #     timestamp.set_seconds(time(NULL));
     #     timestamp.set_nanos(0);
     #
-    # Example 2: Compute Timestamp from POSIX +gettimeofday()+.
+    # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
     #
     #     struct timeval tv;
     #     gettimeofday(&tv, NULL);
@@ -44,7 +44,7 @@ module Google
     #     timestamp.set_seconds(tv.tv_sec);
     #     timestamp.set_nanos(tv.tv_usec * 1000);
     #
-    # Example 3: Compute Timestamp from Win32 +GetSystemTimeAsFileTime()+.
+    # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
     #
     #     FILETIME ft;
     #     GetSystemTimeAsFileTime(&ft);
@@ -56,7 +56,7 @@ module Google
     #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
     #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
     #
-    # Example 4: Compute Timestamp from Java +System.currentTimeMillis()+.
+    # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
     #
     #     long millis = System.currentTimeMillis();
     #
@@ -87,10 +87,10 @@ module Google
     #
     # In JavaScript, one can convert a Date object to this format using the
     # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
-    # method. In Python, a standard +datetime.datetime+ object can be converted
-    # to this format using [+strftime+](https://docs.python.org/2/library/time.html#time.strftime)
+    # method. In Python, a standard `datetime.datetime` object can be converted
+    # to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
     # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
-    # can use the Joda Time's [+ISODateTimeFormat.dateTime()+](
+    # can use the Joda Time's [`ISODateTimeFormat.dateTime()`](
     # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
     # ) to obtain a formatter capable of generating timestamps in this format.
     # @!attribute [rw] seconds

data/lib/google/cloud/monitoring/v3/doc/google/protobuf/wrappers.rb

@@ -15,73 +15,73 @@
 
 module Google
   module Protobuf
-    # Wrapper message for +double+.
+    # Wrapper message for `double`.
     #
-    # The JSON representation for +DoubleValue+ is JSON number.
+    # The JSON representation for `DoubleValue` is JSON number.
     # @!attribute [rw] value
     #   @return [Float]
     #     The double value.
     class DoubleValue; end
 
-    # Wrapper message for +float+.
+    # Wrapper message for `float`.
     #
-    # The JSON representation for +FloatValue+ is JSON number.
+    # The JSON representation for `FloatValue` is JSON number.
     # @!attribute [rw] value
     #   @return [Float]
     #     The float value.
     class FloatValue; end
 
-    # Wrapper message for +int64+.
+    # Wrapper message for `int64`.
     #
-    # The JSON representation for +Int64Value+ is JSON string.
+    # The JSON representation for `Int64Value` is JSON string.
     # @!attribute [rw] value
     #   @return [Integer]
     #     The int64 value.
     class Int64Value; end
 
-    # Wrapper message for +uint64+.
+    # Wrapper message for `uint64`.
     #
-    # The JSON representation for +UInt64Value+ is JSON string.
+    # The JSON representation for `UInt64Value` is JSON string.
     # @!attribute [rw] value
     #   @return [Integer]
     #     The uint64 value.
     class UInt64Value; end
 
-    # Wrapper message for +int32+.
+    # Wrapper message for `int32`.
     #
-    # The JSON representation for +Int32Value+ is JSON number.
+    # The JSON representation for `Int32Value` is JSON number.
     # @!attribute [rw] value
     #   @return [Integer]
     #     The int32 value.
     class Int32Value; end
 
-    # Wrapper message for +uint32+.
+    # Wrapper message for `uint32`.
     #
-    # The JSON representation for +UInt32Value+ is JSON number.
+    # The JSON representation for `UInt32Value` is JSON number.
     # @!attribute [rw] value
     #   @return [Integer]
     #     The uint32 value.
     class UInt32Value; end
 
-    # Wrapper message for +bool+.
+    # Wrapper message for `bool`.
     #
-    # The JSON representation for +BoolValue+ is JSON +true+ and +false+.
+    # The JSON representation for `BoolValue` is JSON `true` and `false`.
     # @!attribute [rw] value
     #   @return [true, false]
     #     The bool value.
     class BoolValue; end
 
-    # Wrapper message for +string+.
+    # Wrapper message for `string`.
     #
-    # The JSON representation for +StringValue+ is JSON string.
+    # The JSON representation for `StringValue` is JSON string.
     # @!attribute [rw] value
     #   @return [String]
     #     The string value.
     class StringValue; end
 
-    # Wrapper message for +bytes+.
+    # Wrapper message for `bytes`.
     #
-    # The JSON representation for +BytesValue+ is JSON string.
+    # The JSON representation for `BytesValue` is JSON string.
     # @!attribute [rw] value
     #   @return [String]
     #     The bytes value.

data/lib/google/cloud/monitoring/v3/doc/google/rpc/status.rb

@@ -15,7 +15,7 @@
 
 module Google
   module Rpc
-    # The +Status+ type defines a logical error model that is suitable for different
+    # The `Status` type defines a logical error model that is suitable for different
     # programming environments, including REST APIs and RPC APIs. It is used by
     # [gRPC](https://github.com/grpc). The error model is designed to be:
     #
@@ -24,7 +24,7 @@ module Google
     #
     # = Overview
     #
-    # The +Status+ message contains three pieces of data: error code, error message,
+    # The `Status` message contains three pieces of data: error code, error message,
     # and error details. The error code should be an enum value of
     # {Google::Rpc::Code}, but it may accept additional error codes if needed.  The
     # error message should be a developer-facing English message that helps
@@ -32,40 +32,40 @@ module Google
     # error message is needed, put the localized message in the error details or
     # localize it in the client. The optional error details may contain arbitrary
     # information about the error. There is a predefined set of error detail types
-    # in the package +google.rpc+ that can be used for common error conditions.
+    # in the package `google.rpc` that can be used for common error conditions.
     #
     # = Language mapping
     #
-    # The +Status+ message is the logical representation of the error model, but it
-    # is not necessarily the actual wire format. When the +Status+ message is
+    # The `Status` message is the logical representation of the error model, but it
+    # is not necessarily the actual wire format. When the `Status` message is
     # exposed in different client libraries and different wire protocols, it can be
     # mapped differently. For example, it will likely be mapped to some exceptions
     # in Java, but more likely mapped to some error codes in C.
     #
     # = Other uses
     #
-    # The error model and the +Status+ message can be used in a variety of
+    # The error model and the `Status` message can be used in a variety of
     # environments, either with or without APIs, to provide a
     # consistent developer experience across different environments.
     #
     # Example uses of this error model include:
     #
     # * Partial errors. If a service needs to return partial errors to the client,
-    #   it may embed the +Status+ in the normal response to indicate the partial
+    #   it may embed the `Status` in the normal response to indicate the partial
     #   errors.
     #
     # * Workflow errors. A typical workflow has multiple steps. Each step may
-    #   have a +Status+ message for error reporting.
+    #   have a `Status` message for error reporting.
     #
     # * Batch operations. If a client uses batch request and batch response, the
-    #   +Status+ message should be used directly inside batch response, one for
+    #   `Status` message should be used directly inside batch response, one for
     #   each error sub-response.
     #
     # * Asynchronous operations. If an API call embeds asynchronous operation
     #   results in its response, the status of those operations should be
-    #   represented directly using the +Status+ message.
+    #   represented directly using the `Status` message.
     #
-    # * Logging. If some API errors are stored in logs, the message +Status+ could
+    # * Logging. If some API errors are stored in logs, the message `Status` could
     #   be used directly after any stripping needed for security/privacy reasons.
     # @!attribute [rw] code
     #   @return [Integer]

data/lib/google/cloud/monitoring/v3/group_service_client.rb

@@ -258,21 +258,21 @@ module Google
           #
           # @param name [String]
           #   The project whose groups are to be listed. The format is
-          #   +"projects/\\{project_id_or_number}"+.
+          #   `"projects/{project_id_or_number}"`.
           # @param children_of_group [String]
-          #   A group name: +"projects/\\{project_id_or_number}/groups/\\{group_id}"+.
-          #   Returns groups whose +parentName+ field contains the group
+          #   A group name: `"projects/{project_id_or_number}/groups/{group_id}"`.
+          #   Returns groups whose `parentName` field contains the group
           #   name.  If no groups have this parent, the results are empty.
           # @param ancestors_of_group [String]
-          #   A group name: +"projects/\\{project_id_or_number}/groups/\\{group_id}"+.
+          #   A group name: `"projects/{project_id_or_number}/groups/{group_id}"`.
           #   Returns groups that are ancestors of the specified group.
           #   The groups are returned in order, starting with the immediate parent and
           #   ending with the most distant ancestor.  If the specified group has no
           #   immediate parent, the results are empty.
           # @param descendants_of_group [String]
-          #   A group name: +"projects/\\{project_id_or_number}/groups/\\{group_id}"+.
+          #   A group name: `"projects/{project_id_or_number}/groups/{group_id}"`.
           #   Returns the descendants of the specified group.  This is a superset of
-          #   the results returned by the +childrenOfGroup+ filter, and includes
+          #   the results returned by the `childrenOfGroup` filter, and includes
           #   children-of-children, and so forth.
           # @param page_size [Integer]
           #   The maximum number of resources contained in the underlying API
@@ -334,7 +334,7 @@ module Google
           #
           # @param name [String]
           #   The group to retrieve. The format is
-          #   +"projects/\\{project_id_or_number}/groups/\\{group_id}"+.
+          #   `"projects/{project_id_or_number}/groups/{group_id}"`.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -365,9 +365,9 @@ module Google
           #
           # @param name [String]
           #   The project in which to create the group. The format is
-          #   +"projects/\\{project_id_or_number}"+.
+          #   `"projects/{project_id_or_number}"`.
           # @param group [Google::Monitoring::V3::Group | Hash]
-          #   A group definition. It is an error to define the +name+ field because
+          #   A group definition. It is an error to define the `name` field because
           #   the system assigns the name.
           #   A hash of the same form as `Google::Monitoring::V3::Group`
           #   can also be provided.
@@ -387,7 +387,7 @@ module Google
           #   group_service_client = Google::Cloud::Monitoring::Group.new(version: :v3)
           #   formatted_name = Google::Cloud::Monitoring::V3::GroupServiceClient.project_path("[PROJECT]")
           #
-          #   # TODO: Initialize +group+:
+          #   # TODO: Initialize `group`:
           #   group = {}
           #   response = group_service_client.create_group(formatted_name, group)
 
@@ -407,11 +407,11 @@ module Google
           end
 
           # Updates an existing group.
-          # You can change any group attributes except +name+.
+          # You can change any group attributes except `name`.
           #
           # @param group [Google::Monitoring::V3::Group | Hash]
           #   The new definition of the group.  All fields of the existing group,
-          #   excepting +name+, are replaced with the corresponding fields of this group.
+          #   excepting `name`, are replaced with the corresponding fields of this group.
           #   A hash of the same form as `Google::Monitoring::V3::Group`
           #   can also be provided.
           # @param validate_only [true, false]
@@ -429,7 +429,7 @@ module Google
           #
           #   group_service_client = Google::Cloud::Monitoring::Group.new(version: :v3)
           #
-          #   # TODO: Initialize +group+:
+          #   # TODO: Initialize `group`:
           #   group = {}
           #   response = group_service_client.update_group(group)
 
@@ -450,7 +450,7 @@ module Google
           #
           # @param name [String]
           #   The group to delete. The format is
-          #   +"projects/\\{project_id_or_number}/groups/\\{group_id}"+.
+          #   `"projects/{project_id_or_number}/groups/{group_id}"`.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -481,7 +481,7 @@ module Google
           #
           # @param name [String]
           #   The group whose members are listed. The format is
-          #   +"projects/\\{project_id_or_number}/groups/\\{group_id}"+.
+          #   `"projects/{project_id_or_number}/groups/{group_id}"`.
           # @param page_size [Integer]
           #   The maximum number of resources contained in the underlying API
           #   response. If page streaming is performed per-resource, this

data/lib/google/cloud/monitoring/v3/metric_service_client.rb

@@ -279,13 +279,13 @@ module Google
           #
           # @param name [String]
           #   The project on which to execute the request. The format is
-          #   +"projects/\\{project_id_or_number}"+.
+          #   `"projects/{project_id_or_number}"`.
           # @param filter [String]
           #   An optional [filter](https://cloud.google.com/monitoring/api/v3/filters) describing
           #   the descriptors to be returned.  The filter can reference
           #   the descriptor's type and labels. For example, the
           #   following filter returns only Google Compute Engine descriptors
-          #   that have an +id+ label:
+          #   that have an `id` label:
           #
           #       resource.type = starts_with("gce_") AND resource.label:id
           # @param page_size [Integer]
@@ -344,9 +344,9 @@ module Google
           #
           # @param name [String]
           #   The monitored resource descriptor to get.  The format is
-          #   +"projects/\\{project_id_or_number}/monitoredResourceDescriptors/\\{resource_type}"+.
-          #   The +\\{resource_type}+ is a predefined type, such as
-          #   +cloudsql_database+.
+          #   `"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"`.
+          #   The `{resource_type}` is a predefined type, such as
+          #   `cloudsql_database`.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -377,7 +377,7 @@ module Google
           #
           # @param name [String]
           #   The project on which to execute the request. The format is
-          #   +"projects/\\{project_id_or_number}"+.
+          #   `"projects/{project_id_or_number}"`.
           # @param filter [String]
           #   If this field is empty, all custom and
           #   system-defined metric descriptors are returned.
@@ -443,9 +443,9 @@ module Google
           #
           # @param name [String]
           #   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"+.
+          #   `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`.
+          #   An example value of `{metric_id}` is
+          #   `"compute.googleapis.com/instance/disk/read_bytes_count"`.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -478,7 +478,7 @@ module Google
           #
           # @param name [String]
           #   The project on which to execute the request. The format is
-          #   +"projects/\\{project_id_or_number}"+.
+          #   `"projects/{project_id_or_number}"`.
           # @param metric_descriptor [Google::Api::MetricDescriptor | Hash]
           #   The new [custom metric](https://cloud.google.com/monitoring/custom-metrics)
           #   descriptor.
@@ -498,7 +498,7 @@ module Google
           #   metric_service_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
           #   formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path("[PROJECT]")
           #
-          #   # TODO: Initialize +metric_descriptor+:
+          #   # TODO: Initialize `metric_descriptor`:
           #   metric_descriptor = {}
           #   response = metric_service_client.create_metric_descriptor(formatted_name, metric_descriptor)
 
@@ -520,9 +520,9 @@ module Google
           #
           # @param name [String]
           #   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"+.
+          #   `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`.
+          #   An example of `{metric_id}` is:
+          #   `"custom.googleapis.com/my_test_metric"`.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -603,13 +603,13 @@ module Google
           #   metric_service_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
           #   formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path("[PROJECT]")
           #
-          #   # TODO: Initialize +filter+:
+          #   # TODO: Initialize `filter`:
           #   filter = ''
           #
-          #   # TODO: Initialize +interval+:
+          #   # TODO: Initialize `interval`:
           #   interval = {}
           #
-          #   # TODO: Initialize +view+:
+          #   # TODO: Initialize `view`:
           #   view = :FULL
           #
           #   # Iterate over all results.
@@ -655,12 +655,12 @@ module Google
           #
           # @param name [String]
           #   The project on which to execute the request. The format is
-          #   +"projects/\\{project_id_or_number}"+.
+          #   `"projects/{project_id_or_number}"`.
           # @param time_series [Array<Google::Monitoring::V3::TimeSeries | Hash>]
           #   The new data to be added to a list of time series.
           #   Adds at most one data point to each of several time series.  The new data
           #   point must be more recent than any other point in its time series.  Each
-          #   +TimeSeries+ value must fully specify a unique time series by supplying
+          #   `TimeSeries` value must fully specify a unique time series by supplying
           #   all label values for the metric and the monitored resource.
           #   A hash of the same form as `Google::Monitoring::V3::TimeSeries`
           #   can also be provided.
@@ -677,7 +677,7 @@ module Google
           #   metric_service_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
           #   formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path("[PROJECT]")
           #
-          #   # TODO: Initialize +time_series+:
+          #   # TODO: Initialize `time_series`:
           #   time_series = []
           #   metric_service_client.create_time_series(formatted_name, time_series)