Package google.cloud.resourcesettings.v1alpha1

Indeks

ResourceSettingsService

Interfejs do interakcji z ustawieniami zasobów i wartościami ustawień w całej hierarchii zasobów.

Usługi mogą udostępniać użytkownikom szereg ustawień, które pozwalają kontrolować działanie zasobów. Wartości ustawień zastosowane w danym zasobie Cloud są oceniane hierarchicznie i dziedziczone przez wszystkie elementy podrzędne tego zasobu.

W przypadku wszystkich żądań zwraca google.rpc.Status z google.rpc.Code.PERMISSION_DENIED, jeśli weryfikacja IAM się nie powiedzie lub zasób parent nie znajduje się w organizacji Cloud. W przypadku wszystkich żądań zwraca google.rpc.Status z google.rpc.Code.INVALID_ARGUMENT, jeśli żądanie jest nieprawidłowe.

Uwaga: w przypadku wszystkich ustawień w wersji alfa ustawienie nie występuje w żadnych zasobach w Cloud Organizations, 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 ustawienie nie istnieje. Zwraca wartość google.rpc.Status z wartością google.rpc.Code.ALREADY_EXISTS, jeśli wartość ustawienia istnieje już w danym zasobie w Google Cloud. Zwraca wartość google.rpc.Status z wartością 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)

Usuwa wartość ustawienia. Jeśli wartość ustawienia nie istnieje, operacja nie jest wykonywana.

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 dla wartości ustawienia zwróciło już kod powodzenia. Zwraca wartość google.rpc.Status z wartością 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.
ListSettings

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.
LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

Oblicza rzeczywistą wartość ustawienia w zasobie chmury parent. Obliczona wartość ustawienia w zasobie Cloud jest wartością obowiązującą i przyjmuje jedną z tych opcji w podanej kolejności (jeśli poprzednia opcja nie istnieje, używana jest następna):

  1. wartość ustawienia w przypadku danego zasobu.
  2. wartość ustawienia najbliższego przodka danego zasobu,
  3. wartość domyślna ustawienia,
  4. pusta wartość ustawienia, zdefiniowana jako SettingValue ze wszystkimi polami bez ustawionej wartości;

Zwraca wartość google.rpc.Status z wartością google.rpc.Code.NOT_FOUND, jeśli 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.
SearchSettingValues

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

Wyszukuje wszystkie wartości ustawień, które istnieją w zasobie parent. Wartości ustawień nie są ograniczone do wartości konkretnego ustawienia.

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 z wartością 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 ETag podany w żądaniu nie pasuje do zapisanego tagu ETag wartości ustawienia.

Uwaga: podana wartość ustawienia spowoduje 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.

CreateSettingValueRequest

Żądanie CreateSettingValue.

Pola
setting_value

SettingValue

Wartość ustawienia do utworzenia. Wymagania dotyczące pól znajdziesz w sekcji SettingValue.

Autoryzacja wymaga tych uprawnień IAM w określonym zasobie settingValue:

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

Żądanie DeleteSettingValue.

Pola
name

string

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

Autoryzacja wymaga tych uprawnień IAM w określonym zasobie name:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

Flaga, która umożliwia usunięcie wartości ustawienia read_only. OSTRZEŻENIE: używasz na własne ryzyko. Usunięcie wartości ustawienia tylko do odczytu jest nieodwracalne (nie można jej ponownie utworzyć).

GetSettingValueRequest

Żądanie GetSettingValue.

Pola
name

string

Nazwa wartości ustawienia do pobrania. Wymagania dotyczące nazewnictwa znajdziesz w sekcji SettingValue.

Autoryzacja wymaga tych uprawnień IAM w określonym zasobie name:

  • resourcesettings.settingvalues.get

ListSettingsRequest

Żądanie ListSettings.

Pola
parent

string

Zasób w chmurze, który jest elementem nadrzędnym ustawienia. Musi mieć jedną z tych form:

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

