Package google.cloud.resourcesettings.v1alpha1

Indeks

Usługa zasobów

Interfejs umożliwiający interakcję z ustawieniami zasobów i ustawianiem ich wartości w hierarchii zasobów.

Usługi mogą udostępniać użytkownikom szereg ustawień pozwalających kontrolować ich zasoby. Wartości ustawień zastosowane do danego zasobu Cloud są oceniane hierarchicznie i dziedziczone przez wszystkie elementy podrzędne tego zasobu.

W przypadku wszystkich żądań zwraca google.rpc.Status z wartością google.rpc.Code.PERMISSION_DENIED, jeśli nie udało się sprawdzić uprawnień lub zasób parent nie znajduje się w organizacji Cloud. W przypadku wszystkich żądań zwraca wartość google.rpc.Status z wartością google.rpc.Code.INVALID_ARGUMENT, jeśli żądanie jest nieprawidłowo sformułowane.

Uwaga: w przypadku wszystkich ustawień etapu alfa ustawienie nie istnieje w żadnych zasobach organizacji Cloud, które nie są w wersji alfa.

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

Tworzy wartość ustawienia.

Zwraca wartość google.rpc.Status z wartością google.rpc.Code.NOT_FOUND, jeśli to ustawienie nie istnieje. Zwraca google.rpc.Status z wartością google.rpc.Code.ALREADY_EXISTS, jeśli wartość ustawienia już istnieje w danym zasobie Cloud. Zwraca wartość google.rpc.Status zawierającą google.rpc.Code.FAILED_PRECONDITION, jeśli ustawienie jest oznaczone jako tylko do odczytu.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w Omówieniu uwierzytelniania.
DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

Usunięcie wartości ustawienia. Jeśli wartość ustawienia nie istnieje, operacja jest operacją bez operacji.

Zwraca wartość google.rpc.Status z wartością google.rpc.Code.NOT_FOUND, jeśli ustawienie lub jego wartość nie istnieje. Wartość ustawienia nie będzie istnieć, jeśli poprzednie wywołanie DeleteSetting zwróciło wartość kodu stanu. Zwraca wartość google.rpc.Status zawierającą google.rpc.Code.FAILED_PRECONDITION, jeśli ustawienie jest oznaczone jako tylko do odczytu.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w Omówieniu uwierzytelniania.
GetSettingValue

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

Pobiera wartość ustawienia.

Zwraca wartość google.rpc.Status z wartością google.rpc.Code.NOT_FOUND, jeśli wartość ustawienia nie istnieje.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w Omówieniu uwierzytelniania.
Ustawienia listy

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

Wyświetla wszystkie ustawienia dostępne w zasobie Cloud parent.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w Omówieniu uwierzytelniania.
Wyszukaj efektową wartość

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

Oblicza wartość efektywnego ustawienia ustawienia w zasobie Cloud parent. Wartość efektywna ustawienia to obliczona wartość ustawienia zasobu Cloud i wybierana jest jedna z tych opcji w określonej kolejności (następna opcja jest używana, jeśli poprzednia nie istnieje):

  1. wartość ustawienia dla danego zasobu,
  2. wartość ustawienia na najbliższym elemencie nadrzędnym danego zasobu
  3. wartością domyślną ustawienia;
  4. Pusta wartość ustawienia zdefiniowana jako SettingValue z nieznanymi polami

Zwraca wartość google.rpc.Status z wartością google.rpc.Code.NOT_FOUND, jeśli to ustawienie nie istnieje.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w Omówieniu uwierzytelniania.
Wartość ustawienia wyszukiwania

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

Wyszukuje wszystkie wartości ustawień istniejące w zasobie parent. Wartości ustawienia nie są ograniczone do wartości określonych ustawień.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w Omówieniu uwierzytelniania.
UpdateSettingValue

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

Aktualizuje wartość ustawienia.

