REST Resource: organizations.settings

Ressource : Setting

Schéma pour définir les valeurs. Pour une ressource Cloud donnée, un paramètre ne peut être parent que d'une seule valeur de paramètre.

Représentation JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "readOnly": boolean,
  "dataType": enum (DataType),
  "defaultValue": {
    object (Value)
  }
}
Champs
name

string

Nom de ressource du paramètre. Doit être l'une des formes suivantes :

  • projects/{project_number}/settings/{setting_name}
  • folders/{folder_id}/settings/{setting_name}
  • organizations/{organization_id}/settings/{setting_name}

Par exemple, "/projects/123/settings/gcp-enableMyFeature"

displayName

string

Nom lisible de ce paramètre.

description

string

Description détaillée de l'effet de ce paramètre.

readOnly

boolean

Indicateur indiquant que les valeurs de ce paramètre ne peuvent pas être modifiées (consultez la documentation du paramètre spécifique pour obtenir des informations et des raisons) ; toutefois, il peut être supprimé à l'aide de settings.deleteValue si DeleteSettingValueRequest.ignore_read_only est défini sur "true". L'utilisation de cet indicateur est considérée comme une confirmation que la valeur du paramètre ne peut pas être recréée. Pour en savoir plus, consultez DeleteSettingValueRequest.ignore_read_only.

dataType

enum (DataType)

Type de données de ce paramètre.

defaultValue

object (Value)

Valeur reçue par settings.lookupEffectiveValue si aucune valeur de paramètre n'est explicitement définie.

Remarque : Tous les paramètres n'ont pas de valeur par défaut.

Méthodes

deleteValue

Supprime une valeur de paramètre.

getValue

Récupère la valeur d'un paramètre.

list

Répertorie tous les paramètres disponibles sur la ressource cloud parent.

lookupEffectiveValue

Calcule la valeur de paramètre effective d'un paramètre au niveau de la ressource Cloud parent.
Recherche toutes les valeurs de paramètre qui existent sur la ressource parent.

updateValue

Met à jour la valeur d'un paramètre.