google-apis-storagetransfer_v1 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33beef39971f8bfc7a6fdb9fc3fd16da7e5df20f3632dee4f6d48e0f0251e1f2
-  data.tar.gz: fd8b01675092c799fb65a831534c704cce9ab06b5beffa701a83cfd00251ab83
+  metadata.gz: 305479bdffb83be01832c4730e409749509632b8cbbc4f801be98e4ae35aa349
+  data.tar.gz: 9c4bf66c84fcd8e09d94058c3b50b23e0050df32c9e090de0cb98f9fb07b0bb2
 SHA512:
-  metadata.gz: 85aed3dcfe580764d6acff07cbe14528a98a8eacfee85f684a32199101d6f0a31ed8611bf4939506de9e0ec72207cd6abf235e96ad7dcf4d475942167764402b
-  data.tar.gz: 36ca333b5610ef6ae1c52ab1e96b891e448488a4fbed828e835f57b66952fc232b19402d33fe78e95165c3a552414771c9293ec59010c15b88fb054623b5b283
+  metadata.gz: 9df6a8e6c04f7da755789930968e8dcffe15d3538b05aaaacfbff5da8937dfab1465b45d73a804c87a236bdfbdbfb4000701f1cbe6205c0e2bbe98d05c190ba2
+  data.tar.gz: c4aa126f7a9ad156fadce7b3ca6f2737011a1a9ce8dbf0035310bf03a4ed9019b02a5dc0d9d06b861e15762f789edd9e882b0f48155c001192d9c596fb457900

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Release history for google-apis-storagetransfer_v1
 
+### v0.6.0 (2021-03-31)
+
+* Regenerated from discovery document revision 20210325
+* Regenerated using generator version 0.2.0
+
+### v0.5.0 (2021-03-04)
+
+* Unspecified changes
+
+### v0.4.0 (2021-02-24)
+
+* Regenerated from discovery document revision 20210218
+
+### v0.3.0 (2021-02-17)
+
+* Regenerated from discovery document revision 20210211
+
+### v0.2.0 (2021-02-03)
+
+* Regenerated from discovery document revision 20210128
+* Regenerated using generator version 0.1.2
+
 ### v0.1.0 (2021-01-07)
 
 * Regenerated using generator version 0.1.1

data/lib/google/apis/storagetransfer_v1.rb

@@ -30,7 +30,7 @@ module Google
       # This is NOT the gem version.
       VERSION = 'V1'
 
-      # View and manage your data across Google Cloud Platform services
+      # See, edit, configure, and delete your Google Cloud Platform data
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
     end
   end

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

@@ -24,8 +24,8 @@ module Google
       
       # AWS access key (see [AWS Security Credentials](https://docs.aws.amazon.com/
       # general/latest/gr/aws-security-credentials.html)). For information on our data
-      # retention policy for user credentials, see [User credentials](data-retention#
-      # user-credentials).
+      # retention policy for user credentials, see [User credentials](/storage-
+      # transfer/docs/data-retention#user-credentials).
       class AwsAccessKey
         include Google::Apis::Core::Hashable
       
@@ -57,8 +57,8 @@ module Google
       
         # AWS access key (see [AWS Security Credentials](https://docs.aws.amazon.com/
         # general/latest/gr/aws-security-credentials.html)). For information on our data
-        # retention policy for user credentials, see [User credentials](data-retention#
-        # user-credentials).
+        # retention policy for user credentials, see [User credentials](/storage-
+        # transfer/docs/data-retention#user-credentials).
         # Corresponds to the JSON property `awsAccessKey`
         # @return [Google::Apis::StoragetransferV1::AwsAccessKey]
         attr_accessor :aws_access_key
@@ -99,7 +99,8 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Azure credentials For information on our data retention policy for user
-        # credentials, see [User credentials](data-retention#user-credentials).
+        # credentials, see [User credentials](/storage-transfer/docs/data-retention#user-
+        # credentials).
         # Corresponds to the JSON property `azureCredentials`
         # @return [Google::Apis::StoragetransferV1::AzureCredentials]
         attr_accessor :azure_credentials
