google-apis-storagetransfer_v1 0.17.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11d0beac2252f6016628b07b40734be8dcf4a4e9161f3b776aa792d1b3dd198e
-  data.tar.gz: 7a367a0ed39c7fe7d93c575ec2544f3c6e06d75a553b710e5919a6a577513c09
+  metadata.gz: 6d89023c3ce1dd89ee38d3e9119fef1c48ef8559b37d32890010be3af2a5ae85
+  data.tar.gz: 919fdcd9355c2296638d9ec7b068d73b3107dcb7ae42ec1b161d8e5f51e48000
 SHA512:
-  metadata.gz: 15eb1c22b2c6627bdfe0f474d7a5e633b90e891425d4d06f9cfe356a0f1e9aab89c33512e7681262d7200e7d4647ff5a329f3d4483dfd856971e7b2c9b733bf6
-  data.tar.gz: 10fbada5a99ae9bb2f1a9b368cf0a24306fffa1cea0825f1b399342eda7270a7c3c0efa8490073b269be9e1ee7de9ca00a23ba9fd5d9989ca0c0ef1da3661680
+  metadata.gz: 868b3ebce9e5728d49663ab5fefda461e7cbdd6734edb47fcaa4ab1d53251ff6d8412e63d93784906bf03143f5a90b0fe615ed51c24813f11f3ed7ab5a21a8a7
+  data.tar.gz: 9d9be353a17b7c068107ec2e3f31b209547206d13de15899a7f24cb51892b92f0c7236bc94c81832ab877c2c34a61891f1f41249bd5db86d488e16f040095f0b

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Release history for google-apis-storagetransfer_v1
 
+### 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
+
 ### v0.17.0 (2021-11-06)
 
 * Regenerated from discovery document revision 20211105

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

@@ -26,8 +26,7 @@ module Google
       class AgentPool
         include Google::Apis::Core::Hashable
       
-        # Specifies the BandwidthLimit to describe the non-negative bandwidth rate in
-        # mbps for the agent pool.
+        # Specifies a bandwidth limit for an agent pool.
         # Corresponds to the JSON property `bandwidthLimit`
         # @return [Google::Apis::StoragetransferV1::BandwidthLimit]
         attr_accessor :bandwidth_limit
@@ -37,8 +36,8 @@ module Google
         # @return [String]
         attr_accessor :display_name
       
-        # Required. Specifies a unique string that identifies the agent pool. Format:
-        # projects/`project_id`/agentPools/`agent_pool_id`
+        # Required. Specifies a unique string that identifies the agent pool. Format: `
+        # projects/`project_id`/agentPools/`agent_pool_id``
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -191,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
@@ -211,12 +208,12 @@ module Google
         end
       end
       
-      # Specifies the BandwidthLimit to describe the non-negative bandwidth rate in
-      # mbps for the agent pool.
+      # Specifies a bandwidth limit for an agent pool.
       class BandwidthLimit
         include Google::Apis::Core::Hashable
       
-        # Specifies bandwidth rate in mbps distributed across all the agents in the pool.
+        # Bandwidth rate in megabytes per second, distributed across all the agents in
+        # the pool.
         # Corresponds to the JSON property `limitMbps`
         # @return [Fixnum]
         attr_accessor :limit_mbps
@@ -533,18 +530,37 @@ 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. 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
+      
+        # 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
+      
         def initialize(**args)
            update!(**args)
         end
@@ -552,6 +568,86 @@ module Google
         # Update properties of this object
         def update!(**args)
           @enable_onprem_gcs_transfer_logs = args[:enable_onprem_gcs_transfer_logs] if args.key?(:enable_onprem_gcs_transfer_logs)
+          @log_action_states = args[:log_action_states] if args.key?(:log_action_states)
+          @log_actions = args[:log_actions] if args.key?(:log_actions)
+        end
+      end
+      
+      # Specifies the metadata options for running a transfer.
+      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 GID attribute should be handled by the transfer. If
+        # unspecified, the default behavior is the same as GID_SKIP when the source is a
+        # POSIX file system.
+        # 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. If
+        # unspecified, the default behavior is the same as MODE_SKIP when the source is
+        # a POSIX file system.
+        # 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. If unspecified, the
+        # default behavior is the same as SYMLINK_SKIP when the source is a POSIX file
+        # system.
+        # 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 UID attribute should be handled by the transfer. If
+        # unspecified, the default behavior is the same as UID_SKIP when the source is a
+        # POSIX file system.
+        # 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
       
@@ -667,18 +763,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
@@ -806,8 +908,7 @@ module Google
       class RunTransferJobRequest
         include Google::Apis::Core::Hashable
       
-        # Required. The ID of the Google Cloud Platform Console project that owns the
-        # transfer job.
+        # Required. The ID of the Google Cloud project that owns the transfer job.
         # Corresponds to the JSON property `projectId`
         # @return [String]
         attr_accessor :project_id
