Job
class Job extends AbstractJob
Job
Diese Klasse bildet alle Informationen eines Jobs ab.
Properties
| protected string | $jobid | from AbstractJob | |
| protected string | $action | ||
| protected string | $archiveid | ||
| protected integer | $archivesizeinbytes | ||
| protected string | $archivesha256treehash | ||
| protected boolean | $completed | ||
| protected DateTime | $completiondate | ||
| protected DateTime | $creationdate | ||
| protected integer | $inventorysizeinbytes | ||
| protected string | $jobdescription | ||
| protected string | $retrievalbyterange | ||
| protected string | $sha256treehash | ||
| protected string | $snstopic | ||
| protected string | $statuscode | ||
| protected string | $statusmessage | ||
| protected string | $vaultarn | ||
| protected InventoryParameters | $inventoryparameters |
Methods
Neues Job Objekt erstellen
Neues Job Objekt erstellen
ArchiveID
Action
Completed
CreationDate
StatusCode
VaultARN
getArchiveSizeInBytes
getArchiveSHA256TreeHash
getCompletionDate
getInventorySizeInBytes
getJobDescription
getRetrievalByteRange
getSHA256TreeHash
getSNSTopic
getStatusMessage
setArchiveID
setArchiveSizeInBytes
setArchiveSHA256TreeHash
setCompleted
setCompletionDate
setCreationDate
setInventorySizeInBytes
setJobDescription
setRetrievalByteRange
setSHA256TreeHash
setSNSTopic
setStatusCode
setStatusMessage
setVaultARN
getInventoryParameters
Details
in AbstractJob at line 54
__construct(string $jobID)
Neues Job-Objekt erstellen
Der Konstruktor erstell ein neues Job-Objekt. Das Job-Objekt kann alle Informationen zu einem Job beinhalten
in AbstractJob at line 67
string
getJobID()
JobID
Gibt die ID des Jobs zurück
at line 134
static Job
getInstanceFromArrayHelper(ArrayHelper $arrayHelper)
Neues Job Objekt erstellen
Diese Methode erstellt aus einem von der REST-API zurückgegebenen Ergebnisses ein Job-Objekt.
Der Aufbau des Arrays ergibt sich aus dem json-String
at line 171
static Job
getInstanceFromArray(array $array)
Neues Job Objekt erstellen
Diese Methode erstellt aus einem von der REST-API zurückgegebenen Ergebnisses ein Job-Objekt.
Der Aufbau des Arrays ergibt sich aus dem json-String
at line 184
null|string
getArchiveID()
ArchiveID
Bei einen "ArchiveRetrieval" Job, ist das die zum Download anfordernde Archiv-ID. Ansonsten ist dieses Wert "null".
at line 196
string
getAction()
Action
gibt die Action des Jobs zurück. Es kann entweder "ArchiveRetrieval" oder "InventoryRetrieval" sein
at line 208
boolean
getCompleted()
Completed
gibt den Status des Jobs zurück Wenn der Job fertig ist, kann das Ergebnis runtergeladen werden.
at line 219
null|DateTime
getCreationDate()
CreationDate
Es wird das Datum zurück gegeben ,wann der Job erstellt wurde
at line 231
null|string
getStatusCode()
StatusCode
Es wird der Status des Jobs zurück gegeben Der Status kann "InProgress", "Succeeded", oder "Failed" sein
at line 242
null|string
getVaultARN()
VaultARN
gibt den Amazonas Resource Name (ARN) zurück
at line 254
null|integer
getArchiveSizeInBytes()
getArchiveSizeInBytes
Nur bei Action Typ "ArchiveRetrieval" wird die Grösse des Archives zurück gegeben Für einen "InventoryRetrieval" Job ist der Wert "NULL"
at line 266
null|string
getArchiveSHA256TreeHash()
getArchiveSHA256TreeHash
Nur für ein "ArchiveRetrieval" Job, wird der HASH Wert des Archives zurück gegeben. Für einen "InventoryRetrieval" ist dieser Wert "NULL"
at line 278
null|DateTime
getCompletionDate()
getCompletionDate
Gib das Datum rurück , wann die Bearbeitung des Jobs abgeschlossen war. Während der Job bearbeitet wird ist der Wert NULL
at line 290
null|string
getInventorySizeInBytes()
getInventorySizeInBytes
Für einen "InventoryRetrieval" Job, wird die Größe in Bytes der zum Download angeforderten Inventars zurück gegeben. Für ein "ArchiveRetrieval" Job, ist der Wert null.
at line 301
null|string
getJobDescription()
getJobDescription
Gibt die Jobbeschreibung zurück
at line 313
null|string
getRetrievalByteRange()
getRetrievalByteRange
Für einen "ArchiveRetrieval" wird der Byte-Bereich zurück gegeben Für einen "InventoryRetrieval" ist der Wert "null"
at line 325
null|string
getSHA256TreeHash()
getSHA256TreeHash
Nur für ein "ArchiveRetrieval" Job, wird der HASH Wert des Archives zurück gegeben. Für einen "InventoryRetrieval" ist dieser Wert "NULL"
at line 338
string
getSNSTopic()
getSNSTopic
Gibt ein Amazon Simple Notification Service (Amazon SNS) Thema, das Benachrichtigungen erhält zurück
Format: arn:aws:sns:us-east-1:012345678901:mytopic
at line 349
string
getStatusMessage()
getStatusMessage
Gibt die Statusmeldung in Prosa zurück
at line 363
Job
setAction(string $Action)
setAction
Setzt die Job Aktion Mögliche Werte : "InProgress", "Succeeded", oder "Failed"
at line 379
Job
setArchiveID(string $ArchiveID)
setArchiveID
Nur für ein "ArchiveRetrieval" Job, wird die ID des Archives gesetzt. Für einen "InventoryRetrieval" ist dieser Wert "NULL"
at line 394
Job
setArchiveSizeInBytes(integer $ArchiveSizeInBytes)
setArchiveSizeInBytes
Nur für ein "ArchiveRetrieval" Job, wird die Größe des Archives gesetzt. Für einen "InventoryRetrieval" ist dieser Wert "NULL"
at line 409
Job
setArchiveSHA256TreeHash(string $ArchiveSHA256TreeHash)
setArchiveSHA256TreeHash
Nur für ein "ArchiveRetrieval" Job, wird der HASH Wert des Archives gesetzt. Für einen "InventoryRetrieval" ist dieser Wert "NULL"
at line 424
Job
setCompleted(boolean $Completed)
setCompleted
Setzt den Status des Jobs. Wenn der Job fertig ist, kann das Ergebnis runtergeladen werden.
at line 441
Job
setCompletionDate(string $CompletionDate)
setCompletionDate
Setzt das Datum wann die Bearbeitung des Jobs abgeschlossen war. Es wird ein String im ISO8601 Format "2014-11-03T18:35:38.593Z" erwartet.
at line 458
Job
setCreationDate(string $CreationDate)
setCreationDate
Setzt das Datum wann der Jobs erstellt worden ist. Es wird ein String im ISO8601 Format "2014-11-03T18:35:38.593Z" erwartet.
at line 473
Job
setInventorySizeInBytes(string $InventorySizeInBytes)
setInventorySizeInBytes
Für einen "InventoryRetrieval" Job, wird die Größe in Bytes der zum Download angeforderten Inventars gesetzt. Für ein "ArchiveRetrieval" Job, ist der Wert null.
at line 487
Job
setJobDescription(string $JobDescription)
setJobDescription
Setzt die Jobbeschreibung
at line 505
Job
setRetrievalByteRange(string $RetrievalByteRange)
setRetrievalByteRange
Setzten des Byte-Bereichs für "ArchiveRetrieval" Jobs. Wenn kein Bereich angegeben wird, wird das gesamte Archiv abgerufen. Für einen "InventoryRetrieval" Job, dieses Feld ist "null".
Format: "StartByteValue-EndByteValue"
at line 519
Job
setSHA256TreeHash(string $SHA256TreeHash)
setSHA256TreeHash
HASH Wert für den, in dem Initiate Job Anfrage, angeforderten Bereich
at line 535
Job
setSNSTopic(string $SNSTopic)
setSNSTopic
Ein Amazon Simple Notification Service (Amazon SNS) Thema, das Benachrichtigungen erhält. Es wird ein String in diesem Format erwartet: arn:aws:sns:us-east-1:012345678901:mytopic
at line 550
Job
setStatusCode(string $StatusCode)
setStatusCode
Setzt den Status des Jobs Der Status kann "InProgress", "Succeeded", oder "Failed" sein
at line 564
Job
setStatusMessage(string $StatusMessage)
setStatusMessage
Setzt Sie Status Statusmeldung in Prosa
at line 580
Job
setVaultARN(string $VaultARN)
setVaultARN
Setzt die ARN des Tresors
Format : arn:aws:glacier:us-east-1:012345678901:vaults/examplevault
at line 592
setInventoryParameters(InventoryParameters $InventoryParameters)
setInventoryParameters
setzt das Inventory Parameter Objekt
at line 604
InventoryParameters
getInventoryParameters()
getInventoryParameters
Gibt das Inventory Parameter Objekt zurück