REST Resource: organizations.settings

Recurso: configuración

El esquema para establecer valores En un recurso de Cloud determinado, una configuración puede tener como máximo un valor de configuración.

Representación JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "readOnly": boolean,
  "dataType": enum (DataType),
  "defaultValue": {
    object (Value)
  }
}
Campos
name

string

El nombre del recurso de la configuración. Debe tener uno de los siguientes formatos:

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

Por ejemplo, "/projects/123/settings/gcp-enableMyFeature"

displayName

string

Es el nombre legible para esta configuración.

description

string

Una descripción detallada de lo que hace esta configuración.

readOnly

boolean

Una marca que indica que no se pueden modificar los valores de esta configuración (consulta la documentación de la configuración específica para conocer las actualizaciones y los motivos); sin embargo, se puede borrar con settings.deleteValue si se establece DeleteSettingValueRequest.ignore_read_only como verdadero El uso de esta marca se considera una confirmación de que el valor de configuración no se puede volver a crear. Consulta DeleteSettingValueRequest.ignore_read_only para obtener más información.

dataType

enum (DataType)

El tipo de datos para esta configuración.

defaultValue

object (Value)

El valor que recibe settings.lookupEffectiveValue si no se establece explícitamente ningún valor de configuración

Nota: No todos los parámetros de configuración tienen un valor predeterminado.

Métodos

deleteValue

Borra un valor de configuración.

getValue

Obtiene un valor de configuración.

list

Enumera todas las opciones de configuración que están disponibles en el recurso de Cloud parent.

lookupEffectiveValue

Calcula el valor de configuración efectivo de una configuración en el recurso de Cloud parent.
Busca todos los valores de configuración que existen en el recurso parent.

updateValue

Actualiza un valor de configuración.