Class: SfCli::Sf::Data::JobInfo

Inherits:
Struct
  • Object
show all
Defined in:
lib/sf_cli/sf/data/bulk_result_v2.rb

Overview

Bulk Job information.

You can check the job status using the following method:

  • opened?

  • upload_completed?

  • in_progress?

  • completed?

See Also: the guide document

Examples:

result = sf.data.delete_resume job_id: jobinfo.id
puts 'yey!' if result.job_info.completed? # the job has completed

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#apexProcessingTime ⇒ Object

Returns the value of attribute apexProcessingTime

Returns:

  • (Object) —

    the current value of apexProcessingTime



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def apexProcessingTime
  @apexProcessingTime
end

#apiActiveProcessingTime ⇒ Object

Returns the value of attribute apiActiveProcessingTime

Returns:

  • (Object) —

    the current value of apiActiveProcessingTime



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def apiActiveProcessingTime
  @apiActiveProcessingTime
end

#apiVersion ⇒ Object

Returns the value of attribute apiVersion

Returns:

  • (Object) —

    the current value of apiVersion



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def apiVersion
  @apiVersion
end

#columnDelimiter ⇒ Object

Returns the value of attribute columnDelimiter

Returns:

  • (Object) —

    the current value of columnDelimiter



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def columnDelimiter
  @columnDelimiter
end

#concurrencyMode ⇒ Object

Returns the value of attribute concurrencyMode

Returns:

  • (Object) —

    the current value of concurrencyMode



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def concurrencyMode
  @concurrencyMode
end

#contentType ⇒ Object

Returns the value of attribute contentType

Returns:

  • (Object) —

    the current value of contentType



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def contentType
  @contentType
end

#createdById ⇒ Object

Returns the value of attribute createdById

Returns:

  • (Object) —

    the current value of createdById



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def createdById
  @createdById
end

#createdDate ⇒ Object

Returns the value of attribute createdDate

Returns:

  • (Object) —

    the current value of createdDate



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def createdDate
  @createdDate
end

#externalIdFieldName ⇒ Object

Returns the value of attribute externalIdFieldName

Returns:

  • (Object) —

    the current value of externalIdFieldName



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def externalIdFieldName
  @externalIdFieldName
end

#id ⇒ Object

Returns the value of attribute id

Returns:

  • (Object) —

    the current value of id



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def id
  @id
end

#isPkChunkingSupported ⇒ Object

Returns the value of attribute isPkChunkingSupported

Returns:

  • (Object) —

    the current value of isPkChunkingSupported



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def isPkChunkingSupported
  @isPkChunkingSupported
end

#jobType ⇒ Object

Returns the value of attribute jobType

Returns:

  • (Object) —

    the current value of jobType



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def jobType
  @jobType
end

#lineEnding ⇒ Object

Returns the value of attribute lineEnding

Returns:

  • (Object) —

    the current value of lineEnding



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def lineEnding
  @lineEnding
end

#numberRecordsFailed ⇒ Object

Returns the value of attribute numberRecordsFailed

Returns:

  • (Object) —

    the current value of numberRecordsFailed



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def numberRecordsFailed
  @numberRecordsFailed
end

#numberRecordsProcessed ⇒ Object

Returns the value of attribute numberRecordsProcessed

Returns:

  • (Object) —

    the current value of numberRecordsProcessed



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def numberRecordsProcessed
  @numberRecordsProcessed
end

#object ⇒ Object

Returns the value of attribute object

Returns:

  • (Object) —

    the current value of object



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def object
  @object
end

#operation ⇒ Object

Returns the value of attribute operation

Returns:

  • (Object) —

    the current value of operation



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def operation
  @operation
end

#retries ⇒ Object

Returns the value of attribute retries

Returns:

  • (Object) —

    the current value of retries



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def retries
  @retries
end

#state ⇒ Object

Returns the value of attribute state

Returns:

  • (Object) —

    the current value of state



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def state
  @state
end

#systemModstamp ⇒ Object

Returns the value of attribute systemModstamp

Returns:

  • (Object) —

    the current value of systemModstamp



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def systemModstamp
  @systemModstamp
end

#totalProcessingTime ⇒ Object

Returns the value of attribute totalProcessingTime

Returns:

  • (Object) —

    the current value of totalProcessingTime



17
18
19
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 17

def totalProcessingTime
  @totalProcessingTime
end

Instance Method Details

#aborted? ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 60

def aborted?
  state == 'Aborted'
end

#completed? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 52

def completed?
  state == 'JobComplete'
end

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 56

def failed?
  state == 'Failed'
end

#in_progress? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 48

def in_progress?
  state == 'InProgress'
end

#opened? ⇒ Boolean

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 40

def opened?
  state == 'Open'
end

#upload_completed? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/sf_cli/sf/data/bulk_result_v2.rb', line 44

def upload_completed?
  state == 'UploadComplete'
end