google-apis-storagetransfer_v1 0.18.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65b607b8f7d0e8a8b327553107169710f0d052c05241bc4ccacbc13632b69b26
-  data.tar.gz: 8e12775f35686fbad11c420670cc1d9961523e5cd6a57627db9f52f4f0d87b64
+  metadata.gz: e15d93dbd33d337d58b864b29b0553afd3ae6b48a2b18be153c5909dd3ccc81b
+  data.tar.gz: 2ebbb3c311a673b89a9b3736c3f40656ad7e122953ac71e11254a5e0048686ea
 SHA512:
-  metadata.gz: ac42f9213be2551d265851a962243f25986667e638727f9648f5e559f8645399ff50c7b934623fefa873a40fc9b0223067a0be108b0ca7f84b8084f2c637d8b6
-  data.tar.gz: 20dc341becc0aa928e7e03b9b5318e42bf9c92197162b165264c144d2f21bb0566cf3731f84247e92d36f3bdbff0bcf12a1036a1d567fb73e247af8556898d8b
+  metadata.gz: b9c5bc94559aa7dbfe5582a327d366db7c9b558768b8525a5547354b24f1d2d9fb86da1b546cb76bfc934f8fd18b219efb3a95ba0429de938ed1379cfceebd06
+  data.tar.gz: 9a2dd7cfc7d7ee05f8be99c0b92881a629bc97d5b3140f655f5c81e6586027df59e55badf97b61b1b7e1a5dd6abd171cbbfabf51070d45f09332cc26a2001f4d

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Release history for google-apis-storagetransfer_v1
 
+### v0.22.0 (2022-02-08)
+
+* Regenerated from discovery document revision 20220203
+
+### v0.21.0 (2022-02-01)
+
+* Regenerated from discovery document revision 20220127
+* Regenerated using generator version 0.4.1
+
+### v0.20.0 (2021-12-14)
+
+* Regenerated from discovery document revision 20211211
+
+### v0.19.0 (2021-12-11)
+
+* Regenerated from discovery document revision 20211210
+
 ### v0.18.0 (2021-12-02)
 
 * Regenerated from discovery document revision 20211130

data/OVERVIEW.md

@@ -51,7 +51,7 @@ require "google/apis/storagetransfer_v1"
 client = Google::Apis::StoragetransferV1::StoragetransferService.new
 
 # Authenticate calls
-client.authentication = # ... use the googleauth gem to create credentials
+client.authorization = # ... use the googleauth gem to create credentials
 ```
 
 See the class reference docs for information on the methods you can call from a client.

data/lib/google/apis/storagetransfer_v1/classes.rb

@@ -190,12 +190,10 @@ module Google
       class AzureCredentials
         include Google::Apis::Core::Hashable
       
-        # Required. Azure shared access signature (SAS). *Note:*Copying data from Azure
-        # Data Lake Storage (ADLS) Gen 2 is in [Preview](/products/#product-launch-
-        # stages). During Preview, if you are copying data from ADLS Gen 2, you must use
-        # an account SAS. For more information about SAS, see [Grant limited access to
-        # Azure Storage resources using shared access signatures (SAS)](https://docs.
-        # microsoft.com/en-us/azure/storage/common/storage-sas-overview).
+        # Required. Azure shared access signature (SAS). For more information about SAS,
+        # see [Grant limited access to Azure Storage resources using shared access
+        # signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/
+        # storage-sas-overview).
         # Corresponds to the JSON property `sasToken`
         # @return [String]
         attr_accessor :sas_token
@@ -247,10 +245,10 @@ module Google
       # day and time zone are either specified elsewhere or are insignificant. The
       # date is relative to the Gregorian Calendar. This can represent one of the
       # following: * A full date, with non-zero year, month, and day values * A month
-      # and day value, with a zero year, such as an anniversary * A year on its own,
-      # with zero month and day values * A year and month value, with a zero day, such
-      # as a credit card expiration date Related types are google.type.TimeOfDay and `
-      # google.protobuf.Timestamp`.
+      # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
+      # zero month and a zero day * A year and month, with a zero day (e.g., a credit
+      # card expiration date) Related types: * google.type.TimeOfDay * google.type.
+      # DateTime * google.protobuf.Timestamp
       class Date
         include Google::Apis::Core::Hashable
       