@@ -135,7 +136,8 @@ module Google
       end
       
       # Azure credentials For information on our data retention policy for user
-      # credentials, see [User credentials](data-retention#user-credentials).
+      # credentials, see [User credentials](/storage-transfer/docs/data-retention#user-
+      # credentials).
       class AzureCredentials
         include Google::Apis::Core::Hashable
       
@@ -479,31 +481,44 @@ module Google
       class ObjectConditions
         include Google::Apis::Core::Hashable
       
-        # `exclude_prefixes` must follow the requirements described for include_prefixes.
-        # The max size of `exclude_prefixes` is 1000.
+        # If you specify `exclude_prefixes`, Storage Transfer Service uses the items in
+        # the `exclude_prefixes` array to determine which objects to exclude from a
+        # transfer. Objects must not start with one of the matching `exclude_prefixes`
+        # for inclusion in a transfer. The following are requirements of `
+        # exclude_prefixes`: * Each exclude-prefix can contain any sequence of Unicode
+        # characters, to a max length of 1024 bytes when UTF8-encoded, and must not
+        # contain Carriage Return or Line Feed characters. Wildcard matching and regular
+        # expression matching are not supported. * Each exclude-prefix must omit the
+        # leading slash. For example, to exclude the object `s3://my-aws-bucket/logs/y=
+        # 2015/requests.gz`, specify the exclude-prefix as `logs/y=2015/requests.gz`. *
+        # None of the exclude-prefix values can be empty, if specified. * Each exclude-
+        # prefix must exclude a distinct portion of the object namespace. No exclude-
+        # prefix may be a prefix of another exclude-prefix. * If include_prefixes is
+        # specified, then each exclude-prefix must start with the value of a path
+        # explicitly included by `include_prefixes`. The max size of `exclude_prefixes`
+        # is 1000. For more information, see [Filtering objects from transfers](/storage-
+        # transfer/docs/filtering-objects-from-transfers).
         # Corresponds to the JSON property `excludePrefixes`
         # @return [Array<String>]
         attr_accessor :exclude_prefixes
       
-        # If `include_prefixes` is specified, objects that satisfy the object conditions
-        # must have names that start with one of the `include_prefixes` and that do not
-        # start with any of the exclude_prefixes. If `include_prefixes` is not specified,
-        # all objects except those that have names starting with one of the `
-        # exclude_prefixes` must satisfy the object conditions. Requirements: * Each
-        # include-prefix and exclude-prefix can contain any sequence of Unicode
-        # characters, to a max length of 1024 bytes when UTF8-encoded, and must not
-        # contain Carriage Return or Line Feed characters. Wildcard matching and regular
-        # expression matching are not supported. * Each include-prefix and exclude-
-        # prefix must omit the leading slash. For example, to include the `requests.gz`
-        # object in a transfer from `s3://my-aws-bucket/logs/y=2015/requests.gz`,
-        # specify the include prefix as `logs/y=2015/requests.gz`. * None of the include-
-        # prefix or the exclude-prefix values can be empty, if specified. * Each include-
-        # prefix must include a distinct portion of the object namespace. No include-
-        # prefix may be a prefix of another include-prefix. * Each exclude-prefix must
-        # exclude a distinct portion of the object namespace. No exclude-prefix may be a
-        # prefix of another exclude-prefix. * If `include_prefixes` is specified, then
-        # each exclude-prefix must start with the value of a path explicitly included by
-        # `include_prefixes`. The max size of `include_prefixes` is 1000.
+        # If you specify `include_prefixes`, Storage Transfer Service uses the items in
+        # the `include_prefixes` array to determine which objects to include in a
+        # transfer. Objects must start with one of the matching `include_prefixes` for
+        # inclusion in the transfer. If exclude_prefixes is specified, objects must not
+        # start with any of the `exclude_prefixes` specified for inclusion in the
+        # transfer. The following are requirements of `include_prefixes`: * Each include-
+        # prefix can contain any sequence of Unicode characters, to a max length of 1024
+        # bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed
+        # characters. Wildcard matching and regular expression matching are not
+        # supported. * Each include-prefix must omit the leading slash. For example, to
+        # include the object `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the
+        # include-prefix as `logs/y=2015/requests.gz`. * None of the include-prefix
+        # values can be empty, if specified. * Each include-prefix must include a
+        # distinct portion of the object namespace. No include-prefix may be a prefix of
+        # another include-prefix. The max size of `include_prefixes` is 1000. For more
+        # information, see [Filtering objects from transfers](/storage-transfer/docs/
+        # filtering-objects-from-transfers).
         # Corresponds to the JSON property `includePrefixes`
         # @return [Array<String>]
         attr_accessor :include_prefixes
