Overview

Namespaces

  • Alvine
    • Infrastructure
      • Amazon
        • Aws
          • Glacier
            • Retrieval
          • Iam
            • Credentials
            • Datatype
          • S3
            • Element
            • Permission
            • Provider
            • Response
      • Jenkins

Classes

  • AbstractJob
  • AbstractRetrieval
  • Archive
  • Client
  • InitiateJob
  • Job
  • Response
  • Vault
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated

Class AbstractRetrieval

AbstractRetrieval

Alvine\Core\Alvine
Extended by Alvine\Infrastructure\Amazon\Aws\Glacier\AbstractRetrieval

Direct known subclasses

Alvine\Infrastructure\Amazon\Aws\Glacier\Retrieval\Archive, Alvine\Infrastructure\Amazon\Aws\Glacier\Retrieval\Inventory
Abstract
Namespace: Alvine\Infrastructure\Amazon\Aws\Glacier
Package: Alvine\Infrastructure\Amazon\Aws
Category: Alvine
License: Alvine Nutzungslizenz
Author: schukai GmbH info@schukai.de
Version: $Revision:$
Since: 20141104
Link: alvine.io
Link: http://aws.amazon.com/de/documentation/glacier/
Located at glacier/AbstractRetrieval.class.php
Methods summary
public string
# getType( )

getType

getType

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

Returns

string
Typ des Job
public string
# getSNSTopic( )

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
# getDescription( )

getDescription

getDescription

Gibt die optionale Jobbeschreibung zurück

Returns

string
Jobbschreibung
public
# setDescription( string $description )

Beschreibung setzen

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

$description
Jobbeschreibung
public
# setSNSTopic( string $SNSTopic )

SNSTopic setzen

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

$SNSTopic
SNSTopic
public string
# getFields( )

gibt ein JSON String zurück

gibt ein JSON String zurück

Returns

string
Properties summary
protected string $archiveid

ID des Archives

ID des Archives

# null
protected string $type

Jobtyp

Jobtyp

# null
protected string $startdate

Startdatum

Startdatum

# null
protected string $enddate

Enddatum

Enddatum

# null
protected string $snstopic

SNSTopic

SNSTopic

# null
protected string $retrievalbyterange

Byte-Bereich

Byte-Bereich

# null
protected string $marker

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new Initiate Job request to obtain additional inventory items. If there are no more inventory items, this value is null.

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new Initiate Job request to obtain additional inventory items. If there are no more inventory items, this value is null.

Required: no

# null
protected string $limit

Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid Values: An integer value greater than or equal to 1.

Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid Values: An integer value greater than or equal to 1.

Required: no

# null
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. If you are initiating an inventory job and do not specify a Format field, JSON is the default format.

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format.

Valid Values: CSV | JSON

Required: no

# null
protected string $description

Jobbeschreibung

Jobbeschreibung

# null
alvine.infrastructure.amazon.aws API-Dokumentation 0.9.1 | © schukai GmbH | Impressum