Class: Google::Apis::StoragetransferV1::UpdateTransferJobRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/storagetransfer_v1/classes.rb,
generated/google/apis/storagetransfer_v1/representations.rb,
generated/google/apis/storagetransfer_v1/representations.rb

Overview

Request passed to UpdateTransferJob.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UpdateTransferJobRequest

Returns a new instance of UpdateTransferJobRequest.


550
551
552
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 550

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#project_idString

The ID of the Google Developers Console project that owns the job. Required. Corresponds to the JSON property projectId

Returns:

  • (String)

532
533
534
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 532

def project_id
  @project_id
end

#transfer_jobGoogle::Apis::StoragetransferV1::TransferJob

This resource represents the configuration of a transfer job that runs periodically. Corresponds to the JSON property transferJob


538
539
540
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 538

def transfer_job
  @transfer_job
end

#update_transfer_job_field_maskString

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, transferSpec, and status. To update the transferSpec of the job, a complete transfer specification has to be provided. An incomplete specification which misses any required fields will be rejected with the error INVALID_ARGUMENT. Corresponds to the JSON property updateTransferJobFieldMask

Returns:

  • (String)

548
549
550
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 548

def update_transfer_job_field_mask
  @update_transfer_job_field_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


555
556
557
558
559
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 555

def update!(**args)
  @project_id = args[:project_id] if args.key?(:project_id)
  @transfer_job = args[:transfer_job] if args.key?(:transfer_job)
  @update_transfer_job_field_mask = args[:update_transfer_job_field_mask] if args.key?(:update_transfer_job_field_mask)
end