@@ -585,9 +600,8 @@ module Google
         # @return [Hash<String,Object>]
         attr_accessor :metadata
       
-        # 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
-        # have the format of `transferOperations/some/unique/name`.
+        # The server-assigned unique name. The format of `name` is `transferOperations/
+        # some/unique/name`.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -643,6 +657,26 @@ module Google
         end
       end
       
+      # Request passed to RunTransferJob.
+      class RunTransferJobRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The ID of the Google Cloud Platform Console project that owns the
+        # transfer job.
+        # Corresponds to the JSON property `projectId`
+        # @return [String]
+        attr_accessor :project_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @project_id = args[:project_id] if args.key?(:project_id)
+        end
+      end
+      
       # Transfers can be scheduled to recur or to run just once.
       class Schedule
         include Google::Apis::Core::Hashable
@@ -1238,7 +1272,7 @@ module Google
         # 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 will be rejected with the error
+        # specification missing any required fields is rejected with the error
         # INVALID_ARGUMENT.
         # Corresponds to the JSON property `updateTransferJobFieldMask`
         # @return [String]

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.1.0"
+      GEM_VERSION = "0.6.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.1.1"
+      GENERATOR_VERSION = "0.2.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20201210"
+      REVISION = "20210325"
     end
   end
 end

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

@@ -136,6 +136,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class RunTransferJobRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Schedule
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -350,6 +356,13 @@ module Google
         end
       end
       
+      class RunTransferJobRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :project_id, as: 'projectId'
+        end
+      end
+      
       class Schedule
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -228,6 +228,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # 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.
+        # @param [String] job_name
+        #   Required. The name of the transfer job.
+        # @param [Google::Apis::StoragetransferV1::RunTransferJobRequest] run_transfer_job_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::StoragetransferV1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::StoragetransferV1::Operation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def run_transfer_job(job_name, run_transfer_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+jobName}:run', options)
+          command.request_representation = Google::Apis::StoragetransferV1::RunTransferJobRequest::Representation
+          command.request_object = run_transfer_job_request_object
+          command.response_representation = Google::Apis::StoragetransferV1::Operation::Representation
+          command.response_class = Google::Apis::StoragetransferV1::Operation
+          command.params['jobName'] = job_name unless job_name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Cancels a transfer. Use the transferOperations.get method to check if the
         # cancellation succeeded or if the operation completed despite the `cancel`
         # request. When you cancel an operation, the currently running transfer is
@@ -308,9 +343,10 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Lists transfer operations.
+        # Lists transfer operations. Operations are ordered by their creation time in
+        # reverse chronological order.
         # @param [String] name
-        #   Required. The value `transferOperations`.
+        #   Not used.
         # @param [String] filter
         #   Required. A list of query parameters specified as JSON text in the form of: ``"
         #   projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-storagetransfer_v1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-08 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -52,7 +52,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/master/generated/google-apis-storagetransfer_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-storagetransfer_v1/v0.1.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-storagetransfer_v1/v0.6.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-storagetransfer_v1
 post_install_message: 
 rdoc_options: []
@@ -62,14 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.13
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Storage Transfer API V1