google-cloud-monitoring 0.27.0 → 0.28.0

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

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -0,0 +1,28 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Monitoring
+    module V3
+      # Describes a change made to a configuration.
+      # @!attribute [rw] mutate_time
+      #   @return [Google::Protobuf::Timestamp]
+      #     When the change occurred.
+      # @!attribute [rw] mutated_by
+      #   @return [String]
+      #     The email address of the user making the change.
+      class MutationRecord; end
+    end
+  end
+end

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

@@ -0,0 +1,152 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Monitoring
+    module V3
+      # A description of a notification channel. The descriptor includes
+      # the properties of the channel and the set of labels or fields that
+      # must be specified to configure channels of a given type.
+      # @!attribute [rw] name
+      #   @return [String]
+      #     The full REST resource name for this descriptor. The syntax is:
+      #
+      #         projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE]
+      #
+      #     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.
+      #     Notification channel types are globally unique.
+      # @!attribute [rw] display_name
+      #   @return [String]
+      #     A human-readable name for the notification channel type.  This
+      #     form of the name is suitable for a user interface.
+      # @!attribute [rw] description
+      #   @return [String]
+      #     A human-readable description of the notification channel
+      #     type. The description may include a description of the properties
+      #     of the channel and pointers to external documentation.
+      # @!attribute [rw] labels
+      #   @return [Array<Google::Api::LabelDescriptor>]
+      #     The set of labels that must be defined to identify a particular
+      #     channel of the corresponding type. Each label includes a
+      #     description for how that field should be populated.
+      # @!attribute [rw] supported_tiers
+      #   @return [Array<Google::Monitoring::V3::ServiceTier>]
+      #     The tiers that support this notification channel; the project service tier
+      #     must be one of the supported_tiers.
+      class NotificationChannelDescriptor; end
+
+      # 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
+      # contact info are only partially populated on retrieval.
+      # @!attribute [rw] type
+      #   @return [String]
+      #     The type of the notification channel. This field matches the
+      #     value of the {Google::Monitoring::V3::NotificationChannelDescriptor#type NotificationChannelDescriptor#type} field.
+      # @!attribute [rw] name
+      #   @return [String]
+      #     The full REST resource name for this channel. The syntax is:
+      #
+      #         projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
+      #
+      #     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
+      #     recommended that you specify a non-empty and unique name in order to
+      #     make it easier to identify the channels in your project, though this is
+      #     not enforced. The display name is limited to 512 Unicode characters.
+      # @!attribute [rw] description
+      #   @return [String]
+      #     An optional human-readable description of this notification channel. This
+      #     description may provide additional details, beyond the display
+      #     name, for the channel. This may not exceeed 1024 Unicode characters.
+      # @!attribute [rw] labels
+      #   @return [Hash{String => String}]
+      #     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.
+      # @!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 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
+      #     values can contain only lowercase letters, numerals, underscores, and
+      #     dashes. Keys must begin with a letter.
+      # @!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+}
+      #     or
+      #     {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
+      #     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
+      #     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+}
+      #     operation. To change the value of this field, you must call
+      #     {Google::Monitoring::V3::NotificationChannelService::VerifyNotificationChannel +VerifyNotificationChannel+}.
+      # @!attribute [rw] enabled
+      #   @return [Google::Protobuf::BoolValue]
+      #     Whether notifications are forwarded to the described channel. This makes
+      #     it possible to disable delivery of notifications to a particular channel
+      #     without removing the channel from all alerting policies that reference
+      #     the channel. This is a more convenient approach when the change is
+      #     temporary and you want to receive notifications from the same set
+      #     of alerting policies on the channel at some point in the future.
+      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+}
+        # or an
+        # {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel +UpdateNotificationChannel+}
+        # operation.
+        module VerificationStatus
+          # Sentinel value used to indicate that the state is unknown, omitted, or
+          # is not applicable (as in the case of channels that neither support
+          # nor require verification in order to function).
+          VERIFICATION_STATUS_UNSPECIFIED = 0
+
+          # The channel has yet to be verified and requires verification to function.
+          # Note that this state also applies to the case where the verification
+          # process has been initiated by sending a verification code but where
+          # the verification code has not been submitted to complete the process.
+          UNVERIFIED = 1
+
+          # It has been proven that notifications can be received on this
+          # notification channel and that someone on the project has access
+          # to messages that are delivered to that channel.
+          VERIFIED = 2
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,223 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Monitoring
+    module V3
+      # This message configures which resources and services to monitor for
+      # availability.
+      # @!attribute [rw] name
+      #   @return [String]
+      #     A unique resource name for this UptimeCheckConfig. The format is:
+      #
+      #
+      #       +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
+      #     response.
+      # @!attribute [rw] display_name
+      #   @return [String]
+      #     A human-friendly name for the uptime check configuration. The display name
+      #     should be unique within a Stackdriver Account in order to make it easier
+      #     to identify; however, uniqueness is not enforced. Required.
+      # @!attribute [rw] monitored_resource
+      #   @return [Google::Api::MonitoredResource]
+      #     The monitored resource associated with the configuration.
+      # @!attribute [rw] resource_group
+      #   @return [Google::Monitoring::V3::UptimeCheckConfig::ResourceGroup]
+      #     The group resource associated with the configuration.
+      # @!attribute [rw] http_check
+      #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck]
+      #     Contains information needed to make an HTTP or HTTPS check.
+      # @!attribute [rw] tcp_check
+      #   @return [Google::Monitoring::V3::UptimeCheckConfig::TcpCheck]
+      #     Contains information needed to make a TCP check.
+      # @!attribute [rw] period
+      #   @return [Google::Protobuf::Duration]
+      #     How often the uptime check is performed.
+      #     Currently, only 1, 5, 10, and 15 minutes are supported. Required.
+      # @!attribute [rw] timeout
+      #   @return [Google::Protobuf::Duration]
+      #     The maximum amount of time to wait for the request to complete (must be
+      #     between 1 and 60 seconds). Required.
+      # @!attribute [rw] content_matchers
+      #   @return [Array<Google::Monitoring::V3::UptimeCheckConfig::ContentMatcher>]
+      #     The expected content on the page the check is run against.
+      #     Currently, only the first entry in the list is supported, and other entries
+      #     will be ignored. The server will look for an exact match of the string in
+      #     the page response's content. This field is optional and should only be
+      #     specified if a content match is required.
+      # @!attribute [rw] selected_regions
+      #   @return [Array<Google::Monitoring::V3::UptimeCheckRegion>]
+      #     The list of regions from which the check will be run.
+      #     If this field is specified, enough regions to include a minimum of
+      #     3 locations must be provided, or an error message is returned.
+      #     Not specifying this field will result in uptime checks running from all
+      #     regions.
+      # @!attribute [rw] internal_checkers
+      #   @return [Array<Google::Monitoring::V3::UptimeCheckConfig::InternalChecker>]
+      #     The internal checkers that this check will egress from.
+      class UptimeCheckConfig
+        # The resource submessage for group checks. It can be used instead of a
+        # monitored resource, when multiple resources are being monitored.
+        # @!attribute [rw] group_id
+        #   @return [String]
+        #     The group of resources being monitored. Should be only the
+        #     group_id, not projects/<project_id>/groups/<group_id>.
+        # @!attribute [rw] resource_type
+        #   @return [Google::Monitoring::V3::GroupResourceType]
+        #     The resource type of the group members.
+        class ResourceGroup; end
+
+        # Information involved in an HTTP/HTTPS uptime check request.
+        # @!attribute [rw] use_ssl
+        #   @return [true, false]
+        #     If true, use HTTPS instead of HTTP to run the check.
+        # @!attribute [rw] path
+        #   @return [String]
+        #     The path to the page to run the check against. Will be combined with the
+        #     host (specified within the MonitoredResource) and port to construct the
+        #     full URL. Optional (defaults to "/").
+        # @!attribute [rw] port
+        #   @return [Integer]
+        #     The port to the page to run the check against. Will be combined with host
+        #     (specified within the MonitoredResource) and path to construct the full
+        #     URL. Optional (defaults to 80 without SSL, or 443 with SSL).
+        # @!attribute [rw] auth_info
+        #   @return [Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
+        #     The authentication information. Optional when creating an HTTP check;
+        #     defaults to empty.
+        # @!attribute [rw] mask_headers
+        #   @return [true, false]
+        #     Boolean specifiying whether to encrypt the header information.
+        #     Encryption should be specified for any headers related to authentication
+        #     that you do not wish to be seen when retrieving the configuration. The
+        #     server will be responsible for encrypting the headers.
+        #     On Get/List calls, if mask_headers is set to True then the headers
+        #     will be obscured with ******.
+        # @!attribute [rw] headers
+        #   @return [Hash{String => String}]
+        #     The list of headers to send as part of the uptime check request.
+        #     If two headers have the same key and different values, they should
+        #     be entered as a single header, with the value being a comma-separated
+        #     list of all the desired values as described at
+        #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
+        #     Entering two separate headers with the same key in a Create call will
+        #     cause the first to be overwritten by the second.
+        class HttpCheck
+          # A type of authentication to perform against the specified resource or URL
+          # that uses username and password.
+          # Currently, only Basic authentication is supported in Uptime Monitoring.
+          # @!attribute [rw] username
+          #   @return [String]
+          #     The username to authenticate.
+          # @!attribute [rw] password
+          #   @return [String]
+          #     The password to authenticate.
+          class BasicAuthentication; end
+        end
+
+        # Information required for a TCP uptime check request.
+        # @!attribute [rw] port
+        #   @return [Integer]
+        #     The port to the page to run the check against. Will be combined with host
+        #     (specified within the MonitoredResource) to construct the full URL.
+        #     Required.
+        class TcpCheck; end
+
+        # Used to perform string matching. Currently, this matches on the exact
+        # content. In the future, it can be expanded to allow for regular expressions
+        # and more complex matching.
+        # @!attribute [rw] content
+        #   @return [String]
+        #     String content to match
+        class ContentMatcher; end
+
+        # Nimbus InternalCheckers.
+        # @!attribute [rw] project_id
+        #   @return [String]
+        #     The GCP project ID. Not necessarily the same as the project_id for the config.
+        # @!attribute [rw] network
+        #   @return [String]
+        #     The internal network to perform this uptime check on.
+        # @!attribute [rw] gcp_zone
+        #   @return [String]
+        #     The GCP zone the uptime check should egress from. Only respected for
+        #     internal uptime checks, where internal_network is specified.
+        # @!attribute [rw] checker_id
+        #   @return [String]
+        #     The checker ID.
+        # @!attribute [rw] display_name
+        #   @return [String]
+        #     The checker's human-readable name.
+        class InternalChecker; end
+      end
+
+      # Contains the region, location, and list of IP
+      # addresses where checkers in the location run from.
+      # @!attribute [rw] region
+      #   @return [Google::Monitoring::V3::UptimeCheckRegion]
+      #     A broad region category in which the IP address is located.
+      # @!attribute [rw] location
+      #   @return [String]
+      #     A more specific location within the region that typically encodes
+      #     a particular city/town/metro (and its containing state/province or country)
+      #     within the broader umbrella region category.
+      # @!attribute [rw] ip_address
+      #   @return [String]
+      #     The IP address from which the uptime check originates. This is a full
+      #     IP address (not an IP address range). Most IP addresses, as of this
+      #     publication, are in IPv4 format; however, one should not rely on the
+      #     IP addresses being in IPv4 format indefinitely and should support
+      #     interpreting this field in either IPv4 or IPv6 format.
+      class UptimeCheckIp; end
+
+      # The regions from which an uptime check can be run.
+      module UptimeCheckRegion
+        # Default value if no region is specified. Will result in uptime checks
+        # running from all regions.
+        REGION_UNSPECIFIED = 0
+
+        # Allows checks to run from locations within the United States of America.
+        USA = 1
+
+        # Allows checks to run from locations within the continent of Europe.
+        EUROPE = 2
+
+        # Allows checks to run from locations within the continent of South
+        # America.
+        SOUTH_AMERICA = 3
+
+        # Allows checks to run from locations within the Asia Pacific area (ex:
+        # Singapore).
+        ASIA_PACIFIC = 4
+      end
+
+      # The supported resource types that can be used as values of
+      # group_resource.resource_type. gae_app and uptime_url are not allowed
+      # because group checks on App Engine modules and URLs are not allowed.
+      module GroupResourceType
+        # Default value (not valid).
+        RESOURCE_TYPE_UNSPECIFIED = 0
+
+        # A group of instances (could be either GCE or AWS_EC2).
+        INSTANCE = 1
+
+        # A group of AWS load balancers.
+        AWS_ELB_LOAD_BALANCER = 2
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -0,0 +1,223 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Protobuf
+    # +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+.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # = Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # = Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # 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+
+    # string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then the existing sub-message in the target resource is
+    # overwritten. Given the target message:
+    #
+    #     f {
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       c : 1
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d : 10
+    #       }
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: "f.b"
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d : 10
+    #       }
+    #       c : 1
+    #     }
+    #
+    # However, if the update mask was:
+    #
+    #  paths: "f.b.d"
+    #
+    # then the result would be:
+    #
+    #     f {
+    #       b {
+    #         d : 10
+    #         x : 2
+    #       }
+    #       c : 1
+    #     }
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # == Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # = JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for +Profile+ may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # = Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    # @!attribute [rw] paths
+    #   @return [Array<String>]
+    #     The set of field mask paths.
+    class FieldMask; end
+  end
+end