Package google.cloud.resourcesettings.v1alpha1

Index

ResourceSettingsService

Interface permettant d'interagir avec les paramètres et les valeurs de paramètres des ressources dans toute la hiérarchie des ressources.

Les services peuvent afficher un certain nombre de paramètres permettant aux utilisateurs de contrôler le comportement de leurs ressources. Les valeurs de paramètre appliquées à une ressource Cloud donnée sont évaluées de manière hiérarchique et héritées par tous les descendants de cette ressource.

Pour toutes les requêtes, renvoie un google.rpc.Status avec google.rpc.Code.PERMISSION_DENIED si la vérification IAM échoue ou si la ressource parent ne se trouve pas dans une organisation Cloud. Pour toutes les requêtes, renvoie un google.rpc.Status avec google.rpc.Code.INVALID_ARGUMENT si la requête est mal formée.

Remarque : Pour tous les paramètres en phase alpha, le paramètre n'existe sous aucune ressource dans les organisations Cloud qui ne sont pas en phase alpha.

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

Crée une valeur de paramètre.

Renvoie un google.rpc.Status avec google.rpc.Code.NOT_FOUND si le paramètre n'existe pas. Renvoie un google.rpc.Status avec google.rpc.Code.ALREADY_EXISTS si la valeur du paramètre existe déjà sur la ressource Cloud donnée. Renvoie un google.rpc.Status avec google.rpc.Code.FAILED_PRECONDITION si le paramètre est marqué comme étant en lecture seule.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.
DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

Supprime une valeur de paramètre. Si la valeur du paramètre n'existe pas, l'opération n'a aucun effet.

Renvoie un google.rpc.Status avec google.rpc.Code.NOT_FOUND si le paramètre ou sa valeur n'existent pas. La valeur du paramètre n'existe pas si un appel précédent à DeleteSetting pour la valeur du paramètre a déjà renvoyé un code de réussite. Renvoie un google.rpc.Status avec google.rpc.Code.FAILED_PRECONDITION si le paramètre est marqué comme étant en lecture seule.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.
GetSettingValue

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

Récupère la valeur d'un paramètre.

Renvoie un google.rpc.Status avec google.rpc.Code.NOT_FOUND si la valeur du paramètre n'existe pas.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.
ListSettings

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

Répertorie tous les paramètres disponibles sur la ressource cloud parent.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.
LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

Calcule la valeur de paramètre effective d'un paramètre au niveau de la ressource Cloud parent. La valeur effective d'un paramètre correspond à la valeur calculée d'un paramètre au niveau d'une ressource Cloud. Elle correspond à l'une des options suivantes, dans l'ordre indiqué (l'option suivante est utilisée si la précédente n'existe pas) :

  1. la valeur du paramètre sur la ressource donnée.
  2. la valeur du paramètre sur l'ancêtre le plus proche de la ressource donnée.
  3. la valeur par défaut du paramètre.
  4. une valeur de paramètre vide, définie comme un SettingValue avec tous les champs non définis.

Renvoie un google.rpc.Status avec google.rpc.Code.NOT_FOUND si le paramètre n'existe pas.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.
SearchSettingValues

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

Recherche toutes les valeurs de paramètre qui existent sur la ressource parent. Les valeurs des paramètres ne sont pas limitées à celles d'un paramètre particulier.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.
UpdateSettingValue

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

Met à jour la valeur d'un paramètre.

Renvoie un google.rpc.Status avec google.rpc.Code.NOT_FOUND si le paramètre ou sa valeur n'existent pas. Renvoie un google.rpc.Status avec google.rpc.Code.FAILED_PRECONDITION si le paramètre est marqué comme étant en lecture seule. Renvoie un google.rpc.Status avec google.rpc.Code.ABORTED si l'ETag fourni dans la requête ne correspond pas à l'ETag persistant de la valeur du paramètre.

Remarque : La valeur du paramètre fournie écrasera complètement tous les champs.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.

CreateSettingValueRequest

Requête pour CreateSettingValue.

Champs
setting_value

SettingValue

Valeur du paramètre à créer. Pour connaître les exigences concernant les champs, consultez SettingValue.

L'autorisation IAM suivante est requise pour la ressource settingValue indiquée :

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

Requête pour DeleteSettingValue.

Champs
name

string

Nom de la valeur de paramètre à supprimer. Pour connaître les règles de dénomination, consultez SettingValue.

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

Indicateur qui permet de supprimer la valeur d'un paramètre read_only. AVERTISSEMENT : Utilisez cette fonctionnalité à vos propres risques. La suppression de la valeur d'un paramètre en lecture seule est une action irréversible (c'est-à-dire qu'elle ne peut pas être recréée).

GetSettingValueRequest

Requête pour GetSettingValue.

Champs
name

string

Nom de la valeur du paramètre à obtenir. Pour connaître les règles de dénomination, consultez SettingValue.

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • resourcesettings.settingvalues.get

ListSettingsRequest

Requête pour ListSettings.

Champs
parent

string

Ressource cloud qui est le parent du paramètre. Doit être l'une des formes suivantes :

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

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • resourcesettings.settings.list
page_size