Zwraca wartość google.rpc.Status z wartością google.rpc.Code.NOT_FOUND, jeśli ustawienie lub jego wartość nie istnieje. Zwraca wartość google.rpc.Status zawierającą google.rpc.Code.FAILED_PRECONDITION, jeśli ustawienie jest oznaczone jako tylko do odczytu. Zwraca wartość google.rpc.Status z wartością google.rpc.Code.ABORTED, jeśli tag podany w żądaniu nie pasuje do stałego tagu wartości ustawienia.

Uwaga: podana wartość ustawienia powoduje pełne zastąpienie wszystkich pól.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w Omówieniu uwierzytelniania.

CreateCreateValueRequest

Żądanie CreateSettingValue.

Pola
setting_value

SettingValue

Wartość ustawienia, które zostanie utworzone. Wymagania dotyczące pól znajdziesz w sekcji SettingValue.

Autoryzacja wymaga tego uprawnienia Uprawnienia w odniesieniu do określonego zasobu settingValue:

  • resourcesettings.settingvalues.create

Element RequestSettingValue

Żądanie DeleteSettingValue.

Pola
name

string

Nazwa wartości ustawienia do usunięcia. Wymagania dotyczące nazewnictwa znajdziesz w SettingValue.

Autoryzacja wymaga tego uprawnienia Uprawnienia w odniesieniu do określonego zasobu name:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

Flaga, która umożliwia usunięcie wartości ustawienia read_only. OSTRZEŻENIE: korzystaj na własne ryzyko. Usunięcie wartości ustawienia „tylko do odczytu” jest nieodwracalne. Oznacza to, że nie można go ponownie utworzyć.

Żądanie GetSettingValue

Żądanie GetSettingValue.

Pola
name

string

Nazwa wartości ustawienia, która ma zostać pobrana. Wymagania dotyczące nazewnictwa znajdziesz w SettingValue.

Autoryzacja wymaga tego uprawnienia Uprawnienia w odniesieniu do określonego zasobu name:

  • resourcesettings.settingvalues.get

Prośba o ustawienia listy

Żądanie dotyczące ListList.

Pola
parent

string

Zasób Cloud nadrzędny dla ustawienia. Musi mieć jedną z tych form:

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

Autoryzacja wymaga tego uprawnienia Uprawnienia w odniesieniu do określonego zasobu parent:

  • resourcesettings.settings.list
page_size

int32

Nieużywane. Rozmiar strony do zwrócenia.
page_token

string

Nieużywane. Token strony używany do pobierania następnej strony.

Odpowiedź dotycząca ustawień listy

Odpowiedź z ListList.

Pola
settings[]

Setting

Lista ustawień dostępnych w określonym zasobie Cloud.
next_page_token

string

Nieużywane. Token strony używany do pobierania następnej strony.

LookUpefektywne ustawienie wartości

Żądanie LookupeffectiveSettingValue.

Pola
parent

string

Ustawienie, którego wartość będzie oceniana. Wymagania dotyczące nazewnictwa znajdziesz w Setting.

Autoryzacja wymaga tego uprawnienia Uprawnienia w odniesieniu do określonego zasobu parent:

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

Żądanie SearchSettingValues.

Pola
parent

string

Zasób Cloud nadrzędny dla ustawienia. Musi mieć jedną z tych form:

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

Autoryzacja wymaga tego uprawnienia Uprawnienia w odniesieniu do określonego zasobu parent:

  • resourcesettings.settingvalues.list
page_size

int32

Nieużywane. Rozmiar strony do zwrócenia.
page_token

string

Nieużywane. Token strony używany do pobierania następnej strony.

SearchSettingValuesResponse

Odpowiedź z SearchSettingValues.

Pola
setting_values[]

SettingValue

Wszystkie wartości ustawień istniejące w podanym zasobie Cloud.
next_page_token

string

Nieużywane. Token strony używany do pobierania następnej strony.

Ustawienie

Schemat ustawień wartości. Ustawienie w danym zasobie Cloud może być nadrzędnym elementem nadrzędnym maksymalnie 1 wartością.

