google-cloud-trace 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c66c46c37ec4448e49ac2fddd212eceb6955fc372affcda365b2df92695b0681
-  data.tar.gz: b2258c73168191d36cb4f856c8090dfd0895dc8d8f0c569b2e02ea8eb69ed06c
+  metadata.gz: d574f63df936d1b723a90b85edd1b3d47bdf9277551a3381805dc81948f307bd
+  data.tar.gz: 2c74ee01e1ea547d8c571af74a012c89007843c8f63677ecf0a65c582006db14
 SHA512:
-  metadata.gz: 5f1fa9ad6cd0227e39dceba174113c7784902711153af5a8632f34bc33265179b9ecc914dfdba6c79f20577fa7368f33683acfbf0086561b77b1a8498e7a6e98
-  data.tar.gz: 6a9d28122b87f7eca21f2a29101d8736e903405fea5d802fd97db2ca15718553c00a23935cb1a1c1c786d3e67be61344ea8912a759f0804621d3c6465af4b0c4
+  metadata.gz: 25ee616dfaba762ca236c4501c1e385ae498f6d85f177c18eab8b6508c64d710d877a885a49565d537c561c79b5dd788cb059c43ca574d91800f3da6b458b7af
+  data.tar.gz: 12339946132e7d8bc218ff64ab1cb191ea3a9dc3a93e25e4e03b42713d42df763aa2809051c52ab8adb181075d0913903d1d849e9bfb47ff9fc58ee4b0214426

data/lib/google/cloud/trace/v2.rb

@@ -0,0 +1,114 @@
+# Copyright 2017 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.
+
+require "google/cloud/trace/v2/trace_service_client"
+
+module Google
+  module Cloud
+    # rubocop:disable LineLength
+
+    ##
+    # # Ruby Client for Stackdriver Trace API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    #
+    # [Stackdriver Trace API][Product Documentation]:
+    # Sends application trace data to Stackdriver Trace for viewing. Trace data is
+    # collected for all App Engine applications by default. Trace data from other
+    # applications can be provided using this API.
+    # - [Product Documentation][]
+    #
+    # ## Quick Start
+    # In order to use this library, you first need to go through the following
+    # steps:
+    #
+    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+    # 3. [Enable the Stackdriver Trace API.](https://console.cloud.google.com/apis/api/trace)
+    # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Preview
+    # #### TraceServiceClient
+    # ```rb
+    # require "google/cloud/trace/v2"
+    #
+    # trace_service_client = Google::Cloud::Trace::V2.new
+    # formatted_name = Google::Cloud::Trace::V2::TraceServiceClient.project_path(project_id)
+    # spans = []
+    # trace_service_client.batch_write_spans(formatted_name, spans)
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [Stackdriver Trace API Product documentation][Product Documentation]
+    #   to learn more about the product and see How-to Guides.
+    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+    #   to see the full list of Cloud APIs that we cover.
+    #
+    # [Product Documentation]: https://cloud.google.com/trace
+    #
+    #
+    module Trace
+      module V2
+        # rubocop:enable LineLength
+
+        ##
+        # This file describes an API for collecting and viewing traces and spans
+        # within a trace.  A Trace is a collection of spans corresponding to a single
+        # operation or set of operations for an application. A span is an individual
+        # timed event which forms a node of the trace tree. A single trace may
+        # contain span(s) from multiple services.
+        #
+        # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+        #   Provides the means for authenticating requests made by the client. This parameter can
+        #   be many types.
+        #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+        #   authenticating requests made by this client.
+        #   A `String` will be treated as the path to the keyfile to be used for the construction of
+        #   credentials for this client.
+        #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+        #   credentials for this client.
+        #   A `GRPC::Core::Channel` will be used to make calls through.
+        #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+        #   should already be composed with a `GRPC::Core::CallCredentials` object.
+        #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+        #   metadata for requests, generally, to give OAuth credentials.
+        # @param scopes [Array<String>]
+        #   The OAuth scopes for this service. This parameter is ignored if
+        #   an updater_proc is supplied.
+        # @param client_config [Hash]
+        #   A Hash for call options for each method. See
+        #   Google::Gax#construct_settings for the structure of
+        #   this data. Falls back to the default config if not specified
+        #   or the specified config is missing data points.
+        # @param timeout [Numeric]
+        #   The default timeout, in seconds, for calls made through this client.
+        def self.new \
+            credentials: nil,
+            scopes: nil,
+            client_config: nil,
+            timeout: nil,
+            lib_name: nil,
+            lib_version: nil
+          kwargs = {
+            credentials: credentials,
+            scopes: scopes,
+            client_config: client_config,
+            timeout: timeout,
+            lib_name: lib_name,
+            lib_version: lib_version
+          }.select { |_, v| v != nil }
+          Google::Cloud::Trace::V2::TraceServiceClient.new(**kwargs)
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/trace/v2/doc/google/devtools/cloudtrace/v2/trace.rb

