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



857
858
859
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 857

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) 


811
812
813
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 811

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) 


836
837
838
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 836

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) 


806
807
808
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 806

def description
  @description
end

#last_modification_time ⇒ String

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

Returns:

  • (String) 


855
856
857
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 855

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) 


844
845
846
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 844

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) 


850
851
852
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 850

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:



831
832
833
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 831

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) 


826
827
828
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 826

def status
  @status
end

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

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

Returns:



816
817
818
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 816

def transfer_spec
  @transfer_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



862
863
864
865
866
867
868
869
870
871
872
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 862

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)
  @deletion_time = args[:deletion_time] if args.key?(:deletion_time)
  @name = args[:name] if args.key?(:name)
  @project_id = args[:project_id] if args.key?(:project_id)
  @last_modification_time = args[:last_modification_time] if args.key?(:last_modification_time)
end