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



821
822
823
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 821

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

Instance Attribute Details

#creation_time ⇒ String

Output only. The time that the transfer job was created. Corresponds to the JSON property creationTime

Returns:

  • (String) 


770
771
772
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 770

def creation_time
  @creation_time
end

#deletion_time ⇒ String

Output only. The time that the transfer job was deleted. Corresponds to the JSON property deletionTime

Returns:

  • (String) 


775
776
777
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 775

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) 


781
782
783
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 781

def description
  @description
end

#last_modification_time ⇒ String

Output only. The time that the transfer job was last modified. Corresponds to the JSON property lastModificationTime

Returns:

  • (String) 


786
787
788
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 786

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) 


794
795
796
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 794

def name
  @name
end

#project_id ⇒ String

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

Returns:

  • (String) 


799
800
801
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 799

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:



804
805
806
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 804

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) 


814
815
816
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 814

def status
  @status
end

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

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

Returns:



819
820
821
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 819

def transfer_spec
  @transfer_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



826
827
828
829
830
831
832
833
834
835
836
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 826

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