google-cloud-storage_transfer-v1 0.8.0 → 1.4.0

data/proto_docs/google/api/client.rb

@@ -21,12 +21,16 @@ module Google
   module Api
     # Required information for every language.
     # @!attribute [rw] reference_docs_uri
+    #   @deprecated This field is deprecated and may be removed in the next major version update.
     #   @return [::String]
     #     Link to automatically generated reference documentation.  Example:
     #     https://cloud.google.com/nodejs/docs/reference/asset/latest
     # @!attribute [rw] destinations
     #   @return [::Array<::Google::Api::ClientLibraryDestination>]
     #     The destination where API teams want this client library to be published.
+    # @!attribute [rw] selective_gapic_generation
+    #   @return [::Google::Api::SelectiveGapicGeneration]
+    #     Configuration for which RPCs should be generated in the GAPIC client.
     class CommonLanguageSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -117,6 +121,10 @@ module Google
     #   @return [::String]
     #     Optional link to proto reference documentation.  Example:
     #     https://cloud.google.com/pubsub/lite/docs/reference/rpc
+    # @!attribute [rw] rest_reference_documentation_uri
+    #   @return [::String]
+    #     Optional link to REST reference documentation.  Example:
+    #     https://cloud.google.com/pubsub/lite/docs/reference/rest
     class Publishing
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -191,9 +199,32 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] experimental_features
+    #   @return [::Google::Api::PythonSettings::ExperimentalFeatures]
+    #     Experimental features to be included during client library generation.
     class PythonSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # Experimental features to be included during client library generation.
+      # These fields will be deprecated once the feature graduates and is enabled
+      # by default.
+      # @!attribute [rw] rest_async_io_enabled
+      #   @return [::Boolean]
+      #     Enables generation of asynchronous REST clients if `rest` transport is
+      #     enabled. By default, asynchronous REST clients will not be generated.
+      #     This feature will be enabled by default 1 month after launching the
+      #     feature in preview packages.
+      # @!attribute [rw] protobuf_pythonic_types_enabled
+      #   @return [::Boolean]
+      #     Enables generation of protobuf code using new types that are more
+      #     Pythonic which are included in `protobuf>=5.29.x`. This feature will be
+      #     enabled by default 1 month after launching the feature in preview
+      #     packages.
+      class ExperimentalFeatures
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Settings for Node client libraries.
@@ -275,9 +306,28 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] renamed_services
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map of service names to renamed services. Keys are the package relative
+    #     service names and values are the name to be used for the service client
+    #     and call options.
+    #
+    #     publishing:
+    #       go_settings:
+    #         renamed_services:
+    #           Publisher: TopicAdmin
     class GoSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedServicesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Describes the generator configuration for a method.
@@ -285,6 +335,13 @@ module Google
     #   @return [::String]
     #     The fully qualified name of the method, for which the options below apply.
     #     This is used to find the method to apply the options.
+    #
+    #     Example:
+    #
+    #        publishing:
+    #          method_settings:
+    #          - selector: google.storage.control.v2.StorageControl.CreateFolder
+    #            # method settings for CreateFolder...
     # @!attribute [rw] long_running
     #   @return [::Google::Api::MethodSettings::LongRunning]
     #     Describes settings to use for long-running operations when generating
@@ -293,17 +350,27 @@ module Google
     #
     #     Example of a YAML configuration::
     #
-    #      publishing:
-    #        method_settings:
+    #        publishing:
+    #          method_settings:
     #          - selector: google.cloud.speech.v2.Speech.BatchRecognize
     #            long_running:
-    #              initial_poll_delay:
-    #                seconds: 60 # 1 minute
+    #              initial_poll_delay: 60s # 1 minute
     #              poll_delay_multiplier: 1.5
-    #              max_poll_delay:
-    #                seconds: 360 # 6 minutes
-    #              total_poll_timeout:
-    #                 seconds: 54000 # 90 minutes
+    #              max_poll_delay: 360s # 6 minutes
+    #              total_poll_timeout: 54000s # 90 minutes
+    # @!attribute [rw] auto_populated_fields
+    #   @return [::Array<::String>]
+    #     List of top-level fields of the request message, that should be
+    #     automatically populated by the client libraries based on their
+    #     (google.api.field_info).format. Currently supported format: UUID4.
+    #
+    #     Example of a YAML configuration:
+    #
+    #        publishing:
+    #          method_settings:
+    #          - selector: google.example.v1.ExampleService.CreateExample
+    #            auto_populated_fields:
+    #            - request_id
     class MethodSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -336,6 +403,17 @@ module Google
       end
     end
 
