Package google.cloud.resourcesettings.v1alpha1

Índice

Serviço de configurações de recursos

Uma interface para interagir com configurações de recursos e definir valores em toda a hierarquia de recursos.

Os serviços podem exibir várias configurações para que os usuários controlem o comportamento dos recursos. Os valores definidos em um determinado recurso do Cloud são avaliados de modo hierárquico e herdados por todos os descendentes desse recurso.

Para todas as solicitações, retorna um google.rpc.Status com google.rpc.Code.PERMISSION_DENIED se a verificação do IAM falhar ou se o recurso parent não estiver em uma organização do Cloud. Para todas as solicitações, um google.rpc.Status é retornado com google.rpc.Code.INVALID_ARGUMENT se a solicitação estiver incorreta.

Observação: a configuração não existe em todos os recursos das organizações em nuvem que não estão na versão Alfa.

Valor da criação

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

Cria um valor de configuração.

Retorna um google.rpc.Status com google.rpc.Code.NOT_FOUND se a configuração não existir. Retorna um google.rpc.Status com google.rpc.Code.ALREADY_EXISTS se o valor da configuração já existir no recurso do Cloud especificado. Retorna um google.rpc.Status com google.rpc.Code.FAILED_PRECONDITION se a configuração for sinalizada como somente leitura.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
Excluir configuração

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

Exclui um valor de configuração. Se o valor da configuração não existir, a operação será um ambiente autônomo.

Retorna um google.rpc.Status com google.rpc.Code.NOT_FOUND se a configuração ou o valor dela não existir. O valor da configuração não existirá se uma chamada anterior para DeleteSetting para o valor da configuração já tiver retornado um código de sucesso. Retorna um google.rpc.Status com google.rpc.Code.FAILED_PRECONDITION se a configuração for sinalizada como somente leitura.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
Valor de configuração

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

Recebe um valor de configuração.

Retorna um google.rpc.Status com google.rpc.Code.NOT_FOUND se o valor da configuração não existir.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
Configurações da lista

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
Valor Eficiente da Consulta

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

Calcula o valor efetivo de uma configuração no recurso do Cloud parent. O valor da configuração efetiva é o valor de configuração calculado em um recurso do Cloud e é avaliado como uma das seguintes opções na ordem especificada (a próxima opção será usada se a anterior não existir):

  1. o valor de configuração no recurso especificado
  2. o valor de configuração no ancestral mais próximo do recurso
  3. o valor padrão da configuração
  4. Um valor de configuração vazio, definido como SettingValue, com todos os campos não definidos

Retorna um google.rpc.Status com google.rpc.Code.NOT_FOUND se a configuração não existir.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
SearchSettingValues

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

Pesquisa todos os valores de configuração existentes no recurso parent. Os valores da configuração não são limitados aos valores de uma configuração específica.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
Valor de atualização da configuração

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

Atualiza um valor de configuração.

Retorna um google.rpc.Status com google.rpc.Code.NOT_FOUND se a configuração ou o valor dela não existir. Retorna um google.rpc.Status com google.rpc.Code.FAILED_PRECONDITION se a configuração for sinalizada como somente leitura. Retorna um google.rpc.Status com google.rpc.Code.ABORTED se a etag fornecida na solicitação não corresponder à etag persistente do valor da configuração.

Observação: o valor da configuração fornecido substituirá todos os campos.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.

CreateSettingValueRequest

A solicitação para CreateSettingValue.

Campos
setting_value

SettingValue

O valor da configuração a ser criado. Consulte SettingValue para ver os requisitos de campo.

A autorização requer a seguinte permissão do IAM no recurso especificado settingValue:

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

A solicitação de DeleteSettingValue.

Campos
name

string

O nome do valor da configuração a ser excluído. Consulte SettingValue para ver os requisitos de nomenclatura.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

Uma sinalização que permite a exclusão do valor de uma configuração read_only. AVISO: use por sua conta e risco. A exclusão do valor de uma configuração somente leitura é uma ação irreversível, ou seja, não é possível criá-la novamente.

GetSettingValueRequest

A solicitação para GetSettingValue.

Campos
name

string

O nome do valor da configuração a ser recebido. Consulte SettingValue para ver os requisitos de nomenclatura.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • resourcesettings.settingvalues.get

ListSettingsRequest

A solicitação para ListSettings.

Campos
parent

string

O recurso do Cloud responsável pela configuração. Precisa estar em um dos seguintes formatos:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • resourcesettings.settings.list
page_size

int32

Não utilizado. O tamanho da página a ser retornada.
page_token

string

Não utilizado. Um token de página usado para recuperar a próxima página.

ListSettingsResponse

A resposta de ListSettings.

Campos
settings[]

Setting

Uma lista de configurações disponíveis no recurso especificado do Cloud.
next_page_token

string

Não utilizado. Um token de página usado para recuperar a próxima página.

Solicitar efetivaçãoValorValor

A solicitação para LookupEffectiveSettingValue.

Campos
parent

string

A configuração em que um valor efetivo será avaliado. Consulte Setting para ver os requisitos de nomenclatura.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

A solicitação para SearchSettingValues.

Campos
parent

string

O recurso do Cloud responsável pela configuração. Precisa estar em um dos seguintes formatos:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • resourcesettings.settingvalues.list
page_size

int32

Não utilizado. O tamanho da página a ser retornada.
page_token

string

Não utilizado. Um token de página usado para recuperar a próxima página.

SearchSettingValuesResponse

A resposta de SearchSettingValues.

Campos
setting_values[]

SettingValue

Todos os valores de configuração que existem no recurso do Cloud especificado.
next_page_token

string

Não utilizado. Um token de página usado para recuperar a próxima página.

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.

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"
display_name

string

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

string

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

bool

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 DeleteSettingValue 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.
data_type

DataType

O tipo de dados dessa configuração.
default_value

Value

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

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

DataType

O tipo de dados para definir os valores dessa configuração. Consulte Value para ver mais detalhes sobre os tipos de dados disponíveis.

Enums
DATA_TYPE_UNSPECIFIED Tipo de dados não especificado.
BOOLEAN Uma configuração booleana.
STRING Uma configuração de string.
STRING_SET Uma configuração de conjunto de strings.

Valor da configuração

A instanciação de uma configuração. Cada valor de configuração é parental à configuração correspondente.

Campos
name

string

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

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

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

Value

O valor da configuração. O tipo de dado da Value precisa ser sempre consistente com o tipo definido pela configuração mãe.
etag

string

Impressão digital usada para simultaneidade otimista. Veja UpdateSettingValue para mais detalhes.
read_only

bool

Apenas saída. Uma sinalização indicando que esse valor de configuração não pode ser modificado. No entanto, ela pode ser excluída usando DeleteSettingValue se DeleteSettingValueRequest.ignore_read_only estiver definido como verdadeiro. O uso dessa sinalização é considerado uma confirmação de que o valor da configuração não pode ser recriado. Essa sinalização é herdada da configuração mãe e por conveniência. Consulte Setting.read_only para mais detalhes.
update_time

Timestamp

Apenas saída. O carimbo de data/hora que indica quando o valor da configuração foi atualizado pela última vez.

Atualização da solicitação de valor da solicitação

A solicitação de UpdateSettingValue.

Campos
setting_value

SettingValue

O valor da configuração a ser atualizado. Consulte SettingValue para ver os requisitos de campo.

A autorização requer a seguinte permissão do IAM no recurso especificado settingValue:

  • resourcesettings.settingvalues.update

Valor

Os dados em um valor de configuração.

Campos
Campo de união value. Seleciona o tipo de dados e o valor associado. value pode ser apenas de um dos tipos a seguir:
boolean_value

bool

Define esse valor como booleano.
string_value

string

Define esse valor como sendo um valor de string.
string_set_value

StringSet

Define esse valor como StringSet.

StringSet

Um valor de conjunto de strings que pode conter um conjunto de strings. O comprimento máximo de cada string é de 60 caracteres, podendo haver no máximo 50 strings no conjunto.

Campos
values[]

string

As strings no conjunto