@@ -1149,7 +1250,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
@@ -1184,7 +1291,7 @@ module Google
         # @return [Google::Apis::StoragetransferV1::NotificationConfig]
         attr_accessor :notification_config
       
-        # The ID of the Google Cloud Platform Project that owns the job.
+        # The ID of the Google Cloud project that owns the job.
         # Corresponds to the JSON property `projectId`
         # @return [String]
         attr_accessor :project_id
@@ -1229,6 +1336,27 @@ module Google
         end
       end
       
+      # Specifies where the manifest is located.
+      class TransferManifest
+        include Google::Apis::Core::Hashable
+      
+        # Specifies the path to the manifest in Cloud Storage. The Google-managed
+        # service account for the transfer must have `storage.objects.get` permission
+        # for this object. An example path is `gs://bucket_name/path/manifest.csv`.
+        # Corresponds to the JSON property `location`
+        # @return [String]
+        attr_accessor :location
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @location = args[:location] if args.key?(:location)
+        end
+      end
+      
       # A description of the execution of a transfer.
       class TransferOperation
         include Google::Apis::Core::Hashable
@@ -1266,7 +1394,7 @@ module Google
         # @return [Google::Apis::StoragetransferV1::NotificationConfig]
         attr_accessor :notification_config
       
-        # The ID of the Google Cloud Platform Project that owns the operation.
+        # The ID of the Google Cloud project that owns the operation.
         # Corresponds to the JSON property `projectId`
         # @return [String]
         attr_accessor :project_id
@@ -1329,6 +1457,11 @@ 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.
+        # 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
@@ -1346,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
@@ -1387,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"
@@ -1445,6 +1587,11 @@ module Google
         # @return [String]
         attr_accessor :source_agent_pool_name
       
+        # Specifies where the manifest is located.
+        # Corresponds to the JSON property `transferManifest`
+        # @return [Google::Apis::StoragetransferV1::TransferManifest]
+        attr_accessor :transfer_manifest
+      
         # TransferOptions define the actions to be performed on objects in a transfer.
         # Corresponds to the JSON property `transferOptions`
         # @return [Google::Apis::StoragetransferV1::TransferOptions]
@@ -1460,12 +1607,14 @@ 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)
           @posix_data_source = args[:posix_data_source] if args.key?(:posix_data_source)
           @sink_agent_pool_name = args[:sink_agent_pool_name] if args.key?(:sink_agent_pool_name)
           @source_agent_pool_name = args[:source_agent_pool_name] if args.key?(:source_agent_pool_name)
+          @transfer_manifest = args[:transfer_manifest] if args.key?(:transfer_manifest)
           @transfer_options = args[:transfer_options] if args.key?(:transfer_options)
         end
       end
@@ -1474,8 +1623,7 @@ module Google
       class UpdateTransferJobRequest
         include Google::Apis::Core::Hashable
       
-        # Required. The ID of the Google Cloud Platform Console project that owns the
-        # job.
+        # Required. The ID of the Google Cloud project that owns the job.
         # Corresponds to the JSON property `projectId`
         # @return [String]
         attr_accessor :project_id
@@ -1488,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.17.0"
+      GEM_VERSION = "0.21.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 = "20211105"
+      REVISION = "20220127"
     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
       
@@ -202,6 +208,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class TransferManifest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class TransferOperation
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -374,6 +386,22 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :enable_onprem_gcs_transfer_logs, as: 'enableOnpremGcsTransferLogs'
+          collection :log_action_states, as: 'logActionStates'
+          collection :log_actions, as: 'logActions'
+        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
       
@@ -519,6 +547,13 @@ module Google
         end
       end
       
+      class TransferManifest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :location, as: 'location'
+        end
+      end
+      
       class TransferOperation
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -544,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
@@ -559,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
@@ -569,6 +608,8 @@ module Google
       
           property :sink_agent_pool_name, as: 'sinkAgentPoolName'
           property :source_agent_pool_name, as: 'sourceAgentPoolName'
+          property :transfer_manifest, as: 'transferManifest', class: Google::Apis::StoragetransferV1::TransferManifest, decorator: Google::Apis::StoragetransferV1::TransferManifest::Representation
+      
           property :transfer_options, as: 'transferOptions', class: Google::Apis::StoragetransferV1::TransferOptions, decorator: Google::Apis::StoragetransferV1::TransferOptions::Representation
       
         end

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

@@ -52,14 +52,14 @@ module Google
         
         # Returns the Google service account that is used by Storage Transfer Service to
         # access buckets in the project where transfers run or in other projects. Each
