PHP Class Scalr\Service\Aws\CloudFront\DataType\DistributionData

Since: 01.02.2013
Author: Vitaliy Demidov ([email protected])
Inheritance: extends Scalr\Service\Aws\CloudFront\AbstractCloudFrontDataType
Afficher le fichier Open project: scalr/scalr Class Usage Examples

Méthodes publiques

Свойство Type Description
$distributionId string The identifier for the distribution
$domainName string The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.
$inProgressInvalidationBatches string The number of invalidation batches currently in progress for this distribution Valid Values: 0 | 1 | 2 | 3
$lastModifiedTime DateTime The date and time the distribution was last modified.
$status string Valid Values: Deployed | InProgress

Protected Properties

Свойство Type Description
$_externalKeys array List of external identifier names.
$_properties array List of the public properties which is managed by magic getter and setters internally.

Méthodes publiques

Méthode Description
delete ( string $eTag = null ) : boolean DELETE Distribution Config action
refresh ( ) : DistributionData GET Distribution action
refreshConfig ( ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData GET Distribution Config action
setConfig ( Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData | string $config, string $eTag ) : DistributionData PUT Distribution Config action

Méthodes protégées

Méthode Description
throwExceptionIfNotInitialized ( )

Method Details

delete() public méthode

DELETE Distribution Config action
public delete ( string $eTag = null ) : boolean
$eTag string optional ETag that is retrieved from getDistributionConfig request.
Résultat boolean Returns true on success

refresh() public méthode

This method refreshes current object using API request to AWS. NOTE! It refreshes object itself only when EntityManager is enabled. Decision is to use $object = object->refresh() instead;
public refresh ( ) : DistributionData
Résultat DistributionData

refreshConfig() public méthode

Refreshes distribution config data set using API request to Amazon. NOTE! It refreshes object itself only when EntityManager is enabled. Decision is to use $object = object->refreshConfig() instead;
public refreshConfig ( ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData
Résultat Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData

setConfig() public méthode

PUT Distribution Config action
public setConfig ( Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData | string $config, string $eTag ) : DistributionData
$config Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData | string Config for distribution. It accepts object or xml document.
$eTag string ETag that is retrieved from getDistributionConfig request.
Résultat DistributionData Returns DistributionData object.

throwExceptionIfNotInitialized() protected méthode

protected throwExceptionIfNotInitialized ( )

Property Details

$_externalKeys protected_oe property

List of external identifier names.
protected array $_externalKeys
Résultat array

$_properties protected_oe property

List of the public properties which is managed by magic getter and setters internally.
protected array $_properties
Résultat array

$distributionId public_oe property

The identifier for the distribution
public string $distributionId
Résultat string

$domainName public_oe property

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.
public string $domainName
Résultat string

$inProgressInvalidationBatches public_oe property

The number of invalidation batches currently in progress for this distribution Valid Values: 0 | 1 | 2 | 3
public string $inProgressInvalidationBatches
Résultat string

$lastModifiedTime public_oe property

The date and time the distribution was last modified.
public DateTime $lastModifiedTime
Résultat DateTime

$status public_oe property

Valid Values: Deployed | InProgress
public string $status
Résultat string