REST Resource: organizations.settings

Recurso: configuração

O esquema para definir valores. Em um determinado recurso do Cloud, uma configuração pode criar no máximo um valor de configuração.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "readOnly": boolean,
  "dataType": enum (DataType),
  "defaultValue": {
    object (Value)
  }
}
Campos
name

string

O nome do recurso da configuração. Precisa estar em um dos seguintes formatos:

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

Por exemplo, "/projects/123/settings/gcp-enableMyFeature"
displayName

string

O nome legível dessa configuração.
description

string

Uma descrição detalhada do que essa configuração faz.
readOnly

boolean

Uma sinalização que indica que os valores dessa configuração não podem ser modificados (consulte a documentação da configuração específica para atualizações e motivos). No entanto, ela pode ser excluída usando settings.deleteValue se DeleteSettingValueRequest.ignore_read_only estiver definida como verdadeira. O uso dessa sinalização é considerado uma confirmação de que o valor da configuração não pode ser recriado. Consulte DeleteSettingValueRequest.ignore_read_only para mais detalhes.
dataType

enum (DataType)

O tipo de dados dessa configuração.
defaultValue

object (Value)

O valor recebido por settings.lookupEffectiveValue se nenhum valor de configuração for definido explicitamente.

Observação: nem todas as configurações têm um valor padrão.

Métodos

deleteValue

 Exclui um valor de configuração.

getValue

 Recebe um valor de configuração.

list

 Lista todas as configurações disponíveis no recurso do Cloud parent.

lookupEffectiveValue

 Calcula o valor efetivo de uma configuração no recurso do Cloud parent.
Pesquisa todos os valores de configuração existentes no recurso parent.

updateValue

 Atualiza um valor de configuração.