@@ -532,26 +530,33 @@ module Google
         end
       end
       
-      # Logging configuration.
+      # Specifies the logging behavior for transfer operations. For cloud-to-cloud
+      # transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://
+      # cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For
+      # transfers to or from a POSIX file system, logs are stored in the Cloud Storage
+      # bucket that is the source or sink of the transfer. See [Managing Transfer for
+      # on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-
+      # prem-jobs#viewing-logs) for details.
       class LoggingConfig
         include Google::Apis::Core::Hashable
       
-        # Enables the Cloud Storage transfer logs for this transfer. This is only
-        # supported for transfer jobs with PosixFilesystem sources. The default is that
-        # logs are not generated for this transfer.
+        # For transfers with a PosixFilesystem source, this option enables the Cloud
+        # Storage transfer logs for this transfer.
         # Corresponds to the JSON property `enableOnpremGcsTransferLogs`
         # @return [Boolean]
         attr_accessor :enable_onprem_gcs_transfer_logs
         alias_method :enable_onprem_gcs_transfer_logs?, :enable_onprem_gcs_transfer_logs
       
-        # States in which `log_actions` are logged. If empty, no logs are generated.
-        # This is not yet supported for transfers with PosixFilesystem data sources.
+        # States in which `log_actions` are logged. If empty, no logs are generated. Not
+        # supported for transfers with PosixFilesystem data sources; use
+        # enable_onprem_gcs_transfer_logs instead.
         # Corresponds to the JSON property `logActionStates`
         # @return [Array<String>]
         attr_accessor :log_action_states
       
-        # Actions to be logged. If empty, no logs are generated. This is not yet
-        # supported for transfers with PosixFilesystem data sources.
+        # Specifies the actions to be logged. If empty, no logs are generated. Not
+        # supported for transfers with PosixFilesystem data sources; use
+        # enable_onprem_gcs_transfer_logs instead.
         # Corresponds to the JSON property `logActions`
         # @return [Array<String>]
         attr_accessor :log_actions
@@ -568,6 +573,82 @@ module Google
         end
       end
       
+      # Specifies the metadata options for running a transfer. These options only
+      # apply to transfers involving a POSIX filesystem and are ignored for other
+      # transfers.
+      class MetadataOptions
+        include Google::Apis::Core::Hashable
+      
+        # Specifies how each object's ACLs should be preserved for transfers between
+        # Google Cloud Storage buckets. If unspecified, the default behavior is the same
+        # as ACL_DESTINATION_BUCKET_DEFAULT.
+        # Corresponds to the JSON property `acl`
+        # @return [String]
+        attr_accessor :acl
+      
+        # Specifies how each file's POSIX group ID (GID) attribute should be handled by
+        # the transfer. By default, GID is not preserved.
+        # Corresponds to the JSON property `gid`
+        # @return [String]
+        attr_accessor :gid
+      
+        # Specifies how each object's Cloud KMS customer-managed encryption key (CMEK)
+        # is preserved for transfers between Google Cloud Storage buckets. If
+        # unspecified, the default behavior is the same as
+        # KMS_KEY_DESTINATION_BUCKET_DEFAULT.
+        # Corresponds to the JSON property `kmsKey`
+        # @return [String]
+        attr_accessor :kms_key
+      
+        # Specifies how each file's mode attribute should be handled by the transfer. By
+        # default, mode is not preserved.
+        # Corresponds to the JSON property `mode`
+        # @return [String]
+        attr_accessor :mode
+      
+        # Specifies the storage class to set on objects being transferred to Google
+        # Cloud Storage buckets. If unspecified, the default behavior is the same as
+        # STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT.
+        # Corresponds to the JSON property `storageClass`
+        # @return [String]
+        attr_accessor :storage_class
+      
+        # Specifies how symlinks should be handled by the transfer. By default, symlinks
+        # are not preserved.
+        # Corresponds to the JSON property `symlink`
+        # @return [String]
+        attr_accessor :symlink
+      
+        # Specifies how each object's temporary hold status should be preserved for
+        # transfers between Google Cloud Storage buckets. If unspecified, the default
+        # behavior is the same as TEMPORARY_HOLD_PRESERVE.
+        # Corresponds to the JSON property `temporaryHold`
+        # @return [String]
+        attr_accessor :temporary_hold
+      
+        # Specifies how each file's POSIX user ID (UID) attribute should be handled by
+        # the transfer. By default, UID is not preserved.
+        # Corresponds to the JSON property `uid`
+        # @return [String]
+        attr_accessor :uid
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @acl = args[:acl] if args.key?(:acl)
+          @gid = args[:gid] if args.key?(:gid)
+          @kms_key = args[:kms_key] if args.key?(:kms_key)
+          @mode = args[:mode] if args.key?(:mode)
+          @storage_class = args[:storage_class] if args.key?(:storage_class)
+          @symlink = args[:symlink] if args.key?(:symlink)
+          @temporary_hold = args[:temporary_hold] if args.key?(:temporary_hold)
+          @uid = args[:uid] if args.key?(:uid)
+        end
+      end
+      
       # Specification to configure notifications published to Pub/Sub. Notifications
       # are published to the customer-provided topic using the following `
       # PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"