Pola
name

string

Nazwa zasobu ustawienia. Musi mieć jedną z tych form:

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

Na przykład „/projects/123/settings/gcp-enableMyFeature”
display_name

string

Czytelna dla człowieka nazwa tego ustawienia.
description

string

Szczegółowy opis działania tego ustawienia.
read_only

bool

Flaga wskazująca, że wartości tego ustawienia nie mogą być modyfikowane (informacje o aktualizacjach i przyczynach znajdziesz w dokumentacji danego ustawienia). Jeśli ustawienie DeleteSettingValueRequest.ignore_read_only ma wartość Prawda, może zostać usunięte, używając zasady DeleteSettingValue. Zastosowanie tej flagi jest równoznaczne z potwierdzeniem, że wartości ustawienia nie można odtworzyć. Więcej informacji: DeleteSettingValueRequest.ignore_read_only.
data_type

DataType

Typ danych dla tego ustawienia.
default_value

Value

Wartość otrzymana przez LookupEffectiveSettingValue, jeśli nie jest określona żadna wartość ustawienia.

Uwaga: nie wszystkie ustawienia mają wartość domyślną.

Typ danych

Typ danych używany do ustawiania wartości tego ustawienia. Więcej informacji na temat dostępnych typów danych znajdziesz na stronie Value.

Wartości w polu enum
DATA_TYPE_UNSPECIFIED Nieokreślony typ danych.
BOOLEAN Wartość logiczna.
STRING Ustawienie ciągu znaków.
STRING_SET Ustawienie ciągu znaków.

Wartość ustawienia

Wystąpienie ustawienia. Nadrzędna wartość ustawienia jest określana przez odpowiednie ustawienie.

Pola
name

string

Nazwa zasobu wartości ustawienia. Musi mieć jedną z tych form:

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

Na przykład „/projects/123/settings/gcp-enableMyFeature/value”
value

Value

Wartość ustawienia. Typ danych Value musi zawsze być zgodny z typem określonym przez ustawienie nadrzędne.
etag

string

Odcisk palca używany do optymistycznej równoczesności. Więcej informacji: UpdateSettingValue.
read_only

bool

Tylko dane wyjściowe. Flaga wskazująca, że nie można zmienić tej wartości. Wartość może jednak zostać usunięta za pomocą zasady DeleteSettingValue, jeśli zasada DeleteSettingValueRequest.ignore_read_only ma wartość Prawda. Zastosowanie tej flagi jest równoznaczne z potwierdzeniem, że wartości ustawienia nie można odtworzyć. Ta flaga jest dziedziczona z ustawienia nadrzędnej i została określona dla wygody użytkowników. Więcej informacji: Setting.read_only.
update_time

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa wskazująca, kiedy wartość ustawienia została ostatnio zaktualizowana.

UpdateRequestValueRequest

Żądanie UpdateSettingValue.

Pola
setting_value

SettingValue

Wartość ustawienia, które chcesz zaktualizować. Wymagania dotyczące pól znajdziesz w sekcji SettingValue.

Autoryzacja wymaga tego uprawnienia Uprawnienia w odniesieniu do określonego zasobu settingValue:

  • resourcesettings.settingvalues.update

Wartość

Dane w wartości ustawienia.

Pola
Pole sumy: value. Wybiera typ danych i powiązaną wartość. value może mieć tylko jedną z tych wartości:
boolean_value

bool

Określa tę wartość jako wartość logiczną.
string_value

string

Określa tę wartość jako wartość ciągu znaków.
string_set_value

StringSet

Określa tę wartość jako ciąg znaków.

Zestaw ciągów znaków

Wartość zestawu ciągów, która może zawierać zbiór ciągów znaków. Maksymalna długość każdego ciągu to 60 znaków, a zestaw znaków może mieć maksymalnie 50.

Pola
values[]

string

Ciągi w zestawie