Home Guides Reference Support

REST Resource: deployments.packages

Resource: Package

A package in the OTA config.

JSON representation 
{
  "name": string,
  "title": string,
  "details": {
    object (PackageDetails)
  }
}
Fields
name

string

Output only. The name of the package stored. Note that this is the unique identifier for Package objects and will be generated by the server when a new Package is created.

title

string

The title of the package; that is, the display name.

details

object (PackageDetails)

More details of the package. This field is read only.

PackageDetails

Details of an OTA package.

JSON representation 
{
  "sizeBytes": string,
  "originalFilename": string,
  "preConditions": [
    {
      object (Condition)
    }
  ],
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "properties": {
    object (PackageProperties)
  },
  "webDownloadUrl": string,
  "updateTime": string,
  "uploadState": enum (PackageUploadState),
  "uploadError": string,
  "approved": boolean,
  "versionTag": {
    object (VersionTag)
  }
}
Fields
sizeBytes

string (int64 format)

The package size in bytes.

originalFilename

string

The original filename that is uploaded.

preConditions[]

object (Condition)

The package pre-conditions.

postConditions[]

object (Condition)

The package post-conditions.

properties

object (PackageProperties)

The package properties.

webDownloadUrl

string

The link to download the package directly from Google. For Dashboard / Console use.

updateTime

string (Timestamp format)

The time the package was updated.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
uploadState

enum (PackageUploadState)

The upload state of the package.

uploadError

string

The error occurred when uploading the package. The field will only be set when the uploadState is FAILURE.

approved

boolean

Whether the package is approved in APFE.

versionTag

object (VersionTag)

The package version.

PackageProperties

The attributes of an OTA package.

JSON representation 
{
  "type": enum (PackageType),
  "requiredCache": string,
  "downgrade": boolean,
  "wipe": boolean,
  "streamingPropertyFiles": string
}
Fields
type

enum (PackageType)

OTA package type, such as block based.

requiredCache

string (int64 format)

OTA required cache size in bytes.

downgrade

boolean

Whether the OTA package is a downgrade package.

wipe

boolean

Whether the OTA package will apply the wipe action.

streamingPropertyFiles

string

The specification of the property files used in streaming OTA.

PackageType

The type of package in this OTA.

Enums
PACKAGE_TYPE_UNSPECIFIED Unspecified.
FILE File-based OTA.
BLOCK Block-based OTA.
AB A/B OTA.

PackageUploadState

The state of package uploading.

After the package file is fully transferred, a package will be created and the server will start processing the file to read package properties from it. The upload state will be set to IN_PROGRESS until the processing is done. After processing, the upload state will be set to SUCCESS or FAILURE.

Enums
PACKAGE_UPLOAD_STATE_UNSPECIFIED Unspecified.
SUCCESS Upload succeeded.
FAILURE Upload failed. Most likely it's because the package is not valid (due to various reasons, for example, unable to unzip the file).
IN_PROGRESS The package is still being processed.

Methods

delete

 Deletes a package.

get

 Gets a package.

list

 Lists packages.

listBatchGet

 Lists all the configs that use the specified package.

update

 Updates a package.