@@ -680,18 +761,24 @@ module Google
         # @return [String]
         attr_accessor :last_modified_since
       
-        # If specified, only objects with a "last modification time" on or after `NOW` -
-        # `max_time_elapsed_since_last_modification` and objects that don't have a "last
-        # modification time" are transferred. For each TransferOperation started by this
-        # TransferJob, `NOW` refers to the start_time of the `TransferOperation`.
+        # Ensures that objects are not transferred if a specific maximum time has
+        # elapsed since the "last modification time". When a TransferOperation begins,
+        # objects with a "last modification time" are transferred only if the elapsed
+        # time between the start_time of the `TransferOperation`and the "last
+        # modification time" of the object is less than the value of
+        # max_time_elapsed_since_last_modification`. Objects that do not have a "last
+        # modification time" are also transferred.
         # Corresponds to the JSON property `maxTimeElapsedSinceLastModification`
         # @return [String]
         attr_accessor :max_time_elapsed_since_last_modification
       
-        # If specified, only objects with a "last modification time" before `NOW` - `
-        # min_time_elapsed_since_last_modification` and objects that don't have a "last
-        # modification time" are transferred. For each TransferOperation started by this
-        # TransferJob, `NOW` refers to the start_time of the `TransferOperation`.
+        # Ensures that objects are not transferred until a specific minimum time has
+        # elapsed after the "last modification time". When a TransferOperation begins,
+        # objects with a "last modification time" are transferred only if the elapsed
+        # time between the start_time of the `TransferOperation` and the "last
+        # modification time" of the object is equal to or greater than the value of
+        # min_time_elapsed_since_last_modification`. Objects that do not have a "last
+        # modification time" are also transferred.
         # Corresponds to the JSON property `minTimeElapsedSinceLastModification`
         # @return [String]
         attr_accessor :min_time_elapsed_since_last_modification
@@ -855,10 +942,10 @@ module Google
         # day and time zone are either specified elsewhere or are insignificant. The
         # date is relative to the Gregorian Calendar. This can represent one of the
         # following: * A full date, with non-zero year, month, and day values * A month
-        # and day value, with a zero year, such as an anniversary * A year on its own,
-        # with zero month and day values * A year and month value, with a zero day, such
-        # as a credit card expiration date Related types are google.type.TimeOfDay and `
-        # google.protobuf.Timestamp`.
+        # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
+        # zero month and a zero day * A year and month, with a zero day (e.g., a credit
+        # card expiration date) Related types: * google.type.TimeOfDay * google.type.
+        # DateTime * google.protobuf.Timestamp
         # Corresponds to the JSON property `scheduleEndDate`
         # @return [Google::Apis::StoragetransferV1::Date]
         attr_accessor :schedule_end_date
@@ -867,10 +954,10 @@ module Google
         # day and time zone are either specified elsewhere or are insignificant. The
         # date is relative to the Gregorian Calendar. This can represent one of the
         # following: * A full date, with non-zero year, month, and day values * A month