+    # This message is used to configure the generation of a subset of the RPCs in
+    # a service for client libraries.
+    # @!attribute [rw] methods
+    #   @return [::Array<::String>]
+    #     An allowlist of the fully qualified names of RPCs that should be included
+    #     on public client surfaces.
+    class SelectiveGapicGeneration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # The organization for which the client libraries are being published.
     # Affects the url where generated docs are published, etc.
     module ClientLibraryOrganization

data/proto_docs/google/api/resource.rb

@@ -124,8 +124,13 @@ module Google
     #   @return [::String]
     #     The plural name used in the resource name and permission names, such as
     #     'projects' for the resource name of 'projects/\\{project}' and the permission
-    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
-    #     concept of the `plural` field in k8s CRD spec
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
+    #     to this is for Nested Collections that have stuttering names, as defined
+    #     in [AIP-122](https://google.aip.dev/122#nested-collections), where the
+    #     collection ID in the resource name pattern does not necessarily directly
+    #     match the `plural` value.
+    #
+    #     It is the same concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #
     #     Note: The plural form is required even for singleton resources. See

data/proto_docs/google/longrunning/operations.rb

@@ -40,9 +40,11 @@ module Google
     # @!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 response of the operation in case of success.  If the original
+    #     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
@@ -50,12 +52,15 @@ module Google
     #     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.
+    # The request message for
+    # Operations.GetOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource.
@@ -64,7 +69,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.ListOperations.
+    # The request message for
+    # Operations.ListOperations.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation's parent resource.
@@ -82,7 +88,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The response message for Operations.ListOperations.
+    # 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.
@@ -94,7 +101,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.CancelOperation.
+    # The request message for
+    # Operations.CancelOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to be cancelled.
@@ -103,7 +111,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.DeleteOperation.
+    # The request message for
+    # Operations.DeleteOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to be deleted.
@@ -112,7 +121,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.WaitOperation.
+    # The request message for
+    # Operations.WaitOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to wait on.
@@ -130,13 +140,12 @@ module Google
     #
     # Example:
     #
-    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
-    #       returns (google.longrunning.Operation) {
-    #     option (google.longrunning.operation_info) = {
-    #       response_type: "LongRunningRecognizeResponse"
-    #       metadata_type: "LongRunningRecognizeMetadata"
-    #     };
-    #   }
+    #     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

data/proto_docs/google/protobuf/any.rb

@@ -129,7 +129,8 @@ module Google
     #
     #     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.
+    #     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.

data/proto_docs/google/storagetransfer/v1/transfer.rb

@@ -111,17 +111,32 @@ module Google
         # @!attribute [rw] filter
         #   @return [::String]
         #     Required. A list of query parameters specified as JSON text in the form of:
-        #     `{"projectId":"my_project_id",
-        #      "jobNames":["jobid1","jobid2",...],
-        #      "jobStatuses":["status1","status2",...]}`
         #
-        #     Since `jobNames` and `jobStatuses` support multiple values, their values
-        #     must be specified with array notation. `projectId` is required.
-        #     `jobNames` and `jobStatuses` are optional.  The valid values for
-        #     `jobStatuses` are case-insensitive:
-        #     {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::ENABLED ENABLED},
-        #     {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::DISABLED DISABLED}, and
-        #     {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::DELETED DELETED}.
+        #     ```
+        #     {
+        #       "projectId":"my_project_id",
+        #       "jobNames":["jobid1","jobid2",...],
+        #       "jobStatuses":["status1","status2",...],
+        #       "dataBackend":"QUERY_REPLICATION_CONFIGS",
+        #       "sourceBucket":"source-bucket-name",
+        #       "sinkBucket":"sink-bucket-name",
+        #     }
+        #     ```
+        #
+        #     The JSON formatting in the example is for display only; provide the
+        #     query parameters without spaces or line breaks.
+        #
+        #     * `projectId` is required.
+        #     * Since `jobNames` and `jobStatuses` support multiple values, their values
+        #       must be specified with array notation. `jobNames` and `jobStatuses` are
+        #       optional. Valid values are case-insensitive:
+        #         * {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::ENABLED ENABLED}
+        #         * {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::DISABLED DISABLED}
+        #         * {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::DELETED DELETED}
+        #     * Specify `"dataBackend":"QUERY_REPLICATION_CONFIGS"` to return a list of
+        #       cross-bucket replication jobs.
+        #     * Limit the results to jobs from a particular bucket with `sourceBucket`
+        #       and/or to a particular bucket with `sinkBucket`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     The list page size. The max allowed value is 256.