REST Resource: deployments.groups

Zasób: grupa

Grupa powiązana z wieloma konfiguracjami OTA.

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

string

To pole jest wymagane. Nazwa grupy. Może zawierać tylko litery, cyfry i podkreślenia.

enabled

boolean

Opcjonalnie. Określa, czy grupa jest włączona. Wartość domyślna to fałsz.

bypassRolloutSchedule

boolean

Opcjonalnie. Grupa pominie harmonogram wdrażania. Wartość domyślna to fałsz.

descriptions[]

object (GroupDescription)

Opcjonalnie. Opisy w tej grupie, które mogą się wyświetlać użytkownikom, aby poinformować ich, dlaczego otrzymują aktualizacje, które nie są zgodne z production.

defaultDescription

string

To pole jest wymagane. Opis używany dla dowolnego języka, który nie jest wyraźnie dopasowany.

production

boolean

Tylko do odczytu. Wskazuje, czy grupa jest wystarczająco duża, aby można ją było uznać za grupę produkcyjną.

memberCount

string (int64 format)

Tylko do odczytu. Liczba urządzeń obecnie w grupie.

details

object (GroupDetails)

Tylko dane wyjściowe. Więcej szczegółów grupy. To pole powinno być zwracane przez serwer tylko podczas zwracania grupy.

GroupDescription

Jeden przetłumaczony opis.

Zapis JSON
{
  "description": string,
  "locales": [
    string
  ]
}
Pola
description

string

Zlokalizowany opis tej grupy. Informacja ta może być wyświetlana użytkownikom, aby wyjaśnić, dlaczego otrzymali konkretną aktualizację.

locales[]

string

Regiony, w których ma się wyświetlać ten opis.

GroupDetails

Szczegóły grupy, w tym powiązane konfiguracje OTA. Wszystkie te informacje są tylko do odczytu.

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

string

Powiązane konfiguracje grupy.

members[]

object (GroupMember)

Członkowie tej grupy.

disabledConfigs[]

string

Powiązane wyłączone konfiguracje grupy.

versionTag

object (VersionTag)

Wersja grupy.

Metody

create

Tworzy grupę i zwraca nową wartość Group.

delete

Usuwa group.

disable

Wyłącza zdefiniowany element groups.

enable

Włącza zdefiniowane ustawienie groups.

get

Otrzymuje: group.

list

Wyświetla listę groups wdrożenia.

update

Aktualizuje: group.

updateConfigs

Aktualizuje config w kolumnie group.