google-cloud-ai_platform-v1 0.1.0

data/proto_docs/google/cloud/aiplatform/v1/value.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # Value is the value of the field.
+        # @!attribute [rw] int_value
+        #   @return [::Integer]
+        #     An integer value.
+        # @!attribute [rw] double_value
+        #   @return [::Float]
+        #     A double value.
+        # @!attribute [rw] string_value
+        #   @return [::String]
+        #     A string value.
+        class Value
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/vizier_service.rb

@@ -0,0 +1,332 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#get_study VizierService.GetStudy}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the Study resource.
+        #     Format: `projects/{project}/locations/{location}/studies/{study}`
+        class GetStudyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#create_study VizierService.CreateStudy}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Location to create the CustomJob in.
+        #     Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] study
+        #   @return [::Google::Cloud::AIPlatform::V1::Study]
+        #     Required. The Study configuration used to create the Study.
+        class CreateStudyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#list_studies VizierService.ListStudies}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Location to list the Study from.
+        #     Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token to request the next page of results.
+        #     If unspecified, there are no subsequent pages.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of studies to return per "page" of results.
+        #     If unspecified, service will pick an appropriate default.
+        class ListStudiesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#list_studies VizierService.ListStudies}.
+        # @!attribute [rw] studies
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::Study>]
+        #     The studies associated with the project.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Passes this token as the `page_token` field of the request for a
+        #     subsequent call.
+        #     If this field is omitted, there are no subsequent pages.
+        class ListStudiesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#delete_study VizierService.DeleteStudy}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the Study resource to be deleted.
+        #     Format: `projects/{project}/locations/{location}/studies/{study}`
+        class DeleteStudyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#lookup_study VizierService.LookupStudy}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Location to get the Study from.
+        #     Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The user-defined display name of the Study
+        class LookupStudyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#suggest_trials VizierService.SuggestTrials}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The project and location that the Study belongs to.
+        #     Format: `projects/{project}/locations/{location}/studies/{study}`
+        # @!attribute [rw] suggestion_count
+        #   @return [::Integer]
+        #     Required. The number of suggestions requested.
+        # @!attribute [rw] client_id
+        #   @return [::String]
+        #     Required. The identifier of the client that is requesting the suggestion.
+        #
+        #     If multiple SuggestTrialsRequests have the same `client_id`,
+        #     the service will return the identical suggested Trial if the Trial is
+        #     pending, and provide a new Trial if the last suggested Trial was completed.
+        class SuggestTrialsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#suggest_trials VizierService.SuggestTrials}.
+        # @!attribute [rw] trials
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::Trial>]
+        #     A list of Trials.
+        # @!attribute [rw] study_state
+        #   @return [::Google::Cloud::AIPlatform::V1::Study::State]
+        #     The state of the Study.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time at which the operation was started.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time at which operation processing completed.
+        class SuggestTrialsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details of operations that perform Trials suggestion.
+        # @!attribute [rw] generic_metadata
+        #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
+        #     Operation metadata for suggesting Trials.
+        # @!attribute [rw] client_id
+        #   @return [::String]
+        #     The identifier of the client that is requesting the suggestion.
+        #
+        #     If multiple SuggestTrialsRequests have the same `client_id`,
+        #     the service will return the identical suggested Trial if the Trial is
+        #     pending, and provide a new Trial if the last suggested Trial was completed.
+        class SuggestTrialsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#create_trial VizierService.CreateTrial}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Study to create the Trial in.
+        #     Format: `projects/{project}/locations/{location}/studies/{study}`
+        # @!attribute [rw] trial
+        #   @return [::Google::Cloud::AIPlatform::V1::Trial]
+        #     Required. The Trial to create.
+        class CreateTrialRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#get_trial VizierService.GetTrial}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the Trial resource.
+        #     Format:
+        #     `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
+        class GetTrialRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#list_trials VizierService.ListTrials}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Study to list the Trial from.
+        #     Format: `projects/{project}/locations/{location}/studies/{study}`
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token to request the next page of results.
+        #     If unspecified, there are no subsequent pages.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The number of Trials to retrieve per "page" of results.
+        #     If unspecified, the service will pick an appropriate default.
+        class ListTrialsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#list_trials VizierService.ListTrials}.
+        # @!attribute [rw] trials
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::Trial>]
+        #     The Trials associated with the Study.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Pass this token as the `page_token` field of the request for a
+        #     subsequent call.
+        #     If this field is omitted, there are no subsequent pages.
+        class ListTrialsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#add_trial_measurement VizierService.AddTrialMeasurement}.
+        # @!attribute [rw] trial_name
+        #   @return [::String]
+        #     Required. The name of the trial to add measurement.
+        #     Format:
+        #     `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
+        # @!attribute [rw] measurement
+        #   @return [::Google::Cloud::AIPlatform::V1::Measurement]
+        #     Required. The measurement to be added to a Trial.
+        class AddTrialMeasurementRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#complete_trial VizierService.CompleteTrial}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The Trial's name.
+        #     Format:
+        #     `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
+        # @!attribute [rw] final_measurement
+        #   @return [::Google::Cloud::AIPlatform::V1::Measurement]
+        #     Optional. If provided, it will be used as the completed Trial's
+        #     final_measurement; Otherwise, the service will auto-select a
+        #     previously reported measurement as the final-measurement
+        # @!attribute [rw] trial_infeasible
+        #   @return [::Boolean]
+        #     Optional. True if the Trial cannot be run with the given Parameter, and
+        #     final_measurement will be ignored.
+        # @!attribute [rw] infeasible_reason
+        #   @return [::String]
+        #     Optional. A human readable reason why the trial was infeasible. This should
+        #     only be provided if `trial_infeasible` is true.
+        class CompleteTrialRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#delete_trial VizierService.DeleteTrial}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The Trial's name.
+        #     Format:
+        #     `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
+        class DeleteTrialRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#check_trial_early_stopping_state VizierService.CheckTrialEarlyStoppingState}.
+        # @!attribute [rw] trial_name
+        #   @return [::String]
+        #     Required. The Trial's name.
+        #     Format:
+        #     `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
+        class CheckTrialEarlyStoppingStateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#check_trial_early_stopping_state VizierService.CheckTrialEarlyStoppingState}.
+        # @!attribute [rw] should_stop
+        #   @return [::Boolean]
+        #     True if the Trial should stop.
+        class CheckTrialEarlyStoppingStateResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # This message will be placed in the metadata field of a
+        # google.longrunning.Operation associated with a CheckTrialEarlyStoppingState
+        # request.
+        # @!attribute [rw] generic_metadata
+        #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
+        #     Operation metadata for suggesting Trials.
+        # @!attribute [rw] study
+        #   @return [::String]
+        #     The name of the Study that the Trial belongs to.
+        # @!attribute [rw] trial
+        #   @return [::String]
+        #     The Trial name.
+        class CheckTrialEarlyStoppingStateMetatdata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#stop_trial VizierService.StopTrial}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The Trial's name.
+        #     Format:
+        #     `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
+        class StopTrialRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#list_optimal_trials VizierService.ListOptimalTrials}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The name of the Study that the optimal Trial belongs to.
+        class ListOptimalTrialsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::AIPlatform::V1::VizierService::Client#list_optimal_trials VizierService.ListOptimalTrials}.
+        # @!attribute [rw] optimal_trials
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::Trial>]
+        #     The pareto-optimal Trials for multiple objective Study or the
+        #     optimal trial for single objective Study. The definition of
+        #     pareto-optimal can be checked in wiki page.
+        #     https://en.wikipedia.org/wiki/Pareto_efficiency
+        class ListOptimalTrialsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The server-assigned name, which is only unique within the same service that
+    #     originally returns it. If you use the default HTTP mapping, the
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
+    # @!attribute [rw] metadata
+    #   @return [::Google::Protobuf::Any]
+    #     Service-specific metadata associated with the operation.  It typically
+    #     contains progress information and common metadata such as create time.
+    #     Some services might not provide such metadata.  Any method that returns a
+    #     long-running operation should document the metadata type, if any.
+    # @!attribute [rw] done
+    #   @return [::Boolean]
+    #     If the value is `false`, it means the operation is still in progress.
+    #     If `true`, the operation is completed, and either `error` or `response` is
+    #     available.
+    # @!attribute [rw] error
+    #   @return [::Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    # @!attribute [rw] response
+    #   @return [::Google::Protobuf::Any]
+    #     The normal response of the operation in case of success.  If the original
+    #     method returns no data on success, such as `Delete`, the response is
+    #     `google.protobuf.Empty`.  If the original method is standard
+    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
+    #     methods, the response should have the type `XxxResponse`, where `Xxx`
+    #     is the original method name.  For example, if the original method name
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
+    class Operation
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.GetOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource.
+    class GetOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.ListOperations.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation's parent resource.
+    # @!attribute [rw] filter
+    #   @return [::String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [::Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [::String]
+    #     The standard list page token.
+    class ListOperationsRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The response message for Operations.ListOperations.
+    # @!attribute [rw] operations
+    #   @return [::Array<::Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [::String]
+    #     The standard List next-page token.
+    class ListOperationsResponse
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.CancelOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.DeleteOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A message representing the message types used by a long-running operation.
+    #
+    # Example:
+    #
+    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
+    #       returns (google.longrunning.Operation) {
+    #     option (google.longrunning.operation_info) = {
+    #       response_type: "LongRunningRecognizeResponse"
+    #       metadata_type: "LongRunningRecognizeMetadata"
+    #     };
+    #   }
+    # @!attribute [rw] response_type
+    #   @return [::String]
+    #     Required. The message name of the primary return type for this
+    #     long-running operation.
+    #     This type will be used to deserialize the LRO's response.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    # @!attribute [rw] metadata_type
+    #   @return [::String]
+    #     Required. The message name of the metadata type for this long-running
+    #     operation.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    class OperationInfo
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/any.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+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 := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := any.UnmarshalTo(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 that uniquely identifies the type of the serialized
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. 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).
+    #
+    #     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
+    #     server that maps type URLs to message definitions as follows:
+    #
+    #     * 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
+    #       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.)
+    #
+    #     Note: this functionality is not currently available in the official
+    #     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
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [::String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end