REST Resource: deployments.groups.configs

Resource: Config

A configuration of a deployment.

JSON representation
{
  "name": string,
  "title": string,
  "description": string,
  "defaultUpdateDescription": {
    object (UpdateDescription)
  },
  "localizedUpdateDescriptions": [
    {
      object (LocalizedUpdateDescription)
    }
  ],
  "urgencyMode": enum (UrgencyMode),
  "wifiOnlyTime": enum (WifiOnlyTime),
  "updateMaintenanceWindow": {
    object (TimeWindow)
  },
  "packageSizeAwareBatteryThreshold": boolean,
  "offPeakUpdate": {
    object (OffPeakUpdate)
  },
  "countryRestriction": {
    object (IncludeExclude)
  },
  "mobileNetworkRestriction": {
    object (IncludeExclude)
  },
  "deviceBuildPropertyRestriction": {
    object (IncludeExclude)
  },
  "updateRequiredSetup": boolean,
  "minimalSpaceRequired": enum (SpaceNeed),
  "immediateRelease": boolean,
  "rolloutSteps": [
    {
      object (RolloutStep)
    }
  ],
  "securityUpdate": boolean,
  "details": {
    object (ConfigDetails)
  },
  "allowEncryptedScheduledInstall": boolean
}
Fields
name

string

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

title

string

Optional. The title of the config.

description

string

Optional. The description of the config.

defaultUpdateDescription

object (UpdateDescription)

Required. The default UI text used when the device locale doesn't match any locales specified in localizedUpdateDescriptions.

localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

Optional. A list of localized update descriptions, which take priority over defaultUpdateDescription if one of them matches the device locale.

urgencyMode

enum (UrgencyMode)

Optional. The update urgency that dictates how a user will be prompted. If left unspecified, a default of MANDATORY will be used.

wifiOnlyTime

enum (WifiOnlyTime)

Optional. Defaulted to SEVEN_DAYS if left as WIFI_ONLY_TIME_UNSPECIFIED.

Note: this will be set to FOREVER if urgencyMode is RECOMMENDED.

updateMaintenanceWindow

object (TimeWindow)

Optional. The installation time window for the OTA.

packageSizeAwareBatteryThreshold

boolean

Optional. Whether the update should have different installation battery thresholds depending on its size.

offPeakUpdate

object (OffPeakUpdate)

Optional. The off-peak update object.

countryRestriction

object (IncludeExclude)

Optional. The possible included/excluded countries.

mobileNetworkRestriction

object (IncludeExclude)

Optional. The possible included/excluded mobile networks.

deviceBuildPropertyRestriction

object (IncludeExclude)

Optional. The possible included/excluded device build property restriction.

updateRequiredSetup

boolean

Optional. Indicates if the update is required during the setup wizard. Defaults to false.

minimalSpaceRequired

enum (SpaceNeed)

Optional. The minimal space requirement. When the value is UNSPECIFIED, the server will not set a restriction. Requires GMSCore 6.1.11 or later.

immediateRelease

boolean

One of immediateRelease or rolloutSteps is required. Whether the update should be released immediately. If this is true, rolloutSteps should be unset.

rolloutSteps[]

object (RolloutStep)

One of rolloutSteps or immediateRelease is required. RolloutSteps must be in order: both time_ms and fraction should be non-decreasing. The last step should have fraction == 100.

securityUpdate

boolean

Optional. Marks the update as a security update. This is passed to the device to coordinate the display of the correct update message. That is, to display the text "applying security update" rather than "applying system update". Requires API level 22 or later and GMSCore 9.4 or later.

details

object (ConfigDetails)

Output only. More details of a config. This should only be returned by the server when returning the config.

allowEncryptedScheduledInstall

boolean

Optional. Whether or not a package is allowed to be scheduled for installation on encrypted devices.

Methods

list

Lists configs of the group.