REST Resource: organizations.settings

Recurso: Parámetro de configuración

Es el esquema para establecer valores. En un recurso de Cloud determinado, un parámetro de configuración puede ser superior a un valor de configuración como máximo.

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

string

Es el nombre del recurso del parámetro de configuración. Debe tener una de las siguientes formas:

  • 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 de este parámetro de configuración.
description

string

Es una descripción detallada de lo que hace este parámetro de configuración.
readOnly

boolean

Es una marca que indica que los valores de este parámetro de configuración no se pueden modificar (consulta la documentación del parámetro de configuración específico para obtener actualizaciones y motivos). Sin embargo, se puede borrar con settings.deleteValue si DeleteSettingValueRequest.ignore_read_only se establece como verdadero. Usar esta marca se considera como una confirmación de que no se puede volver a crear el valor del parámetro de configuración. Consulta DeleteSettingValueRequest.ignore_read_only para obtener más información.
dataType

enum (DataType)

Es el tipo de datos de este parámetro de configuración.
defaultValue

object (Value)

Es 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 el valor de un parámetro de configuración.

getValue

 Obtiene el valor de un parámetro de configuración.

list

 Enumera todos los parámetros de configuración disponibles en el recurso de Cloud parent.

lookupEffectiveValue

 Calcula el valor de configuración efectivo de un parámetro de configuración en el recurso de Cloud parent.
Busca todos los valores de configuración que existen en el recurso parent.

updateValue

 Actualiza el valor de un parámetro de configuración.