Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::UpdateTransferJobRequest.
Request passed to UpdateTransferJob.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#job_name
def job_name() -> ::String
Returns
- (::String) — Required. The name of job to update.
#job_name=
def job_name=(value) -> ::String
Parameter
- value (::String) — Required. The name of job to update.
Returns
- (::String) — Required. The name of job to update.
#project_id
def project_id() -> ::String
Returns
- (::String) — Required. The ID of the Google Cloud project that owns the job.
#project_id=
def project_id=(value) -> ::String
Parameter
- value (::String) — 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.
#transfer_job
def transfer_job() -> ::Google::Cloud::StorageTransfer::V1::TransferJob
Returns
-
(::Google::Cloud::StorageTransfer::V1::TransferJob) — Required. The job to update.
transferJobis expected to specify one or more of five fields: description, transfer_spec, notification_config, logging_config, and status. AnUpdateTransferJobRequestthat specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requiresstoragetransfer.jobs.deletepermission.
#transfer_job=
def transfer_job=(value) -> ::Google::Cloud::StorageTransfer::V1::TransferJob
Parameter
-
value (::Google::Cloud::StorageTransfer::V1::TransferJob) — Required. The job to update.
transferJobis expected to specify one or more of five fields: description, transfer_spec, notification_config, logging_config, and status. AnUpdateTransferJobRequestthat specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requiresstoragetransfer.jobs.deletepermission.
Returns
-
(::Google::Cloud::StorageTransfer::V1::TransferJob) — Required. The job to update.
transferJobis expected to specify one or more of five fields: description, transfer_spec, notification_config, logging_config, and status. AnUpdateTransferJobRequestthat specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requiresstoragetransfer.jobs.deletepermission.
#update_transfer_job_field_mask
def update_transfer_job_field_mask() -> ::Google::Protobuf::FieldMask
Returns
-
(::Google::Protobuf::FieldMask) — The field mask of the fields in
transferJobthat are to be updated in this request. Fields intransferJobthat can be updated are: description, transfer_spec, notification_config, logging_config, and status. To update thetransfer_specof the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT.
#update_transfer_job_field_mask=
def update_transfer_job_field_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
-
value (::Google::Protobuf::FieldMask) — The field mask of the fields in
transferJobthat are to be updated in this request. Fields intransferJobthat can be updated are: description, transfer_spec, notification_config, logging_config, and status. To update thetransfer_specof the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT.
Returns
-
(::Google::Protobuf::FieldMask) — The field mask of the fields in
transferJobthat are to be updated in this request. Fields intransferJobthat can be updated are: description, transfer_spec, notification_config, logging_config, and status. To update thetransfer_specof the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT.