Package google.cloud.resourcesettings.v1alpha1

Indice

ResourceSettingsService

Un'interfaccia per interagire con le impostazioni delle risorse e i valori delle impostazioni nell'intera gerarchia delle risorse.

I servizi possono mostrare una serie di impostazioni che consentono agli utenti di controllare il comportamento delle proprie risorse. I valori impostati applicati a una determinata risorsa cloud vengono valutati gerarchicamente ed ereditati da tutti i discendenti di quella risorsa.

Per tutte le richieste, restituisce un google.rpc.Status con google.rpc.Code.PERMISSION_DENIED se il controllo IAM non va a buon fine o se la risorsa parent non si trova in un'organizzazione Cloud. Per tutte le richieste, restituisce un google.rpc.Status con google.rpc.Code.INVALID_ARGUMENT se la richiesta non è valida.

Nota: per tutte le impostazioni in fase alpha, l'impostazione non esiste in nessuna risorsa di Cloud Organizations che non si trova nella versione alpha.

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

Crea un valore di impostazione.

Restituisce un google.rpc.Status con google.rpc.Code.NOT_FOUND se l'impostazione non esiste. Restituisce un google.rpc.Status con google.rpc.Code.ALREADY_EXISTS se il valore dell'impostazione esiste già nella risorsa cloud specificata. Restituisce un google.rpc.Status con google.rpc.Code.FAILED_PRECONDITION se l'impostazione è contrassegnata come di sola lettura.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica dell'autenticazione.
DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

Elimina un valore di impostazione. Se il valore dell'impostazione non esiste, l'operazione non viene eseguita.

Restituisce un google.rpc.Status con google.rpc.Code.NOT_FOUND se l'impostazione o il valore dell'impostazione non esiste. Il valore dell'impostazione non esisterà se una chiamata precedente a DeleteSetting per il valore dell'impostazione ha già restituito un codice di successo. Restituisce un google.rpc.Status con google.rpc.Code.FAILED_PRECONDITION se l'impostazione è contrassegnata come di sola lettura.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica dell'autenticazione.
GetSettingValue

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

Recupera un valore di impostazione.

Restituisce un google.rpc.Status con google.rpc.Code.NOT_FOUND se il valore dell'impostazione non esiste.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica dell'autenticazione.
ListSettings

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

Elenca tutte le impostazioni disponibili nella risorsa cloud parent.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica dell'autenticazione.
LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

Calcola il valore effettivo di un'impostazione nella risorsa cloud parent. Il valore dell'impostazione effettiva è il valore dell'impostazione calcolato in una risorsa cloud e corrisponde a una delle seguenti opzioni nell'ordine indicato (l'opzione successiva viene utilizzata se la precedente non esiste):

  1. il valore dell'impostazione sulla risorsa specificata
  2. il valore dell'impostazione nell'antenato più vicino della risorsa specificata
  3. il valore predefinito dell'impostazione
  4. un valore di impostazione vuoto, definito come un SettingValue con tutti i campi non impostati

Restituisce un google.rpc.Status con google.rpc.Code.NOT_FOUND se l'impostazione non esiste.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica dell'autenticazione.
SearchSettingValues

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

Cerca tutti i valori di impostazione esistenti nella risorsa parent. I valori dell'impostazione non sono limitati a quelli di una determinata impostazione.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica dell'autenticazione.
UpdateSettingValue

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

Aggiorna un valore di impostazione.

Restituisce un google.rpc.Status con google.rpc.Code.NOT_FOUND se l'impostazione o il valore dell'impostazione non esiste. Restituisce un google.rpc.Status con google.rpc.Code.FAILED_PRECONDITION se l'impostazione è contrassegnata come di sola lettura. Restituisce un google.rpc.Status con google.rpc.Code.ABORTED se l'etag fornito nella richiesta non corrisponde all'etag persistente del valore dell'impostazione.

Nota: il valore dell'impostazione fornito sovrascriverà completamente tutti i campi.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica dell'autenticazione.

CreateSettingValueRequest

La richiesta per CreateSettingValue.

Campi
setting_value

SettingValue

Il valore dell'impostazione da creare. Consulta SettingValue per i requisiti dei campi.

L'autorizzazione richiede la seguente autorizzazione IAM per la risorsa specificata settingValue:

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

La richiesta di DeleteSettingValue.

Campi
name

string

Il nome del valore dell'impostazione da eliminare. Consulta SettingValue per i requisiti di denominazione.

L'autorizzazione richiede la seguente autorizzazione IAM per la risorsa specificata name:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

Un flag che consente l'eliminazione del valore di un'impostazione read_only. AVVISO: l'utilizzo è a tuo rischio. L'eliminazione del valore di un'impostazione di sola lettura è un'azione irreversibile (ovvero non può essere creata di nuovo).

GetSettingValueRequest

La richiesta di GetSettingValue.

Campi
name

string

Il nome del valore dell'impostazione da ottenere. Consulta SettingValue per i requisiti di denominazione.

L'autorizzazione richiede la seguente autorizzazione IAM per la risorsa specificata name:

  • resourcesettings.settingvalues.get

ListSettingsRequest

La richiesta di ListSettings.

Campi
parent

string

La risorsa cloud che contiene l'impostazione. Deve essere in uno dei seguenti formati:

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

L'autorizzazione richiede la seguente autorizzazione IAM per la risorsa specificata parent:

  • resourcesettings.settings.list
page_size

int32

Non utilizzata. Le dimensioni della pagina da restituire.
page_token

string

Non utilizzata. Un token di pagina utilizzato per recuperare la pagina successiva.

ListSettingsResponse

La risposta di ListSettings.

Campi
settings[]

Setting

Un elenco delle impostazioni disponibili nella risorsa cloud specificata.
next_page_token

string

Non utilizzata. Un token di pagina utilizzato per recuperare la pagina successiva.

LookupEffectiveSettingValueRequest

La richiesta di LookupEffectiveSettingValue.

Campi
parent

string

L'impostazione per cui verrà valutato un valore effettivo. Consulta Setting per i requisiti di denominazione.

L'autorizzazione richiede la seguente autorizzazione IAM per la risorsa specificata parent:

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

La richiesta di SearchSettingValues.

Campi
parent

string

La risorsa cloud che contiene l'impostazione. Deve essere in uno dei seguenti formati:

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

L'autorizzazione richiede la seguente autorizzazione IAM per la risorsa specificata parent:

  • resourcesettings.settingvalues.list
page_size

int32

Non utilizzata. Le dimensioni della pagina da restituire.
page_token

string

Non utilizzata. Un token di pagina utilizzato per recuperare la pagina successiva.

SearchSettingValuesResponse

La risposta di SearchSettingValues.

Campi
setting_values[]

SettingValue

Tutti i valori delle impostazioni esistenti nella risorsa cloud specificata.
next_page_token

string

Non utilizzata. Un token di pagina utilizzato per recuperare la pagina successiva.

Impostazione

Lo schema per l'impostazione dei valori. In una determinata risorsa cloud, un'impostazione può essere padre di al massimo un valore di impostazione.

Campi
name

string

Il nome della risorsa dell'impostazione. Deve essere in uno dei seguenti formati:

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

Ad esempio, "/projects/123/settings/gcp-enableMyFeature"
display_name

string

Il nome leggibile di questa impostazione.
description

string

Una descrizione dettagliata della funzione di questa impostazione.
read_only

bool

Un flag che indica che i valori di questa impostazione non possono essere modificati (consulta la documentazione dell'impostazione specifica per aggiornamenti e motivi); tuttavia, può essere eliminato utilizzando DeleteSettingValue se DeleteSettingValueRequest.ignore_read_only è impostato su true. L'utilizzo di questo flag è considerato una conferma che il valore dell'impostazione non può essere ricreato. Per maggiori dettagli, consulta DeleteSettingValueRequest.ignore_read_only.
data_type

DataType

Il tipo di dati per questa impostazione.
default_value

Value

Il valore ricevuto da LookupEffectiveSettingValue se non è impostato esplicitamente alcun valore di impostazione.

Nota: non tutte le impostazioni hanno un valore predefinito.

DataType

Il tipo di dati per l'impostazione dei valori di questa impostazione. Per maggiori dettagli sui tipi di dati disponibili, consulta Value.

Enum
DATA_TYPE_UNSPECIFIED Tipo di dati non specificato.
BOOLEAN Un'impostazione booleana.
STRING Un'impostazione stringa.
STRING_SET Un'impostazione del set di stringhe.

SettingValue

L'istanza di un'impostazione. Ogni valore di impostazione è associato all'impostazione corrispondente.

Campi
name

string

Il nome della risorsa del valore dell'impostazione. Deve essere in uno dei seguenti formati:

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

Ad esempio, "/projects/123/settings/gcp-enableMyFeature/value"
value

Value

Il valore dell'impostazione. Il tipo di dati di Value deve essere sempre coerente con il tipo di dati definito dall'impostazione principale.
etag

string

Un'impronta utilizzata per la concorrenza ottimistica. Per maggiori dettagli, consulta UpdateSettingValue.
read_only

bool

Solo output. Un flag che indica che questo valore di impostazione non può essere modificato; tuttavia, può essere eliminato utilizzando DeleteSettingValue se DeleteSettingValueRequest.ignore_read_only è impostato su true. L'utilizzo di questo flag è considerato una conferma che il valore dell'impostazione non può essere ricreato. Questo flag viene ereditato dall'impostazione principale ed è a scopo pratico. Per maggiori dettagli, consulta Setting.read_only.
update_time

Timestamp

Solo output. Il timestamp che indica l'ultimo aggiornamento del valore dell'impostazione.

UpdateSettingValueRequest

La richiesta di UpdateSettingValue.

Campi
setting_value

SettingValue

Il valore dell'impostazione da aggiornare. Consulta SettingValue per i requisiti dei campi.

L'autorizzazione richiede la seguente autorizzazione IAM per la risorsa specificata settingValue:

  • resourcesettings.settingvalues.update

Valore

I dati in un valore di impostazione.

Campi
Campo unione value. Seleziona il tipo di dati e il valore associato. value può essere solo uno dei seguenti:
boolean_value

bool

Definisce questo valore come booleano.
string_value

string

Definisce questo valore come valore stringa.
string_set_value

StringSet

Definisce questo valore come StringSet.

StringSet

Un valore di insieme di stringhe che può contenere un insieme di stringhe. La lunghezza massima di ogni stringa è di 60 caratteri e un insieme di stringhe può contenere al massimo 50 stringhe.

Campi
values[]

string

Le stringhe nel set