-        # Google service account is associated with one Google Cloud Platform Console
-        # project. Users should add this service account to the Google Cloud Storage
-        # bucket ACLs to grant access to Storage Transfer Service. This service account
-        # is created and owned by Storage Transfer Service and can only be used by
-        # Storage Transfer Service.
+        # Google service account is associated with one Google Cloud project. Users
+        # should add this service account to the Google Cloud Storage bucket ACLs to
+        # grant access to Storage Transfer Service. This service account is created and
+        # owned by Storage Transfer Service and can only be used by Storage Transfer
+        # Service.
         # @param [String] project_id
-        #   Required. The ID of the Google Cloud Platform Console project that the Google
-        #   service account is associated with.
+        #   Required. The ID of the Google Cloud project that the Google service account
+        #   is associated with.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -89,14 +89,16 @@ module Google
         
         # Creates an agent pool resource.
         # @param [String] project_id
-        #   Required. The ID of the Google Cloud Platform Console project that owns the
-        #   agent pool.
+        #   Required. The ID of the Google Cloud project that owns the agent pool.
         # @param [Google::Apis::StoragetransferV1::AgentPool] agent_pool_object
         # @param [String] agent_pool_id
-        #   Required. The id of the agent pool to create. The agent_pool_id must be non-
-        #   empty, less than or equal to 128 characters, and satisfy the following regex: "
-        #   ^[a-z]([a-z0-9-._~]*[a-z0-9])?$". Also, agent pool names cannot start with the
-        #   string "goog".
+        #   Required. The ID of the agent pool to create. The `agent_pool_id` must meet
+        #   the following requirements: * Length of 128 characters or less. * Not start
+        #   with the string `goog`. * Start with a lowercase ASCII character, followed by:
+        #   * Zero or more: lowercase Latin alphabet characters, numerals, hyphens (`-`),
+        #   periods (`.`), underscores (`_`), or tildes (`~`). * One or more numerals or
+        #   lowercase ASCII characters. As expressed by the regular expression: `^(?!goog)[
+        #   a-z]([a-z0-9-._~]*[a-z0-9])?$`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -129,7 +131,7 @@ module Google
         
         # Deletes an agent pool.
         # @param [String] name
-        #   Required. The agent pool name to delete.
+        #   Required. The name of the agent pool to delete.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -159,7 +161,7 @@ module Google
         
         # Gets an agent pool.
         # @param [String] name
-        #   Required. The agent pool to get.
+        #   Required. The name of the agent pool to get.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -189,16 +191,15 @@ module Google
         
         # Lists agent pools.
         # @param [String] project_id
-        #   Required. The ID of the Google Cloud Platform Console project that owns the
-        #   job.
+        #   Required. The ID of the Google Cloud project that owns the job.
         # @param [String] filter
-        #   A list of optional query parameters specified as JSON text in the form of: ``"
+        #   An optional list of query parameters specified as JSON text in the form of: ``"
         #   agentPoolNames":["agentpool1","agentpool2",...]`` Since `agentPoolNames`
-        #   support multiple values, its values must be specified with array notation. `
-        #   agentPoolNames` is an optional field. The list returns all agent pools for the
-        #   project when the filter is not provided or empty.
+        #   support multiple values, its values must be specified with array notation.
+        #   When the filter is either empty or not provided, the list returns all agent
+        #   pools for the project.
         # @param [Fixnum] page_size
-        #   The list page size. The max allowed value is 256.
+        #   The list page size. The max allowed value is `256`.
         # @param [String] page_token
         #   The list page token.
         # @param [String] fields
@@ -233,13 +234,14 @@ module Google
         
         # Updates an existing agent pool resource.
         # @param [String] name
-        #   Required. Specifies a unique string that identifies the agent pool. Format:
-        #   projects/`project_id`/agentPools/`agent_pool_id`
+        #   Required. Specifies a unique string that identifies the agent pool. Format: `
+        #   projects/`project_id`/agentPools/`agent_pool_id``
         # @param [Google::Apis::StoragetransferV1::AgentPool] agent_pool_object
         # @param [String] update_mask
-        #   The field mask of the fields in `agentPool` that are to be updated in this
-        #   request. Fields in `agentPool` that can be updated are: display_name,
-        #   bandwidth_limit,
+        #   The [field mask] (https://developers.google.com/protocol-buffers/docs/
+        #   reference/google.protobuf) of the fields in `agentPool` to update in this
+        #   request. The following `agentPool` fields can be updated: * display_name *
+        #   bandwidth_limit
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -304,8 +306,7 @@ module Google
         # @param [String] job_name
         #   Required. The job to get.
         # @param [String] project_id
-        #   Required. The ID of the Google Cloud Platform Console project that owns the
-        #   job.
+        #   Required. The ID of the Google Cloud project that owns the job.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -413,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.17.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2022-02-07 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.17.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-storagetransfer_v1/v0.21.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