google-cloud-monitoring 0.29.1 → 0.29.2

data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb

@@ -25,7 +25,7 @@ module Google
       #
       #         projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE]
       #
-      #     In the above, +[TYPE]+ is the value of the +type+ field.
+      #     In the above, `[TYPE]` is the value of the `type` field.
       # @!attribute [rw] type
       #   @return [String]
       #     The type of notification channel, such as "email", "sms", etc.
@@ -50,7 +50,7 @@ module Google
       #     must be one of the supported_tiers.
       class NotificationChannelDescriptor; end
 
-      # A +NotificationChannel+ is a medium through which an alert is
+      # A `NotificationChannel` is a medium through which an alert is
       # delivered when a policy violation is detected. Examples of channels
       # include email, SMS, and third-party messaging applications. Fields
       # containing sensitive information like authentication tokens or
@@ -65,7 +65,7 @@ module Google
       #
       #         projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
       #
-      #     The +[CHANNEL_ID]+ is automatically assigned by the server on creation.
+      #     The `[CHANNEL_ID]` is automatically assigned by the server on creation.
       # @!attribute [rw] display_name
       #   @return [String]
       #     An optional human-readable name for this notification channel. It is
@@ -82,13 +82,13 @@ module Google
       #     Configuration fields that define the channel and its behavior. The
       #     permissible and required labels are specified in the
       #     {Google::Monitoring::V3::NotificationChannelDescriptor#labels NotificationChannelDescriptor#labels} of the
-      #     +NotificationChannelDescriptor+ corresponding to the +type+ field.
+      #     `NotificationChannelDescriptor` corresponding to the `type` field.
       # @!attribute [rw] user_labels
       #   @return [Hash{String => String}]
       #     User-supplied key/value data that does not need to conform to
-      #     the corresponding +NotificationChannelDescriptor+'s schema, unlike
-      #     the +labels+ field. This field is intended to be used for organizing
-      #     and identifying the +NotificationChannel+ objects.
+      #     the corresponding `NotificationChannelDescriptor`'s schema, unlike
+      #     the `labels` field. This field is intended to be used for organizing
+      #     and identifying the `NotificationChannel` objects.
       #
       #     The field can contain up to 64 entries. Each key and value is limited to
       #     63 Unicode characters or 128 bytes, whichever is smaller. Labels and
@@ -97,24 +97,24 @@ module Google
       # @!attribute [rw] verification_status
       #   @return [Google::Monitoring::V3::NotificationChannel::VerificationStatus]
       #     Indicates whether this channel has been verified or not. On a
-      #     {Google::Monitoring::V3::NotificationChannelService::ListNotificationChannels +ListNotificationChannels+}
+      #     {Google::Monitoring::V3::NotificationChannelService::ListNotificationChannels `ListNotificationChannels`}
       #     or
-      #     {Google::Monitoring::V3::NotificationChannelService::GetNotificationChannel +GetNotificationChannel+}
+      #     {Google::Monitoring::V3::NotificationChannelService::GetNotificationChannel `GetNotificationChannel`}
       #     operation, this field is expected to be populated.
       #
-      #     If the value is +UNVERIFIED+, then it indicates that the channel is
+      #     If the value is `UNVERIFIED`, then it indicates that the channel is
       #     non-functioning (it both requires verification and lacks verification);
       #     otherwise, it is assumed that the channel works.
       #
-      #     If the channel is neither +VERIFIED+ nor +UNVERIFIED+, it implies that
+      #     If the channel is neither `VERIFIED` nor `UNVERIFIED`, it implies that
       #     the channel is of a type that does not require verification or that
       #     this specific channel has been exempted from verification because it was
       #     created prior to verification being required for channels of this type.
       #
       #     This field cannot be modified using a standard
-      #     {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel +UpdateNotificationChannel+}
+      #     {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel `UpdateNotificationChannel`}
       #     operation. To change the value of this field, you must call
-      #     {Google::Monitoring::V3::NotificationChannelService::VerifyNotificationChannel +VerifyNotificationChannel+}.
+      #     {Google::Monitoring::V3::NotificationChannelService::VerifyNotificationChannel `VerifyNotificationChannel`}.
       # @!attribute [rw] enabled
       #   @return [Google::Protobuf::BoolValue]
       #     Whether notifications are forwarded to the described channel. This makes
@@ -126,9 +126,9 @@ module Google
       class NotificationChannel
         # Indicates whether the channel has been verified or not. It is illegal
         # to specify this field in a
-        # {Google::Monitoring::V3::NotificationChannelService::CreateNotificationChannel +CreateNotificationChannel+}
+        # {Google::Monitoring::V3::NotificationChannelService::CreateNotificationChannel `CreateNotificationChannel`}
         # or an
