REST Resource: deployments.packages

Resource: Package

A package in the OTA config.

JSON representation 
{
  "name": string,
  "title": string,
  "disabled": boolean,
  "deviceBuildRestrictions": [
    {
      object (IncludeExclude)
    }
  ],
  "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.
disabled

boolean

Whether or not the package is disabled for the given deployment.
deviceBuildRestrictions[]

object (IncludeExclude)

Optional. Represents build fingerprint restrictions that may only be applied to full packages. Note that all repeated values must be the same; that is, all include or all exclude. The values can be a substring of the build fingerprint, for example, the restriction value of "ABC" will match any build fingerprint containing the string "ABC".
details

object (PackageDetails)

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

IncludeExclude

Includes or excludes certain patterns.

JSON representation 
{

  // Union field include_exclude can be only one of the following:
  "include": string,
  "exclude": string
  // End of list of possible types for union field include_exclude.
}
Fields
Union field include_exclude. A rule of includes or excludes. include_exclude can be only one of the following:
include

string

Included pattern.
exclude

string

Excluded pattern.

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,
  "uploadUser": string,
  "uploadTime": string,
  "approved": boolean,
  "beta": 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 entry was last modified.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "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.
uploadUser

string

The email of the user who uploaded the package
uploadTime

string (Timestamp format)

The time at which the package was uploaded. This may not be available for all packages.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
approved

boolean

Whether the package is approved in APFE.
beta

boolean

Whether or not the package has been marked as a beta package.
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.