class Inventory extends AbstractRetrieval

Inventory

Mit dem Inventory Job wird eine Liste der Archive angefordert die sich in einem Tresor befinden

$job = new \Alvine\Infrastructure\Amazon\Aws\Glacier\Job\Inventory(); $content = $client->initiateJob('schukai',$job);

Properties

protected string $archiveid from AbstractRetrieval
protected string $type from AbstractRetrieval
protected string $startdate from AbstractRetrieval
protected string $enddate from AbstractRetrieval
protected string $snstopic from AbstractRetrieval
protected string $retrievalbyterange from AbstractRetrieval
protected string $marker An opaque string that represents where to continue pagination of the vault inventory retrieval results. from AbstractRetrieval
protected string $limit Specifies the maximum number of inventory items returned per vault inventory retrieval request. from AbstractRetrieval
protected string $format When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. from AbstractRetrieval
protected string $description from AbstractRetrieval

Methods

string
getType()

getType

string
getSNSTopic()

getSNSTopic

string
getDescription()

getDescription

setDescription(string $description)

Beschreibung setzen

setSNSTopic(string $SNSTopic)

SNSTopic setzen

string
getFields()

gibt ein JSON String zurück

__construct()

Neuen Inventory Job erstellen

string
getFormat()

getFormat

setFormat(string $format)

setFormat

setLimit(integer $limit)

setLimit

string
getLimit()

getLimit

setMarker(string $marker)

Marker

string
getMarker()

getMarker

setStartDate(string $startDate)

StartDate

setEndDate(string $endDate)

EndDate setzen

DateTime
getStartDate()

getStartDate

DateTime
getEndDate()

getEndDate

Details

in AbstractRetrieval at line 116
string getType()

getType

Gibt den Typ des Job zurück. Der Typ kann "archive-retrieval" oder "inventory-retrieval" sein

Return Value

string Typ des Job

in AbstractRetrieval at line 129
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

Return Value

string Amazon SNS

in AbstractRetrieval at line 140
string getDescription()

getDescription

Gibt die optionale Jobbeschreibung zurück

Return Value

string Jobbschreibung

in AbstractRetrieval at line 154
setDescription(string $description)

Beschreibung setzen

Setzt die optionale Jobbeschreibung Die Beschreibung muss weniger oder gleich 1024 Bytes groß sein. Die zulässigen Zeichen sind 7-Bit ASCII ohne Steuercodes, ASCII-Werte von 32 bis 126 dezimal oder 0x20-0x7E hexadezimal.

Parameters

string $description Jobbeschreibung

in AbstractRetrieval at line 166
setSNSTopic(string $SNSTopic)

SNSTopic setzen

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

string $SNSTopic SNSTopic

in AbstractRetrieval at line 175
string getFields()

gibt ein JSON String zurück

Return Value

string

at line 47
__construct()

Neuen Inventory Job erstellen

at line 62
string getFormat()

getFormat

Bei der Erstellung eines Inventar-Job abzurufen, kann optional das Ausgabeformat bestimmt werden. das Standard Ausgabeformat ist "JSON"

Return Value

string Ausgabeformat

at line 73
setFormat(string $format)

setFormat

setzt das Ausgabeformat für den Download

Parameters

string $format Ausgabeformat

at line 86
setLimit(integer $limit)

setLimit

setzt die Limit der Inventory Einträge, die zurück geliefert werden sollen

Parameters

integer $limit Anzahl der Einträge

at line 97
string getLimit()

getLimit

gibt die das Limit der Einträge zurück

Return Value

string

at line 110
setMarker(string $marker)

Marker

setzt einen Marker. Dieser Marker wird für dafür verwendet um weitere Daten nachladen zu können. Aus dem DescribeJob

Parameters

string $marker Marker

at line 120
string getMarker()

getMarker

Return Value

string Marker

at line 136
setStartDate(string $startDate)

StartDate

Setzt das Startdatum in UTC für Tresorbestandsinventory Retrieval-Jobs, die Archive, die "am" oder "nach" diesem Datum erstellt wurden, werden ausgegeben.

Es wird ein String im ISO8601 Format "2014-11-03T18:35:38.593Z" erwartet.

Parameters

string $startDate

Exceptions

FormatException Falsches Format

at line 152
setEndDate(string $endDate)

EndDate setzen

Das Ende des Zeitraums in UTC für Tresorbestandsinventory Retrieval, die Archive "vor" diesem Datum erstellt wurden, werden ausgegeben.

Es wird ein String im ISO8601 Format "2014-11-03T18:35:38.593Z" erwartet

Parameters

string $endDate Enddatum

Exceptions

FormatException Falsches Format

at line 163
DateTime getStartDate()

getStartDate

gibt das Startdatum zurück

Return Value

DateTime Startdatum

at line 174
DateTime getEndDate()

getEndDate

gibt das Ebddatum zurück

Return Value

DateTime