-        # {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel +UpdateNotificationChannel+}
+        # {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel `UpdateNotificationChannel`}
         # operation.
         module VerificationStatus
           # Sentinel value used to indicate that the state is unknown, omitted, or

data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification_service.rb

@@ -16,7 +16,7 @@
 module Google
   module Monitoring
     module V3
-      # The +ListNotificationChannelDescriptors+ request.
+      # The `ListNotificationChannelDescriptors` request.
       # @!attribute [rw] name
       #   @return [String]
       #     The REST resource name of the parent from which to retrieve
@@ -35,12 +35,12 @@ module Google
       #     service.
       # @!attribute [rw] page_token
       #   @return [String]
-      #     If non-empty, +page_token+ must contain a value returned as the
-      #     +next_page_token+ in a previous response to request the next set
+      #     If non-empty, `page_token` must contain a value returned as the
+      #     `next_page_token` in a previous response to request the next set
       #     of results.
       class ListNotificationChannelDescriptorsRequest; end
 
-      # The +ListNotificationChannelDescriptors+ response.
+      # The `ListNotificationChannelDescriptors` response.
       # @!attribute [rw] channel_descriptors
       #   @return [Array<Google::Monitoring::V3::NotificationChannelDescriptor>]
       #     The monitored resource descriptors supported for the specified
@@ -48,19 +48,19 @@ module Google
       # @!attribute [rw] next_page_token
       #   @return [String]
       #     If not empty, indicates that there may be more results that match
-      #     the request. Use the value in the +page_token+ field in a
+      #     the request. Use the value in the `page_token` field in a
       #     subsequent request to fetch the next set of results. If empty,
       #     all results have been returned.
       class ListNotificationChannelDescriptorsResponse; end
 
-      # The +GetNotificationChannelDescriptor+ response.
+      # The `GetNotificationChannelDescriptor` response.
       # @!attribute [rw] name
       #   @return [String]
       #     The channel type for which to execute the request. The format is
-      #     +projects/[PROJECT_ID]/notificationChannelDescriptors/\\{channel_type}+.
+      #     `projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}`.
       class GetNotificationChannelDescriptorRequest; end
 
-      # The +CreateNotificationChannel+ request.
+      # The `CreateNotificationChannel` request.
       # @!attribute [rw] name
       #   @return [String]
       #     The project on which to execute the request. The format is:
@@ -70,21 +70,21 @@ module Google
       #     Note that this names the container into which the channel will be
       #     written. This does not name the newly created channel. The resulting
       #     channel's name will have a normalized version of this field as a prefix,
-      #     but will add +/notificationChannels/[CHANNEL_ID]+ to identify the channel.
+      #     but will add `/notificationChannels/[CHANNEL_ID]` to identify the channel.
       # @!attribute [rw] notification_channel
       #   @return [Google::Monitoring::V3::NotificationChannel]
-      #     The definition of the +NotificationChannel+ to create.
+      #     The definition of the `NotificationChannel` to create.
       class CreateNotificationChannelRequest; end
 
-      # The +ListNotificationChannels+ request.
+      # The `ListNotificationChannels` request.
       # @!attribute [rw] name
       #   @return [String]
       #     The project on which to execute the request. The format is
-      #     +projects/[PROJECT_ID]+. That is, this names the container
+      #     `projects/[PROJECT_ID]`. That is, this names the container
       #     in which to look for the notification channels; it does not name a
       #     specific channel. To query a specific channel by REST resource name, use
       #     the
-      #     {Google::Monitoring::V3::NotificationChannelService::GetNotificationChannel +GetNotificationChannel+} operation.
+      #     {Google::Monitoring::V3::NotificationChannelService::GetNotificationChannel `GetNotificationChannel`} operation.
       # @!attribute [rw] filter
       #   @return [String]
       #     If provided, this field specifies the criteria that must be met by
@@ -95,7 +95,7 @@ module Google
       # @!attribute [rw] order_by
       #   @return [String]
       #     A comma-separated list of fields by which to sort the result. Supports
-      #     the same set of fields as in +filter+. Entries can be prefixed with
+      #     the same set of fields as in `filter`. Entries can be prefixed with
       #     a minus sign to sort in descending rather than ascending order.
       #
       #     For more details, see [sorting and
@@ -107,31 +107,31 @@ module Google
       #     service.
       # @!attribute [rw] page_token
       #   @return [String]