Autoryzacja wymaga tych uprawnień IAM w określonym zasobie 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.

ListSettingsResponse

Odpowiedź z ListSettings.

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.

LookupEffectiveSettingValueRequest

Prośba o wywołanie funkcji LookupEffectiveSettingValue.

Pola
parent

string

Ustawienie, dla którego zostanie obliczona efektywna wartość. Wymagania dotyczące nazewnictwa znajdziesz w sekcji Setting.

Autoryzacja wymaga tych uprawnień IAM w określonym zasobie parent:

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

Prośba o wartości SearchSettingValues.

Pola
parent

string

Zasób w chmurze, który jest elementem nadrzędnym ustawienia. Musi mieć jedną z tych form:

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

Autoryzacja wymaga tych uprawnień IAM w określonym zasobie 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ń, które istnieją w określonym zasobie w chmurze.
next_page_token

string

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

Ustawienie

Schemat ustawiania wartości. W przypadku danego zasobu w Google Cloud ustawienie może być nadrzędne w stosunku do maksymalnie 1 wartości ustawienia.

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

Zrozumiała 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 można modyfikować (informacje o aktualizacjach i przyczynach znajdziesz w dokumentacji konkretnego ustawienia). Można je jednak usunąć za pomocą DeleteSettingValue, jeśli DeleteSettingValueRequest.ignore_read_only ma wartość „true”. Użycie tej flagi oznacza potwierdzenie, że nie można odtworzyć wartości ustawienia. Więcej informacji znajdziesz w sekcji DeleteSettingValueRequest.ignore_read_only.
data_type

DataType

Typ danych tego ustawienia.
default_value

Value

Wartość otrzymywana przez LookupEffectiveSettingValue, jeśli nie ustawiono jawnie wartości ustawienia.

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

DataType

Typ danych do ustawiania wartości tego ustawienia. Więcej informacji o dostępnych typach danych znajdziesz w sekcji Value.

Wartości w polu enum
DATA_TYPE_UNSPECIFIED Nieokreślony typ danych.
BOOLEAN Ustawienie logiczne.
STRING Ustawienie ciągu tekstowego.
STRING_SET Ustawienie zestawu ciągów tekstowych.

SettingValue

Instancja ustawienia. Każda wartość ustawienia jest powiązana z odpowiednim ustawieniem.

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 być zawsze zgodny z typem danych zdefiniowanym przez ustawienie nadrzędne.
etag

string

Odcisk palca używany do optymistycznego współbieżności. Więcej informacji znajdziesz w sekcji UpdateSettingValue.
read_only

bool

Tylko dane wyjściowe. Flaga wskazująca, że tej wartości ustawienia nie można modyfikować. Można ją jednak usunąć za pomocą DeleteSettingValue, jeśli DeleteSettingValueRequest.ignore_read_only ma wartość „true”. Użycie tej flagi oznacza potwierdzenie, że nie można odtworzyć wartości ustawienia. Ta flaga jest dziedziczona z ustawienia nadrzędnego i służy do celów informacyjnych. Więcej informacji znajdziesz w sekcji Setting.read_only.
update_time

Timestamp

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

UpdateSettingValueRequest

Żądanie UpdateSettingValue.

Pola
setting_value

SettingValue

Wartość ustawienia do zaktualizowania. Wymagania dotyczące pól znajdziesz w sekcji SettingValue.

Autoryzacja wymaga tych uprawnień IAM w określonym zasobie settingValue:

  • resourcesettings.settingvalues.update

Wartość

Dane w wartości ustawienia.

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

bool

Określa, że ta wartość jest wartością logiczną.
string_value

string

Określa, że ta wartość jest wartością tekstową.
string_set_value

StringSet

Określa, że ta wartość jest zbiorem ciągów znaków.

StringSet

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

Pola
values[]

string

Ciągi w zbiorze