google-cloud-storage_batch_operations-v1 0.a → 0.1.0

data/proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb

@@ -0,0 +1,372 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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 StorageBatchOperations
+      module V1
+        # The Storage Batch Operations Job description.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the Job. job_id is unique
+        #     within the project and location, that is either set by the customer or
+        #     defined by the service. Format:
+        #     projects/\\{project}/locations/\\{location}/jobs/\\{job_id} .
+        #     For example: "projects/123456/locations/us-central1/jobs/job01".
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. A description provided by the user for the job. Its max length is
+        #     1024 bytes when Unicode-encoded.
+        # @!attribute [rw] bucket_list
+        #   @return [::Google::Cloud::StorageBatchOperations::V1::BucketList]
+        #     Specifies a list of buckets and their objects to be transformed.
+        # @!attribute [rw] put_object_hold
+        #   @return [::Google::Cloud::StorageBatchOperations::V1::PutObjectHold]
+        #     Changes object hold status.
+        #
+        #     Note: The following fields are mutually exclusive: `put_object_hold`, `delete_object`, `put_metadata`, `rewrite_object`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] delete_object
+        #   @return [::Google::Cloud::StorageBatchOperations::V1::DeleteObject]
+        #     Delete objects.
+        #
+        #     Note: The following fields are mutually exclusive: `delete_object`, `put_object_hold`, `put_metadata`, `rewrite_object`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] put_metadata
+        #   @return [::Google::Cloud::StorageBatchOperations::V1::PutMetadata]
+        #     Updates object metadata. Allows updating fixed-key and custom metadata
+        #     and fixed-key metadata i.e. Cache-Control, Content-Disposition,
+        #     Content-Encoding, Content-Language, Content-Type, Custom-Time.
+        #
+        #     Note: The following fields are mutually exclusive: `put_metadata`, `put_object_hold`, `delete_object`, `rewrite_object`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] rewrite_object
+        #   @return [::Google::Cloud::StorageBatchOperations::V1::RewriteObject]
+        #     Rewrite the object and updates metadata like KMS key.
+        #
+        #     Note: The following fields are mutually exclusive: `rewrite_object`, `put_object_hold`, `delete_object`, `put_metadata`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] logging_config
+        #   @return [::Google::Cloud::StorageBatchOperations::V1::LoggingConfig]
+        #     Optional. Logging configuration.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time that the job was created.
+        # @!attribute [r] schedule_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time that the job was scheduled.
+        # @!attribute [r] complete_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time that the job was completed.
+        # @!attribute [r] counters
+        #   @return [::Google::Cloud::StorageBatchOperations::V1::Counters]
+        #     Output only. Information about the progress of the job.
+        # @!attribute [r] error_summaries
+        #   @return [::Array<::Google::Cloud::StorageBatchOperations::V1::ErrorSummary>]
+        #     Output only. Summarizes errors encountered with sample error log entries.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::StorageBatchOperations::V1::Job::State]
+        #     Output only. State of the job.
+        class Job
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Describes state of a job.
+          module State
+            # Default value. This value is unused.
+            STATE_UNSPECIFIED = 0
+
+            # In progress.
+            RUNNING = 1
+
+            # Completed successfully.
+            SUCCEEDED = 2
+
+            # Cancelled by the user.
+            CANCELED = 3
+
+            # Terminated due to an unrecoverable failure.
+            FAILED = 4
+          end
+        end
+
+        # Describes list of buckets and their objects to be transformed.
+        # @!attribute [rw] buckets
+        #   @return [::Array<::Google::Cloud::StorageBatchOperations::V1::BucketList::Bucket>]
+        #     Required. List of buckets and their objects to be transformed. Currently,
+        #     only one bucket configuration is supported. If multiple buckets are
+        #     specified, an error will be returned.
+        class BucketList
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Describes configuration of a single bucket and its objects to be
+          # transformed.
+          # @!attribute [rw] bucket
+          #   @return [::String]
+          #     Required. Bucket name for the objects to be transformed.
+          # @!attribute [rw] prefix_list
+          #   @return [::Google::Cloud::StorageBatchOperations::V1::PrefixList]
+          #     Specifies objects matching a prefix set.
+          #
+          #     Note: The following fields are mutually exclusive: `prefix_list`, `manifest`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] manifest
+          #   @return [::Google::Cloud::StorageBatchOperations::V1::Manifest]
+          #     Specifies objects in a manifest file.
+          #
+          #     Note: The following fields are mutually exclusive: `manifest`, `prefix_list`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          class Bucket
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Describes list of objects to be transformed.
+        # @!attribute [rw] manifest_location
+        #   @return [::String]
+        #     Required. `manifest_location` must contain the manifest source file that is
+        #     a CSV file in a Google Cloud Storage bucket. Each row in the file must
+        #     include the object details i.e. BucketId and Name. Generation may
+        #     optionally be specified. When it is not specified the live object is acted
+        #     upon.
+        #      `manifest_location` should either be
+        #     1) An absolute path to the object in the format of
+        #     gs://bucket_name/path/file_name.csv.
+        #     2) An absolute path with a single wildcard character in the file name, for
+        #     example gs://bucket_name/path/file_name*.csv.
+        #     If manifest location is specified with a wildcard, objects in all manifest
+        #     files matching the pattern will be acted upon.
+        class Manifest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Describes prefixes of objects to be transformed.
+        # @!attribute [rw] included_object_prefixes
+        #   @return [::Array<::String>]
+        #     Optional. Include prefixes of the objects to be transformed.
+        #     * Supports full object name
+        #     * Supports prefix of the object name
+        #     * Wildcards are not supported
+        #     * Supports empty string for all objects in a bucket.
+        class PrefixList
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Describes options to update object hold.
+        # @!attribute [rw] temporary_hold
+        #   @return [::Google::Cloud::StorageBatchOperations::V1::PutObjectHold::HoldStatus]
+        #     Required. Updates object temporary holds state. When object temporary hold
+        #     is set, object cannot be deleted or replaced.
+        # @!attribute [rw] event_based_hold
+        #   @return [::Google::Cloud::StorageBatchOperations::V1::PutObjectHold::HoldStatus]
+        #     Required. Updates object event based holds state. When object event based
+        #     hold is set, object cannot be deleted or replaced. Resets object's time in
+        #     the bucket for the purposes of the retention period.
+        class PutObjectHold
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Describes the status of the hold.
+          module HoldStatus
+            # Default value, Object hold status will not be changed.
+            HOLD_STATUS_UNSPECIFIED = 0
+
+            # Places the hold.
+            SET = 1
+
+            # Releases the hold.
+            UNSET = 2
+          end
+        end
+
+        # Describes options to delete an object.
+        # @!attribute [rw] permanent_object_deletion_enabled
+        #   @return [::Boolean]
+        #     Required. Controls deletion behavior when versioning is enabled for the
+        #     object's bucket. If true both live and noncurrent objects will be
+        #     permanently deleted. Otherwise live objects in versioned buckets will
+        #     become noncurrent and objects that were already noncurrent will be skipped.
+        #     This setting doesn't have any impact on the Soft Delete feature. All
+        #     objects deleted by this service can be be restored for the duration of the
+        #     Soft Delete retention duration if enabled. If enabled and the manifest
+        #     doesn't specify an object's generation, a GetObjectMetadata call (a Class B
+        #     operation) will be made to determine the live object generation.
+        class DeleteObject
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Describes options for object rewrite.
+        # @!attribute [rw] kms_key
+        #   @return [::String]
+        #     Required. Resource name of the Cloud KMS key that will be used to encrypt
+        #     the object. The Cloud KMS key must be located in same location as the
+        #     object. Refer to
+        #     https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key
+        #     for additional documentation. Format:
+        #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyring}/cryptoKeys/\\{key}
+        #     For example:
+        #     "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key".
+        #     The object will be rewritten and set with the specified KMS key.
+        class RewriteObject
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Describes options for object metadata update.
+        # @!attribute [rw] content_disposition
+        #   @return [::String]
+        #     Optional. Updates objects Content-Disposition fixed metadata. Unset values
+        #     will be ignored. Set empty values to clear the metadata. Refer
+        #     https://cloud.google.com/storage/docs/metadata#content-disposition for
+        #     additional documentation.
+        # @!attribute [rw] content_encoding
+        #   @return [::String]
+        #     Optional. Updates objects Content-Encoding fixed metadata. Unset values
+        #     will be ignored. Set empty values to clear the metadata. Refer to
+        #     documentation in
+        #     https://cloud.google.com/storage/docs/metadata#content-encoding.
+        # @!attribute [rw] content_language
+        #   @return [::String]
+        #     Optional. Updates objects Content-Language fixed metadata. Refer to ISO
+        #     639-1 language codes for typical values of this metadata. Max length 100
+        #     characters. Unset values will be ignored. Set empty values to clear the
+        #     metadata. Refer to documentation in
+        #     https://cloud.google.com/storage/docs/metadata#content-language.
+        # @!attribute [rw] content_type
+        #   @return [::String]
+        #     Optional. Updates objects Content-Type fixed metadata. Unset values will be
+        #     ignored.
+        #      Set empty values to clear the metadata. Refer to documentation in
+        #      https://cloud.google.com/storage/docs/metadata#content-type
+        # @!attribute [rw] cache_control
+        #   @return [::String]
+        #     Optional. Updates objects Cache-Control fixed metadata. Unset values will
+        #     be
+        #      ignored. Set empty values to clear the metadata.
+        #      Additionally, the value for Custom-Time cannot decrease. Refer to
+        #      documentation in
+        #     https://cloud.google.com/storage/docs/metadata#caching_data.
+        # @!attribute [rw] custom_time
+        #   @return [::String]
+        #     Optional. Updates objects Custom-Time fixed metadata. Unset values will be
+        #     ignored. Set empty values to clear the metadata. Refer to documentation in
+        #     https://cloud.google.com/storage/docs/metadata#custom-time.
+        # @!attribute [rw] custom_metadata
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Updates objects custom metadata. Adds or sets individual custom
+        #     metadata key value pairs on objects. Keys that are set with empty custom
+        #     metadata values will have its value cleared. Existing custom metadata not
+        #     specified with this flag is not changed. Refer to documentation in
+        #     https://cloud.google.com/storage/docs/metadata#custom-metadata
+        class PutMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class CustomMetadataEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # A summary of errors by error code, plus a count and sample error log
+        # entries.
+        # @!attribute [rw] error_code
+        #   @return [::Google::Rpc::Code]
+        #     Required. The canonical error code.
+        # @!attribute [rw] error_count
+        #   @return [::Integer]
+        #     Required. Number of errors encountered per `error_code`.
+        # @!attribute [rw] error_log_entries
+        #   @return [::Array<::Google::Cloud::StorageBatchOperations::V1::ErrorLogEntry>]
+        #     Required. Sample error logs.
+        class ErrorSummary
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An entry describing an error that has occurred.
+        # @!attribute [r] object_uri
+        #   @return [::String]
+        #     Required. Output only. Object URL. e.g. gs://my_bucket/object.txt
+        # @!attribute [r] error_details
+        #   @return [::Array<::String>]
+        #     Optional. Output only. At most 5 error log entries are recorded for a given
+        #     error code for a job.
+        class ErrorLogEntry
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Describes details about the progress of the job.
+        # @!attribute [r] total_object_count
+        #   @return [::Integer]
+        #     Output only. Number of objects listed.
+        # @!attribute [r] succeeded_object_count
+        #   @return [::Integer]
+        #     Output only. Number of objects completed.
+        # @!attribute [r] failed_object_count
+        #   @return [::Integer]
+        #     Output only. Number of objects failed.
+        class Counters
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Specifies the Cloud Logging behavior.
+        # @!attribute [rw] log_actions
+        #   @return [::Array<::Google::Cloud::StorageBatchOperations::V1::LoggingConfig::LoggableAction>]
+        #     Required. Specifies the actions to be logged.
+        # @!attribute [rw] log_action_states
+        #   @return [::Array<::Google::Cloud::StorageBatchOperations::V1::LoggingConfig::LoggableActionState>]
+        #     Required. States in which Action are logged.If empty, no logs are
+        #     generated.
+        class LoggingConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Loggable actions types.
+          module LoggableAction
+            # Illegal value, to avoid allowing a default.
+            LOGGABLE_ACTION_UNSPECIFIED = 0
+
+            # The corresponding transform action in this job.
+            TRANSFORM = 6
+          end
+
+          # Loggable action states filter.
+          module LoggableActionState
+            # Illegal value, to avoid allowing a default.
+            LOGGABLE_ACTION_STATE_UNSPECIFIED = 0
+
+            # `LoggableAction` completed successfully. `SUCCEEDED` actions are
+            # logged as [INFO][google.logging.type.LogSeverity.INFO].
+            SUCCEEDED = 1
+
+            # `LoggableAction` terminated in an error state. `FAILED` actions
+            # are logged as [ERROR][google.logging.type.LogSeverity.ERROR].
+            FAILED = 2
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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.
+    #
+    #     Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+    # @!attribute [rw] response
+    #   @return [::Google::Protobuf::Any]
+    #     The normal, successful response of the operation.  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`.
+    #
+    #     Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+    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 Export(ExportRequest) returns (google.longrunning.Operation) {
+    #       option (google.longrunning.operation_info) = {
+    #         response_type: "ExportResponse"
+    #         metadata_type: "ExportMetadata"
+    #       };
+    #     }
+    # @!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,145 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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);
+    #     }
+    #     // or ...
+    #     if (any.isSameTypeAs(Foo.getDefaultInstance())) {
+    #       foo = any.unpack(Foo.getDefaultInstance());
+    #     }
+    #
+    #  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. As of May 2023, there are no widely used type server
+    #     implementations and no plans to implement one.
+    #
+    #     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