Class: Google::Apis::StoragetransferV1::TransferJob
- Inherits:
-
Object
- Object
- Google::Apis::StoragetransferV1::TransferJob
- 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
This resource represents the configuration of a transfer job that runs periodically.
Instance Attribute Summary collapse
-
#creation_time ⇒ String
This field cannot be changed by user requests.
-
#deletion_time ⇒ String
This field cannot be changed by user requests.
-
#description ⇒ String
A description provided by the user for the job.
-
#last_modification_time ⇒ String
This field cannot be changed by user requests.
-
#name ⇒ String
A globally unique name assigned by Storage Transfer Service when the job is created.
-
#project_id ⇒ String
The ID of the Google Developers Console project that owns the job.
-
#schedule ⇒ Google::Apis::StoragetransferV1::Schedule
Transfers can be scheduled to recur or to run just once.
-
#status ⇒ String
Status of the job.
-
#transfer_spec ⇒ Google::Apis::StoragetransferV1::TransferSpec
Configuration for running a transfer.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TransferJob
constructor
A new instance of TransferJob.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ TransferJob
Returns a new instance of TransferJob.
101 102 103 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 101 def initialize(**args) update!(**args) end |
Instance Attribute Details
#creation_time ⇒ String
This field cannot be changed by user requests.
Corresponds to the JSON property creationTime
89 90 91 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 89 def creation_time @creation_time end |
#deletion_time ⇒ String
This field cannot be changed by user requests.
Corresponds to the JSON property deletionTime
99 100 101 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 99 def deletion_time @deletion_time end |
#description ⇒ String
A description provided by the user for the job. Its max length is 1024 bytes
when Unicode-encoded.
Corresponds to the JSON property description
60 61 62 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 60 def description @description end |
#last_modification_time ⇒ String
This field cannot be changed by user requests.
Corresponds to the JSON property lastModificationTime
94 95 96 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 94 def last_modification_time @last_modification_time end |
#name ⇒ String
A globally unique name assigned by Storage Transfer Service when the job is
created. This field should be left empty in requests to create a new transfer
job; otherwise, the requests result in an INVALID_ARGUMENT
error.
Corresponds to the JSON property name
54 55 56 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 54 def name @name end |
#project_id ⇒ String
The ID of the Google Developers Console project that owns the job. Required.
Corresponds to the JSON property projectId
65 66 67 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 65 def project_id @project_id end |
#schedule ⇒ Google::Apis::StoragetransferV1::Schedule
Transfers can be scheduled to recur or to run just once.
Corresponds to the JSON property schedule
75 76 77 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 75 def schedule @schedule end |
#status ⇒ String
Status of the job. This value MUST be specified for CreateTransferJobRequests
. NOTE: The effect of the new job status takes place during a subsequent job
run. For example, if you change the job status from ENABLED
to DISABLED
,
and an operation spawned by the transfer is running, the status change would
not affect the current operation.
Corresponds to the JSON property status
84 85 86 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 84 def status @status end |
#transfer_spec ⇒ Google::Apis::StoragetransferV1::TransferSpec
Configuration for running a transfer.
Corresponds to the JSON property transferSpec
70 71 72 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 70 def transfer_spec @transfer_spec end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
106 107 108 109 110 111 112 113 114 115 116 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 106 def update!(**args) @name = args[:name] if args.key?(:name) @description = args[:description] if args.key?(:description) @project_id = args[:project_id] if args.key?(:project_id) @transfer_spec = args[:transfer_spec] if args.key?(:transfer_spec) @schedule = args[:schedule] if args.key?(:schedule) @status = args[:status] if args.key?(:status) @creation_time = args[:creation_time] if args.key?(:creation_time) @last_modification_time = args[:last_modification_time] if args.key?(:last_modification_time) @deletion_time = args[:deletion_time] if args.key?(:deletion_time) end |