-        # and day value, with a zero year, such as an anniversary * A year on its own,
-        # with zero month and day values * A year and month value, with a zero day, such
-        # as a credit card expiration date Related types are google.type.TimeOfDay and `
-        # google.protobuf.Timestamp`.
+        # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
+        # zero month and a zero day * A year and month, with a zero day (e.g., a credit
+        # card expiration date) Related types: * google.type.TimeOfDay * google.type.
+        # DateTime * google.protobuf.Timestamp
         # Corresponds to the JSON property `scheduleStartDate`
         # @return [Google::Apis::StoragetransferV1::Date]
         attr_accessor :schedule_start_date
@@ -1161,7 +1248,13 @@ module Google
         # @return [String]
         attr_accessor :latest_operation_name
       
-        # Logging configuration.
+        # Specifies the logging behavior for transfer operations. For cloud-to-cloud
+        # transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://
+        # cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For
+        # transfers to or from a POSIX file system, logs are stored in the Cloud Storage
+        # bucket that is the source or sink of the transfer. See [Managing Transfer for
+        # on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-
+        # prem-jobs#viewing-logs) for details.
         # Corresponds to the JSON property `loggingConfig`
         # @return [Google::Apis::StoragetransferV1::LoggingConfig]
         attr_accessor :logging_config
@@ -1362,6 +1455,13 @@ module Google
         attr_accessor :delete_objects_unique_in_sink
         alias_method :delete_objects_unique_in_sink?, :delete_objects_unique_in_sink
       
+        # Specifies the metadata options for running a transfer. These options only
+        # apply to transfers involving a POSIX filesystem and are ignored for other
+        # transfers.
+        # Corresponds to the JSON property `metadataOptions`
+        # @return [Google::Apis::StoragetransferV1::MetadataOptions]
+        attr_accessor :metadata_options
+      
         # When to overwrite objects that already exist in the sink. The default is that
         # only objects that are different from the source are ovewritten. If true, all
         # objects in the sink whose name matches an object in the source are overwritten
@@ -1379,6 +1479,7 @@ module Google
         def update!(**args)
           @delete_objects_from_source_after_transfer = args[:delete_objects_from_source_after_transfer] if args.key?(:delete_objects_from_source_after_transfer)
           @delete_objects_unique_in_sink = args[:delete_objects_unique_in_sink] if args.key?(:delete_objects_unique_in_sink)
+          @metadata_options = args[:metadata_options] if args.key?(:metadata_options)
           @overwrite_objects_already_existing_in_sink = args[:overwrite_objects_already_existing_in_sink] if args.key?(:overwrite_objects_already_existing_in_sink)
         end
       end
@@ -1420,6 +1521,14 @@ module Google
         # @return [Google::Apis::StoragetransferV1::GcsData]
         attr_accessor :gcs_data_source
       
+        # In a GcsData resource, an object's name is the Cloud Storage object's name and
+        # its "last modification time" refers to the object's `updated` property of
+        # Cloud Storage objects, which changes when the content or the metadata of the
+        # object is updated.
+        # Corresponds to the JSON property `gcsIntermediateDataLocation`
+        # @return [Google::Apis::StoragetransferV1::GcsData]
+        attr_accessor :gcs_intermediate_data_location
+      
         # An HttpData resource specifies a list of objects on the web to be transferred
         # over HTTP. The information of the objects to be transferred is contained in a
         # file referenced by a URL. The first line in the file must be `"TsvHttpData-1.0"
@@ -1498,6 +1607,7 @@ module Google
           @azure_blob_storage_data_source = args[:azure_blob_storage_data_source] if args.key?(:azure_blob_storage_data_source)
           @gcs_data_sink = args[:gcs_data_sink] if args.key?(:gcs_data_sink)
           @gcs_data_source = args[:gcs_data_source] if args.key?(:gcs_data_source)
