Class: Google::Cloud::StorageTransfer::V1::UpdateTransferJobRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/storagetransfer/v1/transfer.rb

Overview

Request passed to UpdateTransferJob.

Instance Attribute Summary collapse

Instance Attribute Details

#job_name ⇒ ::String

Returns Required. The name of job to update.

Returns:

  • (::String) —

    Required. The name of job to update.



78
79
80
81
 
# File 'proto_docs/google/storagetransfer/v1/transfer.rb', line 78

class UpdateTransferJobRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#project_id ⇒ ::String

Returns Required. The ID of the Google Cloud project that owns the job.

Returns:

  • (::String) —

    Required. The ID of the Google Cloud project that owns the job.



78
79
80
81
 
# File 'proto_docs/google/storagetransfer/v1/transfer.rb', line 78

class UpdateTransferJobRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transfer_job ⇒ ::Google::Cloud::StorageTransfer::V1::TransferJob

Returns Required. The job to update. transferJob is expected to specify one or more of five fields: description, transfer_spec, notification_config, logging_config, and status. An UpdateTransferJobRequest that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires storagetransfer.jobs.delete permission.

Returns:



78
79
80
81
 
# File 'proto_docs/google/storagetransfer/v1/transfer.rb', line 78

class UpdateTransferJobRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_transfer_job_field_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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, 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.

Returns:



78
79
80
81
 
# File 'proto_docs/google/storagetransfer/v1/transfer.rb', line 78

class UpdateTransferJobRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end