int32

Non utilisé. Taille de la page à renvoyer.
page_token

string

Non utilisé. Jeton de page utilisé pour récupérer la page suivante.

ListSettingsResponse

Réponse de ListSettings.

Champs
settings[]

Setting

Liste des paramètres disponibles pour la ressource Cloud spécifiée.
next_page_token

string

Non utilisé. Jeton de page utilisé pour récupérer la page suivante.

LookupEffectiveSettingValueRequest

Requête pour LookupEffectiveSettingValue.

Champs
parent

string

Paramètre pour lequel une valeur effective sera évaluée. Pour connaître les règles de dénomination, consultez Setting.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

Requête pour SearchSettingValues.

Champs
parent

string

Ressource cloud qui est le parent du paramètre. Doit être l'une des formes suivantes :

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

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • resourcesettings.settingvalues.list
page_size

int32

Non utilisé. Taille de la page à renvoyer.
page_token

string

Non utilisé. Jeton de page utilisé pour récupérer la page suivante.

SearchSettingValuesResponse

Réponse de SearchSettingValues.

Champs
setting_values[]

SettingValue

Toutes les valeurs de paramètre qui existent sur la ressource Cloud spécifiée.
next_page_token

string

Non utilisé. Jeton de page utilisé pour récupérer la page suivante.

Paramètre

Schéma pour définir les valeurs. Pour une ressource Cloud donnée, un paramètre ne peut être parent que d'une seule valeur de paramètre.

Champs
name

string

Nom de ressource du paramètre. Doit être l'une des formes suivantes :

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

Par exemple, "/projects/123/settings/gcp-enableMyFeature"
display_name

string

Nom lisible de ce paramètre.
description

string

Description détaillée de l'effet de ce paramètre.
read_only

bool

Indicateur indiquant que les valeurs de ce paramètre ne peuvent pas être modifiées (consultez la documentation du paramètre spécifique pour obtenir des informations et des raisons) ; toutefois, il peut être supprimé à l'aide de DeleteSettingValue si DeleteSettingValueRequest.ignore_read_only est défini sur "true". L'utilisation de cet indicateur est considérée comme une confirmation que la valeur du paramètre ne peut pas être recréée. Pour en savoir plus, consultez DeleteSettingValueRequest.ignore_read_only.
data_type

DataType

Type de données de ce paramètre.
default_value

Value

Valeur reçue par LookupEffectiveSettingValue si aucune valeur de paramètre n'est explicitement définie.

Remarque : Tous les paramètres n'ont pas de valeur par défaut.

DataType

Type de données pour définir les valeurs de ce paramètre. Pour en savoir plus sur les types de données disponibles, consultez Value.

Enums
DATA_TYPE_UNSPECIFIED Type de données non spécifié.
BOOLEAN Paramètre booléen.
STRING Paramètre de chaîne.
STRING_SET Paramètre de chaîne.

SettingValue

Instanciation d'un paramètre. Chaque valeur de paramètre est associée au paramètre correspondant.

Champs
name

string

Nom de ressource de la valeur du paramètre. Doit être l'une des formes suivantes :

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

Par exemple, "/projects/123/settings/gcp-enableMyFeature/value"
value

Value

Valeur du paramètre. Le type de données de Value doit toujours être cohérent avec celui défini par le paramètre parent.
etag

string

Empreinte digitale utilisée pour la simultanéité optimiste. Pour en savoir plus, consultez UpdateSettingValue.
read_only

bool

Uniquement en sortie. Indicateur indiquant que la valeur de ce paramètre ne peut pas être modifiée. Toutefois, elle peut être supprimée à l'aide de DeleteSettingValue si DeleteSettingValueRequest.ignore_read_only est défini sur "true". L'utilisation de cet indicateur est considérée comme une confirmation que la valeur du paramètre ne peut pas être recréée. Cette option est héritée de son paramètre parent et est fournie à des fins pratiques. Pour en savoir plus, consultez Setting.read_only.
update_time

Timestamp

Uniquement en sortie. Code temporel indiquant la dernière mise à jour de la valeur du paramètre.

UpdateSettingValueRequest

Requête pour UpdateSettingValue.

Champs
setting_value

SettingValue

Valeur du paramètre à modifier. Pour connaître les exigences concernant les champs, consultez SettingValue.

L'autorisation IAM suivante est requise pour la ressource settingValue indiquée :

  • resourcesettings.settingvalues.update

Valeur

Données d'une valeur de paramètre.

Champs
Champ d'union value. Sélectionne le type de données et la valeur associée. value ne peut être qu'un des éléments suivants :
boolean_value

bool

Définit cette valeur comme étant une valeur booléenne.
string_value

string

Définit cette valeur comme étant une valeur de chaîne.
string_set_value

StringSet

Définit cette valeur comme étant un StringSet.

StringSet

Valeur d'ensemble de chaînes pouvant contenir un ensemble de chaînes. La longueur maximale de chaque chaîne est de 60 caractères, et l'ensemble de chaînes peut contenir jusqu'à 50 chaînes.

Champs
values[]

string

Chaînes de l'ensemble