-      #     If non-empty, +page_token+ must contain a value returned as the
-      #     +next_page_token+ in a previous response to request the next set
+      #     If non-empty, `page_token` must contain a value returned as the
+      #     `next_page_token` in a previous response to request the next set
       #     of results.
       class ListNotificationChannelsRequest; end
 
-      # The +ListNotificationChannels+ response.
+      # The `ListNotificationChannels` response.
       # @!attribute [rw] notification_channels
       #   @return [Array<Google::Monitoring::V3::NotificationChannel>]
       #     The notification channels defined for the specified project.
       # @!attribute [rw] next_page_token
       #   @return [String]
       #     If not empty, indicates that there may be more results that match
-      #     the request. Use the value in the +page_token+ field in a
+      #     the request. Use the value in the `page_token` field in a
       #     subsequent request to fetch the next set of results. If empty,
       #     all results have been returned.
       class ListNotificationChannelsResponse; end
 
-      # The +GetNotificationChannel+ request.
+      # The `GetNotificationChannel` request.
       # @!attribute [rw] name
       #   @return [String]
       #     The channel for which to execute the request. The format is
-      #     +projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]+.
+      #     `projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]`.
       class GetNotificationChannelRequest; end
 
-      # The +UpdateNotificationChannel+ request.
+      # The `UpdateNotificationChannel` request.
       # @!attribute [rw] update_mask
       #   @return [Google::Protobuf::FieldMask]
       #     The fields to update.
@@ -140,14 +140,14 @@ module Google
       #     A description of the changes to be applied to the specified
       #     notification channel. The description must provide a definition for
       #     fields to be updated; the names of these fields should also be
-      #     included in the +update_mask+.
+      #     included in the `update_mask`.
       class UpdateNotificationChannelRequest; end
 
-      # The +DeleteNotificationChannel+ request.
+      # The `DeleteNotificationChannel` request.
       # @!attribute [rw] name
       #   @return [String]
       #     The channel for which to execute the request. The format is
-      #     +projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]+.
+      #     `projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]`.
       # @!attribute [rw] force
       #   @return [true, false]
       #     If true, the notification channel will be deleted regardless of its
@@ -156,13 +156,13 @@ module Google
       #     alerting policy will fail to be deleted in a delete operation.
       class DeleteNotificationChannelRequest; end
 
-      # The +SendNotificationChannelVerificationCode+ request.
+      # The `SendNotificationChannelVerificationCode` request.
       # @!attribute [rw] name
       #   @return [String]
       #     The notification channel to which to send a verification code.
       class SendNotificationChannelVerificationCodeRequest; end
 
-      # The +GetNotificationChannelVerificationCode+ request.
+      # The `GetNotificationChannelVerificationCode` request.
       # @!attribute [rw] name
       #   @return [String]
       #     The notification channel for which a verification code is to be generated
@@ -181,7 +181,7 @@ module Google
       #     impose an upper limit on the maximum expiration that is permitted).
       class GetNotificationChannelVerificationCodeRequest; end
 
-      # The +GetNotificationChannelVerificationCode+ request.
+      # The `GetNotificationChannelVerificationCode` request.
       # @!attribute [rw] code
       #   @return [String]
       #     The verification code, which may be used to verify other channels
@@ -195,16 +195,16 @@ module Google
       #     requested expiration in the request and the max permitted expiration.
       class GetNotificationChannelVerificationCodeResponse; end
 
-      # The +VerifyNotificationChannel+ request.
+      # The `VerifyNotificationChannel` request.
       # @!attribute [rw] name
       #   @return [String]
       #     The notification channel to verify.
       # @!attribute [rw] code
       #   @return [String]
       #     The verification code that was delivered to the channel as
-      #     a result of invoking the +SendNotificationChannelVerificationCode+ API
+      #     a result of invoking the `SendNotificationChannelVerificationCode` API
       #     method or that was retrieved from a verified channel via
-      #     +GetNotificationChannelVerificationCode+. For example, one might have
+      #     `GetNotificationChannelVerificationCode`. For example, one might have
       #     "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only
       #     guaranteed that the code is valid UTF-8; one should not
       #     make any assumptions regarding the structure or format of the code).

data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb

@@ -43,7 +43,7 @@ module Google
       #     A unique resource name for this UptimeCheckConfig. The format is:
       #
       #
-      #       +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.
+      #       `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
       #
       #     This field should be omitted when creating the uptime check configuration;
       #     on create, the resource name is assigned by the server and included in the
@@ -76,9 +76,9 @@ module Google
       # @!attribute [rw] period
       #   @return [Google::Protobuf::Duration]
       #     How often, in seconds, the uptime check is performed.
