Class: Google::Apis::StoragetransferV1::TransferJob

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

This resource represents the configuration of a transfer job that runs periodically.

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) ⇒ TransferJob

Returns a new instance of TransferJob



567
568
569
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 567

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

Returns:

  • (String) 


521
522
523
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 521

def creation_time
  @creation_time
end

#deletion_time ⇒ String

This field cannot be changed by user requests. Corresponds to the JSON property deletionTime

Returns:

  • (String) 


554
555
556
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 554

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

Returns:

  • (String) 


516
517
518
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 516

def description
  @description
end

#last_modification_time ⇒ String

This field cannot be changed by user requests. Corresponds to the JSON property lastModificationTime

Returns:

  • (String) 


565
566
567
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 565

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

Returns:

  • (String) 


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

def name
  @name
end

#project_id ⇒ String

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

Returns:

  • (String) 


560
561
562
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 560

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

Returns:



541
542
543
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 541

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

Returns:

  • (String) 


536
537
538
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 536

def status
  @status
end

#transfer_spec ⇒ Google::Apis::StoragetransferV1::TransferSpec

Configuration for running a transfer. Corresponds to the JSON property transferSpec

Returns:



526
527
528
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 526

def transfer_spec
  @transfer_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



572
573
574
575
576
577
578
579
580
581
582
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 572

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @transfer_spec = args[:transfer_spec] if args.key?(:transfer_spec)
  @status = args[:status] if args.key?(:status)
  @schedule = args[:schedule] if args.key?(:schedule)
  @name = args[:name] if args.key?(:name)
  @deletion_time = args[:deletion_time] if args.key?(:deletion_time)
  @project_id = args[:project_id] if args.key?(:project_id)
  @last_modification_time = args[:last_modification_time] if args.key?(:last_modification_time)
end