Methods summary
public static
Alvine\Infrastructure\Amazon\Aws\Glacier\Job
|
#
getInstanceFromArrayHelper( Alvine\Types\ArrayHelper $arrayHelper )
Neues Job Objekt erstellen
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
Parameters
- $arrayHelper
- Rückgabewerte
Returns
|
public static
Alvine\Infrastructure\Amazon\Aws\Glacier\Job
|
#
getInstanceFromArray( array $array )
Neues Job Objekt erstellen
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
Parameters
Returns
|
public
null|string
|
#
getArchiveID( )
ArchiveID
Bei einen "ArchiveRetrieval" Job, ist das die zum Download anfordernde Archiv-ID.
Ansonsten ist dieses Wert "null".
Returns
null|string
ID des Archives
|
public
string
|
#
getAction( )
Action
gibt die Action des Jobs zurück.
Es kann entweder "ArchiveRetrieval" oder "InventoryRetrieval" sein
Returns
string
Action des Jobs
|
public
boolean
|
#
getCompleted( )
Completed
gibt den Status des Jobs zurück
Wenn der Job fertig ist, kann das Ergebnis runtergeladen werden.
Returns
boolean
Jobstatus
|
public
null|Alvine\Date\DateTime
|
#
getCreationDate( )
CreationDate
Es wird das Datum zurück gegeben ,wann der Job erstellt wurde
Returns
null|Alvine\Date\DateTime
Erstelldatum des Jobs
|
public
null|string
|
#
getStatusCode( )
StatusCode
Es wird der Status des Jobs zurück gegeben
Der Status kann "InProgress", "Succeeded", oder "Failed" sein
Returns
null|string
Jobstatuscode
|
public
null|string
|
#
getVaultARN( )
VaultARN
gibt den Amazonas Resource Name (ARN) zurück
Returns
null|string
Amazonas Resource Name
|
public
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"
Returns
null|integer
Grösse des Archives
|
public
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"
Returns
null|string
HASH Wert
|
public
null|Alvine\Date\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
Returns
null|Alvine\Date\DateTime
Datum der Fertigstellung
|
public
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.
Returns
null|string
Größe in Bytes
|
public
null|string
|
#
getJobDescription( )
getJobDescription
Gibt die Jobbeschreibung zurück
Returns
null|string
Jobbeschreibung
|
public
null|string
|
#
getRetrievalByteRange( )
getRetrievalByteRange
Für einen "ArchiveRetrieval" wird der Byte-Bereich zurück gegeben
Für einen "InventoryRetrieval" ist der Wert "null"
Returns
null|string
Byte-Bereich
|
public
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"
Returns
null|string
HASH Wert
|
public
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
Returns
string
(Amazon SNS)
|
public
string
|
#
getStatusMessage( )
getStatusMessage
Gibt die Statusmeldung in Prosa zurück
Returns
string
Statusmeldung
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\Job
|
#
setAction( string $Action )
setAction
Setzt die Job Aktion
Mögliche Werte : "InProgress", "Succeeded", oder "Failed"
Parameters
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\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"
Parameters
- $ArchiveID
- ID des Archives
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\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"
Parameters
- $ArchiveSizeInBytes
- Größe des Archives
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\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"
Parameters
- $ArchiveSHA256TreeHash
- HASH Wert des Archives
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\Job
|
#
setCompleted( boolean $Completed )
setCompleted
Setzt den Status des Jobs.
Wenn der Job fertig ist, kann das Ergebnis runtergeladen werden.
Parameters
- $Completed
- Status des Jobs
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\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.
Parameters
- $CompletionDate
- Datum der Fertigstellung des Jobs
Returns
Throws
Alvine\Date\FormatException
Falsches Format
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\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.
Parameters
- $CreationDate
- Erstelldatum des Jobs
Returns
Throws
Alvine\Date\FormatException
Falsches Format
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\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.
Parameters
- $InventorySizeInBytes
- Grösse des Inventars
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\Job
|
#
setJobDescription( string $JobDescription )
setJobDescription
Setzt die Jobbeschreibung
Parameters
- $JobDescription
- Jobbeschreibung
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\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"
Parameters
- $RetrievalByteRange
- Byte-Bereich für Archive
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\Job
|
#
setSHA256TreeHash( string $SHA256TreeHash )
setSHA256TreeHash
HASH Wert für den, in dem Initiate Job Anfrage, angeforderten Bereich
Parameters
- $SHA256TreeHash
- HASH Wert
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\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
Parameters
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\Job
|
#
setStatusCode( string $StatusCode )
setStatusCode
Setzt den Status des Jobs
Der Status kann "InProgress", "Succeeded", oder "Failed" sein
Parameters
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\Job
|
#
setStatusMessage( string $StatusMessage )
setStatusMessage
Setzt Sie Status Statusmeldung in Prosa
Parameters
- $StatusMessage
- Statusmeldung in Prosa
Returns
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\Job
|
#
setVaultARN( string $VaultARN )
setVaultARN
Setzt die ARN des Tresors
Format : arn:aws:glacier:us-east-1:012345678901:vaults/examplevault
Parameters
Returns
|
public
|
|
public
Alvine\Infrastructure\Amazon\Aws\Glacier\Retrieval\InventoryParameters
|
#
getInventoryParameters( )
getInventoryParameters
Gibt das Inventory Parameter Objekt zurück
Returns
|
Properties summary
protected
string
|
$action
|
|
protected
string
|
$archiveid
|
|
protected
integer
|
$archivesizeinbytes
|
|
protected
string
|
$archivesha256treehash
|
|
protected
boolean
|
$completed
|
|
protected
Alvine\Date\DateTime
|
$completiondate
|
|
protected
Alvine\Date\DateTime
|
$creationdate
|
|
protected
integer
|
$inventorysizeinbytes
|
|
protected
string
|
$jobdescription
|
|
protected
string
|
$retrievalbyterange
|
|
protected
string
|
$sha256treehash
|
|
protected
string
|
$snstopic
|
|
protected
string
|
$statuscode
|
|
protected
string
|
$statusmessage
Beschreibung des Job Status
Beschreibung des Job Status
|
|
protected
string
|
$vaultarn
Amazonas Resource Name (ARN)
Amazonas Resource Name (ARN)
|
|
protected
Alvine\Infrastructure\Amazon\Aws\Glacier\Retrieval\InventoryParameters
|
$inventoryparameters
|
|
Alvine\Infrastructure\Amazon\Aws\Glacier\AbstractJob