-      #     Currently, the only supported values are +60s+ (1 minute), +300s+
-      #     (5 minutes), +600s+ (10 minutes), and +900s+ (15 minutes). Optional,
-      #     defaults to +300s+.
+      #     Currently, the only supported values are `60s` (1 minute), `300s`
+      #     (5 minutes), `600s` (10 minutes), and `900s` (15 minutes). Optional,
+      #     defaults to `300s`.
       # @!attribute [rw] timeout
       #   @return [Google::Protobuf::Duration]
       #     The maximum amount of time to wait for the request to complete (must be
@@ -102,7 +102,7 @@ module Google
       #     Denotes whether this is a check that egresses from InternalCheckers.
       # @!attribute [rw] internal_checkers
       #   @return [Array<Google::Monitoring::V3::InternalChecker>]
-      #     The internal checkers that this check will egress from. If +is_internal+ is
+      #     The internal checkers that this check will egress from. If `is_internal` is
       #     true and this list is empty, the check will egress from all
       #     InternalCheckers configured for the project that owns this CheckConfig.
       class UptimeCheckConfig
@@ -224,9 +224,9 @@ module Google
       end
 
       # The supported resource types that can be used as values of
-      # +group_resource.resource_type+.
-      # +INSTANCE+ includes +gce_instance+ and +aws_ec2_instance+ resource types.
-      # The resource types +gae_app+ and +uptime_url+ are not valid here because
+      # `group_resource.resource_type`.
+      # `INSTANCE` includes `gce_instance` and `aws_ec2_instance` resource types.
+      # The resource types `gae_app` and `uptime_url` are not valid here because
       # group checks on App Engine modules and URLs are not allowed.
       module GroupResourceType
         # Default value (not valid).

data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime_service.rb

@@ -16,11 +16,11 @@
 module Google
   module Monitoring
     module V3
-      # The protocol for the +ListUptimeCheckConfigs+ request.
+      # The protocol for the `ListUptimeCheckConfigs` request.
       # @!attribute [rw] parent
       #   @return [String]
       #     The project whose uptime check configurations are listed. The format
-      #       is +projects/[PROJECT_ID]+.
+      #       is `projects/[PROJECT_ID]`.
       # @!attribute [rw] page_size
       #   @return [Integer]
       #     The maximum number of results to return in a single response. The server
@@ -29,12 +29,12 @@ module Google
       #     to be returned.
       # @!attribute [rw] page_token
       #   @return [String]
-      #     If this field is not empty then it must contain the +nextPageToken+ value
+      #     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
       #     method to return more results from the previous method call.
       class ListUptimeCheckConfigsRequest; end
 
-      # The protocol for the +ListUptimeCheckConfigs+ response.
+      # The protocol for the `ListUptimeCheckConfigs` response.
       # @!attribute [rw] uptime_check_configs
       #   @return [Array<Google::Monitoring::V3::UptimeCheckConfig>]
       #     The returned uptime check configurations.
@@ -51,24 +51,24 @@ module Google
       #     irrespective of any pagination.
       class ListUptimeCheckConfigsResponse; end
 
-      # The protocol for the +GetUptimeCheckConfig+ request.
+      # The protocol for the `GetUptimeCheckConfig` request.
       # @!attribute [rw] name
       #   @return [String]
       #     The uptime check configuration to retrieve. The format
-      #       is +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.
+      #       is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
       class GetUptimeCheckConfigRequest; end
 
-      # The protocol for the +CreateUptimeCheckConfig+ request.
+      # The protocol for the `CreateUptimeCheckConfig` request.
       # @!attribute [rw] parent
       #   @return [String]
       #     The project in which to create the uptime check. The format
-      #       is +projects/[PROJECT_ID]+.
+      #       is `projects/[PROJECT_ID]`.
       # @!attribute [rw] uptime_check_config
       #   @return [Google::Monitoring::V3::UptimeCheckConfig]
       #     The new uptime check configuration.
       class CreateUptimeCheckConfigRequest; end
 
-      # The protocol for the +UpdateUptimeCheckConfig+ request.
+      # The protocol for the `UpdateUptimeCheckConfig` request.
       # @!attribute [rw] update_mask
       #   @return [Google::Protobuf::FieldMask]
       #     Optional. If present, only the listed fields in the current uptime check
@@ -77,27 +77,27 @@ module Google
       #     the new configuration.
       # @!attribute [rw] uptime_check_config
       #   @return [Google::Monitoring::V3::UptimeCheckConfig]