+          @gcs_intermediate_data_location = args[:gcs_intermediate_data_location] if args.key?(:gcs_intermediate_data_location)
           @http_data_source = args[:http_data_source] if args.key?(:http_data_source)
           @object_conditions = args[:object_conditions] if args.key?(:object_conditions)
           @posix_data_sink = args[:posix_data_sink] if args.key?(:posix_data_sink)
@@ -1526,10 +1636,10 @@ module Google
       
         # The field mask of the fields in `transferJob` that are to be updated in this
         # request. Fields in `transferJob` that can be updated are: description,
-        # transfer_spec, notification_config, and status. To update the `transfer_spec`
-        # of the job, a complete transfer specification must be provided. An incomplete
-        # specification missing any required fields is rejected with the error
-        # INVALID_ARGUMENT.
+        # transfer_spec, notification_config, logging_config, and status. To update the `
+        # transfer_spec` of the job, a complete transfer specification must be provided.
+        # An incomplete specification missing any required fields is rejected with the
+        # error INVALID_ARGUMENT.
         # Corresponds to the JSON property `updateTransferJobFieldMask`
         # @return [String]
         attr_accessor :update_transfer_job_field_mask

data/lib/google/apis/storagetransfer_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module StoragetransferV1
       # Version of the google-apis-storagetransfer_v1 gem
-      GEM_VERSION = "0.18.0"
+      GEM_VERSION = "0.22.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.4.0"
+      GENERATOR_VERSION = "0.4.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20211130"
+      REVISION = "20220203"
     end
   end
 end

data/lib/google/apis/storagetransfer_v1/representations.rb

@@ -130,6 +130,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class MetadataOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class NotificationConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -385,6 +391,20 @@ module Google
         end
       end
       
+      class MetadataOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :acl, as: 'acl'
+          property :gid, as: 'gid'
+          property :kms_key, as: 'kmsKey'
+          property :mode, as: 'mode'
+          property :storage_class, as: 'storageClass'
+          property :symlink, as: 'symlink'
+          property :temporary_hold, as: 'temporaryHold'
+          property :uid, as: 'uid'
+        end
+      end
+      
       class NotificationConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -559,6 +579,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :delete_objects_from_source_after_transfer, as: 'deleteObjectsFromSourceAfterTransfer'
           property :delete_objects_unique_in_sink, as: 'deleteObjectsUniqueInSink'
+          property :metadata_options, as: 'metadataOptions', class: Google::Apis::StoragetransferV1::MetadataOptions, decorator: Google::Apis::StoragetransferV1::MetadataOptions::Representation
+      
           property :overwrite_objects_already_existing_in_sink, as: 'overwriteObjectsAlreadyExistingInSink'
         end
       end
@@ -574,6 +596,8 @@ module Google
       
           property :gcs_data_source, as: 'gcsDataSource', class: Google::Apis::StoragetransferV1::GcsData, decorator: Google::Apis::StoragetransferV1::GcsData::Representation
       
+          property :gcs_intermediate_data_location, as: 'gcsIntermediateDataLocation', class: Google::Apis::StoragetransferV1::GcsData, decorator: Google::Apis::StoragetransferV1::GcsData::Representation
+      
           property :http_data_source, as: 'httpDataSource', class: Google::Apis::StoragetransferV1::HttpData, decorator: Google::Apis::StoragetransferV1::HttpData::Representation
       
           property :object_conditions, as: 'objectConditions', class: Google::Apis::StoragetransferV1::ObjectConditions, decorator: Google::Apis::StoragetransferV1::ObjectConditions::Representation

data/lib/google/apis/storagetransfer_v1/service.rb

@@ -414,7 +414,7 @@ module Google
         
         # Attempts to start a new TransferOperation for the current TransferJob. A
         # TransferJob has a maximum of one active TransferOperation. If this method is
-        # called while a TransferOperation is active, an error wil be returned.
+        # called while a TransferOperation is active, an error will be returned.
         # @param [String] job_name
         #   Required. The name of the transfer job.
         # @param [Google::Apis::StoragetransferV1::RunTransferJobRequest] run_transfer_job_request_object

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-storagetransfer_v1
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-storagetransfer_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-storagetransfer_v1/v0.18.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-storagetransfer_v1/v0.22.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-storagetransfer_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Storage Transfer API V1