@@ -0,0 +1,320 @@
+# Copyright 2017 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 Devtools
+    module Cloudtrace
+      module V2
+        # A span represents a single operation within a trace. Spans can be
+        # nested to form a trace tree. Often, a trace contains a root span
+        # that describes the end-to-end latency, and one or more subspans for
+        # its sub-operations. A trace can also contain multiple root spans,
+        # or none at all. Spans do not need to be contiguous—there may be
+        # gaps or overlaps between spans in a trace.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The resource name of the span in the following format:
+        #
+        #         projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]
+        #
+        #     [TRACE_ID] is a unique identifier for a trace within a project;
+        #     it is a 32-character hexadecimal encoding of a 16-byte array.
+        #
+        #     [SPAN_ID] is a unique identifier for a span within a trace; it
+        #     is a 16-character hexadecimal encoding of an 8-byte array.
+        # @!attribute [rw] span_id
+        #   @return [String]
+        #     The [SPAN_ID] portion of the span's resource name.
+        # @!attribute [rw] parent_span_id
+        #   @return [String]
+        #     The [SPAN_ID] of this span's parent span. If this is a root span,
+        #     then this field must be empty.
+        # @!attribute [rw] display_name
+        #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
+        #     A description of the span's operation (up to 128 bytes).
+        #     Stackdriver Trace displays the description in the
+        #     {% dynamic print site_values.console_name %}.
+        #     For example, the display name can be a qualified method name or a file name
+        #     and a line number where the operation is called. A best practice is to use
+        #     the same display name within an application and at the same call point.
+        #     This makes it easier to correlate spans in different traces.
+        # @!attribute [rw] start_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     The start time of the span. On the client side, this is the time kept by
+        #     the local machine where the span execution starts. On the server side, this
+        #     is the time when the server's application handler starts running.
+        # @!attribute [rw] end_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     The end time of the span. On the client side, this is the time kept by
+        #     the local machine where the span execution ends. On the server side, this
+        #     is the time when the server application handler stops running.
+        # @!attribute [rw] attributes
+        #   @return [Google::Devtools::Cloudtrace::V2::Span::Attributes]
+        #     A set of attributes on the span. You can have up to 32 attributes per
+        #     span.
+        # @!attribute [rw] stack_trace
+        #   @return [Google::Devtools::Cloudtrace::V2::StackTrace]
+        #     Stack trace captured at the start of the span.
+        # @!attribute [rw] time_events
+        #   @return [Google::Devtools::Cloudtrace::V2::Span::TimeEvents]
+        #     A set of time events. You can have up to 32 annotations and 128 message
+        #     events per span.
+        # @!attribute [rw] links
+        #   @return [Google::Devtools::Cloudtrace::V2::Span::Links]
+        #     Links associated with the span. You can have up to 128 links per Span.
+        # @!attribute [rw] status
+        #   @return [Google::Rpc::Status]
+        #     An optional final status for this span.
+        # @!attribute [rw] same_process_as_parent_span
+        #   @return [Google::Protobuf::BoolValue]
+        #     (Optional) Set this parameter to indicate whether this span is in
+        #     the same process as its parent. If you do not set this parameter,
+        #     Stackdriver Trace is unable to take advantage of this helpful
+        #     information.
+        # @!attribute [rw] child_span_count
+        #   @return [Google::Protobuf::Int32Value]
+        #     An optional number of child spans that were generated while this span
+        #     was active. If set, allows implementation to detect missing child spans.
+        class Span
+          # A set of attributes, each in the format +[KEY]:[VALUE]+.
+          # @!attribute [rw] attribute_map
+          #   @return [Hash{String => Google::Devtools::Cloudtrace::V2::AttributeValue}]
+          #     The set of attributes. Each attribute's key can be up to 128 bytes
+          #     long. The value can be a string up to 256 bytes, an integer, or the
+          #     Boolean values +true+ and +false+. For example:
+          #
+          #         "/instance_id": "my-instance"
+          #         "/http/user_agent": ""
+          #         "/http/request_bytes": 300
+          #         "abc.com/myattribute": true
+          # @!attribute [rw] dropped_attributes_count
+          #   @return [Integer]
+          #     The number of attributes that were discarded. Attributes can be discarded
+          #     because their keys are too long or because there are too many attributes.
+          #     If this value is 0 then all attributes are valid.
+          class Attributes; end
+
+          # A time-stamped annotation or message event in the Span.
+          # @!attribute [rw] time
+          #   @return [Google::Protobuf::Timestamp]
+          #     The timestamp indicating the time the event occurred.
+          # @!attribute [rw] annotation
+          #   @return [Google::Devtools::Cloudtrace::V2::Span::TimeEvent::Annotation]
+          #     Text annotation with a set of attributes.
+          # @!attribute [rw] message_event
+          #   @return [Google::Devtools::Cloudtrace::V2::Span::TimeEvent::MessageEvent]
+          #     An event describing a message sent/received between Spans.
+          class TimeEvent
+            # Text annotation with a set of attributes.
+            # @!attribute [rw] description
+            #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
+            #     A user-supplied message describing the event. The maximum length for
+            #     the description is 256 bytes.
+            # @!attribute [rw] attributes
+            #   @return [Google::Devtools::Cloudtrace::V2::Span::Attributes]
+            #     A set of attributes on the annotation. You can have up to 4 attributes
+            #     per Annotation.
+            class Annotation; end
+
+            # An event describing a message sent/received between Spans.
+            # @!attribute [rw] type
+            #   @return [Google::Devtools::Cloudtrace::V2::Span::TimeEvent::MessageEvent::Type]
+            #     Type of MessageEvent. Indicates whether the message was sent or
+            #     received.
+            # @!attribute [rw] id
+            #   @return [Integer]
+            #     An identifier for the MessageEvent's message that can be used to match
+            #     SENT and RECEIVED MessageEvents. It is recommended to be unique within
+            #     a Span.
+            # @!attribute [rw] uncompressed_size_bytes
+            #   @return [Integer]
+            #     The number of uncompressed bytes sent or received.
+            # @!attribute [rw] compressed_size_bytes
+            #   @return [Integer]
+            #     The number of compressed bytes sent or received. If missing assumed to
+            #     be the same size as uncompressed.
+            class MessageEvent
+              # Indicates whether the message was sent or received.
+              module Type
+                # Unknown event type.
+                TYPE_UNSPECIFIED = 0
+
+                # Indicates a sent message.
+                SENT = 1
+
+                # Indicates a received message.
+                RECEIVED = 2
+              end
+            end
+          end
+
+          # A collection of +TimeEvent+s. A +TimeEvent+ is a time-stamped annotation
+          # on the span, consisting of either user-supplied key:value pairs, or
+          # details of a message sent/received between Spans.
+          # @!attribute [rw] time_event
+          #   @return [Array<Google::Devtools::Cloudtrace::V2::Span::TimeEvent>]
+          #     A collection of +TimeEvent+s.
+          # @!attribute [rw] dropped_annotations_count
+          #   @return [Integer]
+          #     The number of dropped annotations in all the included time events.
+          #     If the value is 0, then no annotations were dropped.
+          # @!attribute [rw] dropped_message_events_count
+          #   @return [Integer]
+          #     The number of dropped message events in all the included time events.
+          #     If the value is 0, then no message events were dropped.
+          class TimeEvents; end
+
+          # A pointer from the current span to another span in the same trace or in a
+          # different trace. For example, this can be used in batching operations,
+          # where a single batch handler processes multiple requests from different
+          # traces or when the handler receives a request from a different project.
+          # @!attribute [rw] trace_id
+          #   @return [String]
+          #     The [TRACE_ID] for a trace within a project.
+          # @!attribute [rw] span_id
+          #   @return [String]
+          #     The [SPAN_ID] for a span within a trace.
+          # @!attribute [rw] type
+          #   @return [Google::Devtools::Cloudtrace::V2::Span::Link::Type]
+          #     The relationship of the current span relative to the linked span.
+          # @!attribute [rw] attributes
+          #   @return [Google::Devtools::Cloudtrace::V2::Span::Attributes]
+          #     A set of attributes on the link. You have have up to  32 attributes per
+          #     link.
+          class Link
+            # The relationship of the current span relative to the linked span: child,
+            # parent, or unspecified.
+            module Type
+              # The relationship of the two spans is unknown.
+              TYPE_UNSPECIFIED = 0
+
+              # The linked span is a child of the current span.
+              CHILD_LINKED_SPAN = 1
+
+              # The linked span is a parent of the current span.
+              PARENT_LINKED_SPAN = 2
+            end
+          end
+
+          # A collection of links, which are references from this span to a span
+          # in the same or different trace.
+          # @!attribute [rw] link
+          #   @return [Array<Google::Devtools::Cloudtrace::V2::Span::Link>]
+          #     A collection of links.
+          # @!attribute [rw] dropped_links_count
+          #   @return [Integer]
+          #     The number of dropped links after the maximum size was enforced. If
+          #     this value is 0, then no links were dropped.
+          class Links; end
+        end
+
+        # The allowed types for [VALUE] in a +[KEY]:[VALUE]+ attribute.
+        # @!attribute [rw] string_value
+        #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
+        #     A string up to 256 bytes long.
+        # @!attribute [rw] int_value
+        #   @return [Integer]
+        #     A 64-bit signed integer.
+        # @!attribute [rw] bool_value
+        #   @return [true, false]
+        #     A Boolean value represented by +true+ or +false+.
+        class AttributeValue; end
+
+        # A call stack appearing in a trace.
+        # @!attribute [rw] stack_frames
+        #   @return [Google::Devtools::Cloudtrace::V2::StackTrace::StackFrames]
+        #     Stack frames in this stack trace. A maximum of 128 frames are allowed.
+        # @!attribute [rw] stack_trace_hash_id
+        #   @return [Integer]
+        #     The hash ID is used to conserve network bandwidth for duplicate
+        #     stack traces within a single trace.
+        #
+        #     Often multiple spans will have identical stack traces.
+        #     The first occurrence of a stack trace should contain both the
+        #     +stackFrame+ content and a value in +stackTraceHashId+.
+        #
+        #     Subsequent spans within the same request can refer
+        #     to that stack trace by only setting +stackTraceHashId+.
+        class StackTrace
+          # Represents a single stack frame in a stack trace.
+          # @!attribute [rw] function_name
+          #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
+          #     The fully-qualified name that uniquely identifies the function or
+          #     method that is active in this frame (up to 1024 bytes).
+          # @!attribute [rw] original_function_name
+          #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
+          #     An un-mangled function name, if +function_name+ is
+          #     [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can
+          #     be fully-qualified (up to 1024 bytes).
+          # @!attribute [rw] file_name
+          #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
+          #     The name of the source file where the function call appears (up to 256
+          #     bytes).
+          # @!attribute [rw] line_number
+          #   @return [Integer]
+          #     The line number in +file_name+ where the function call appears.
+          # @!attribute [rw] column_number
+          #   @return [Integer]
+          #     The column number where the function call appears, if available.
+          #     This is important in JavaScript because of its anonymous functions.
+          # @!attribute [rw] load_module
+          #   @return [Google::Devtools::Cloudtrace::V2::Module]
+          #     The binary module from where the code was loaded.
+          # @!attribute [rw] source_version
+          #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
+          #     The version of the deployed source code (up to 128 bytes).
+          class StackFrame; end
+
+          # A collection of stack frames, which can be truncated.
+          # @!attribute [rw] frame
+          #   @return [Array<Google::Devtools::Cloudtrace::V2::StackTrace::StackFrame>]
+          #     Stack frames in this call stack.
+          # @!attribute [rw] dropped_frames_count
+          #   @return [Integer]
+          #     The number of stack frames that were dropped because there
+          #     were too many stack frames.
+          #     If this value is 0, then no stack frames were dropped.
+          class StackFrames; end
+        end
+
+        # Binary module.
+        # @!attribute [rw] module
+        #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
+        #     For example: main binary, kernel modules, and dynamic libraries
+        #     such as libc.so, sharedlib.so (up to 256 bytes).
+        # @!attribute [rw] build_id
+        #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
+        #     A unique identifier for the module, usually a hash of its
+        #     contents (up to 128 bytes).
+        class Module; end
+
+        # Represents a string that might be shortened to a specified length.
+        # @!attribute [rw] value
+        #   @return [String]
+        #     The shortened string. For example, if the original string is 500
+        #     bytes long and the limit of the string is 128 bytes, then
+        #     +value+ contains the first 128 bytes of the 500-byte string.
+        #
+        #     Truncation always happens on a UTF8 character boundary. If there
+        #     are multi-byte characters in the string, then the length of the
+        #     shortened string might be less than the size limit.
+        # @!attribute [rw] truncated_byte_count
+        #   @return [Integer]
+        #     The number of bytes removed from the original string. If this
+        #     value is 0, then the string was not shortened.
+        class TruncatableString; end
+      end
+    end
+  end
+end

data/lib/google/cloud/trace/v2/doc/google/protobuf/any.rb

@@ -0,0 +1,124 @@
+# Copyright 2017 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
+    # +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
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := ptypes.MarshalAny(foo)
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # = JSON
+    #
+    # 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:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # 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+
+    # field. Example (for message {Google::Protobuf::Duration}):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [String]
+    #     A URL/resource name whose content describes the type of the
+    #     serialized protocol buffer message.
+    #
+    #     For URLs which use the scheme +http+, +https+, or no scheme, the
+    #     following restrictions and interpretations apply:
+    #
+    #     * If no scheme is provided, +https+ is assumed.
+    #     * 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 (e.g., leading "." is
+    #       not accepted).
+    #     * 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
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Schemes other than +http+, +https+ (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any; end
+  end
+end