-      #     Required. If an +"updateMask"+ has been specified, this field gives
-      #     the values for the set of fields mentioned in the +"updateMask"+. If an
-      #     +"updateMask"+ has not been given, this uptime check configuration replaces
-      #     the current configuration. If a field is mentioned in +"updateMask"+ but
+      #     Required. If an `"updateMask"` has been specified, this field gives
+      #     the values for the set of fields mentioned in the `"updateMask"`. If an
+      #     `"updateMask"` has not been given, this uptime check configuration replaces
+      #     the current configuration. If a field is mentioned in `"updateMask"` but
       #     the corresonding field is omitted in this partial uptime check
       #     configuration, it has the effect of deleting/clearing the field from the
       #     configuration on the server.
       #
-      #     The following fields can be updated: +display_name+,
-      #     +http_check+, +tcp_check+, +timeout+, +content_matchers+, and
-      #     +selected_regions+.
+      #     The following fields can be updated: `display_name`,
+      #     `http_check`, `tcp_check`, `timeout`, `content_matchers`, and
+      #     `selected_regions`.
       class UpdateUptimeCheckConfigRequest; end
 
-      # The protocol for the +DeleteUptimeCheckConfig+ request.
+      # The protocol for the `DeleteUptimeCheckConfig` request.
       # @!attribute [rw] name
       #   @return [String]
       #     The uptime check configuration to delete. The format
-      #       is +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.
+      #       is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
       class DeleteUptimeCheckConfigRequest; end
 
-      # The protocol for the +ListUptimeCheckIps+ request.
+      # The protocol for the `ListUptimeCheckIps` request.
       # @!attribute [rw] page_size
       #   @return [Integer]
       #     The maximum number of results to return in a single response. The server
@@ -107,13 +107,13 @@ module Google
       #     NOTE: this field is not yet implemented
       # @!attribute [rw] page_token
       #   @return [String]
-      #     If this field is not empty then it must contain the +nextPageToken+ value
+      #     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
       #     method to return more results from the previous method call.
       #     NOTE: this field is not yet implemented
       class ListUptimeCheckIpsRequest; end
 
-      # The protocol for the +ListUptimeCheckIps+ response.
+      # The protocol for the `ListUptimeCheckIps` response.
       # @!attribute [rw] uptime_check_ips
       #   @return [Array<Google::Monitoring::V3::UptimeCheckIp>]
       #     The returned list of IP addresses (including region and location) that the

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

@@ -15,7 +15,7 @@
 
 module Google
   module Protobuf
-    # +Any+ contains an arbitrary serialized protocol buffer message along with a
+    # `Any` contains an arbitrary serialized protocol buffer message along with a
     # URL that describes the type of the serialized message.
     #
     # Protobuf library provides support to pack/unpack Any values in the form
@@ -69,9 +69,9 @@ module Google
     #
     # = JSON
     #
-    # The JSON representation of an +Any+ value uses the regular
+    # The JSON representation of an `Any` value uses the regular
     # representation of the deserialized, embedded message, with an
-    # additional field +@type+ which contains the type URL. Example:
+    # additional field `@type` which contains the type URL. Example:
     #
     #     package google.profile;
     #     message Person {
@@ -87,7 +87,7 @@ module Google
     #
     # If the embedded message type is well-known and has a custom JSON
     # representation, that representation will be embedded adding a field
-    # +value+ which holds the custom JSON in addition to the +@type+
+    # `value` which holds the custom JSON in addition to the `@type`
     # field. Example (for message {Google::Protobuf::Duration}):
     #
     #     {
@@ -99,15 +99,15 @@ module Google
     #     A URL/resource name that uniquely identifies the type of the serialized
     #     protocol buffer message. The last segment of the URL's path must represent
     #     the fully qualified name of the type (as in
-    #     +path/google.protobuf.Duration+). The name should be in a canonical form
+    #     `path/google.protobuf.Duration`). The name should be in a canonical form
     #     (e.g., leading "." is not accepted).
     #
     #     In practice, teams usually precompile into the binary all types that they
     #     expect it to use in the context of Any. However, for URLs which use the
-    #     scheme +http+, +https+, or no scheme, one can optionally set up a type
+    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
     #     server that maps type URLs to message definitions as follows:
     #
-    #     * If no scheme is provided, +https+ is assumed.
+    #     * If no scheme is provided, `https` is assumed.
     #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
     #       value in binary format, or produce an error.
     #     * Applications are allowed to cache lookup results based on the
@@ -120,7 +120,7 @@ module Google
     #     protobuf release, and it is not used for type URLs beginning with
     #     type.googleapis.com.
     #
-    #     Schemes other than +http+, +https+ (or the empty scheme) might be
+    #     Schemes other than `http`, `https` (or the empty scheme) might be
     #     used with implementation specific semantics.
     # @!attribute [rw] value
     #   @return [String]