REST Resource: deployments.groups

  • A Group is a resource associated with multiple OTA configs and has properties like name, enabled status, and member count.

  • GroupDescription provides localized descriptions for a group, potentially informing users why they receive certain updates.

  • GroupDetails offers read-only information about a group, including associated configs, members, disabled configs, and version tag.

  • The documentation provides details on the JSON representation and fields for the Group, GroupDescription, and GroupDetails resources.

  • Various methods are available for managing Groups, such as creating, deleting, enabling, disabling, getting, listing, and updating them and their associated configs.

Resource: Group

A group that is associated with multiple OTA configs.

JSON representation 
{
  "name": string,
  "enabled": boolean,
  "bypassRolloutSchedule": boolean,
  "descriptions": [
    {
      object (GroupDescription)
    }
  ],
  "defaultDescription": string,
  "production": boolean,
  "memberCount": string,
  "details": {
    object (GroupDetails)
  }
}
Fields
name

string

Required. The name of the group. It must contain only letters, numbers, and underscores.
enabled

boolean

Optional. Whether or not the group is enabled. Defaults to false.
bypassRolloutSchedule

boolean

Optional. The group will bypass the rollout schedule. Defaults to false.
descriptions[]

object (GroupDescription)

Optional. Descriptions for this group which may be shown to end users to inform them why they are receiving updates that aren't aligned with production.
defaultDescription

string

Required. Description used for any locale not explicitly matched.
production

boolean

Read only. Indicates if the group is large enough to be considered a production group.
memberCount

string (int64 format)

Read only. The number of devices currently in the group.
details

object (GroupDetails)

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

GroupDescription

A single translated description.

JSON representation 
{
  "description": string,
  "locales": [
    string
  ]
}
Fields
description

string

A localized description of this group. Note this may be shown to end users to explain why they are receiving a specific update.
locales[]

string

The locales this description should be shown for.

GroupDetails

Details of a group, including associated OTA configurations. All of this information is read only.

JSON representation 
{
  "configs": [
    string
  ],
  "members": [
    {
      object (GroupMember)
    }
  ],
  "disabledConfigs": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
Fields
configs[]

string

The associated configs of the group.
members[]

object (GroupMember)

Members of this group.
disabledConfigs[]

string

The associated disabled configs of the group.
versionTag

object (VersionTag)

The group version.

Methods

create

 Creates a group, and returns the new Group.

delete

 Deletes a group.

disable

 Disables the defined groups.

enable

 Enables the defined groups.

get

 Gets a group.

list

 Lists groups of a deployment.

update

 Updates a group.

updateConfigs

 Updates the configs under a group.