Package google.cloud.resourcesettings.v1alpha1

Index

Service des paramètres de ressource

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

Les services peuvent proposer différents paramètres permettant aux utilisateurs de contrôler le comportement de leurs ressources. Les valeurs de paramètres 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 n'appartient pas à une organisation Cloud. Pour toutes les requêtes, renvoie un google.rpc.Status avec google.rpc.Code.INVALID_ARGUMENT si la requête est incorrecte.

Remarque: Pour tous les paramètres de l'étape alpha, le paramètre n'existe pour aucune ressource d'organisations Cloud qui ne sont pas en version alpha.

Valeur CreateSetting

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 une valeur 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 signalé 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 est no-op.

Renvoie un google.rpc.Status avec google.rpc.Code.NOT_FOUND si le paramètre ou la valeur du paramètre n'existe 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 signalé 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.
Valeur GetSetting

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

Récupère une valeur de 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.
Paramètres de liste

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.
Valeur de LookupEffectiveSetting

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

Calcule la valeur effective d'un paramètre sur la ressource cloud parent. La valeur effective du paramètre correspond à celle calculée pour une ressource Cloud et 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. Valeur du paramètre sur la ressource donnée
  2. 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 en tant que 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.
Valeurs 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 se limitent pas à 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.
Valeur du paramètre UpdateUpdate

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

Met à jour une valeur de paramètre.

Renvoie un google.rpc.Status avec google.rpc.Code.NOT_FOUND si le paramètre ou la valeur du paramètre n'existe pas. Renvoie un google.rpc.Status avec google.rpc.Code.FAILED_PRECONDITION si le paramètre est signalé 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 de paramètre fournie écrasera 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. Consultez SettingValue pour connaître les champs obligatoires.

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

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

Requête de 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

Une option permettant de supprimer la valeur d'un paramètre read_only. AVERTISSEMENT: Vous les utilisez à vos propres risques. La suppression d'un paramètre en lecture seule est irréversible (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 ListSettings.

Champs
parent

string

Ressource Cloud qui parent le paramètre. Doit se présenter sous 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 SearchSettingValues.

Champs
parent

string

Ressource Cloud qui parent le paramètre. Doit se présenter sous 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 des paramètres 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 de définition des valeurs. Pour une ressource Cloud donnée, un paramètre ne peut être associé qu'à une seule valeur de paramètre.

Champs
name

string

Nom de ressource du paramètre. Doit se présenter sous 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'utilité de ce paramètre.
read_only

bool

Un indicateur indiquant que les valeurs de ce paramètre ne peuvent pas être modifiées (voir la documentation du paramètre spécifique pour les mises à jour et les motifs). Cependant, il peut être supprimé à l'aide de DeleteSettingValue si DeleteSettingValueRequest.ignore_read_only est défini sur "true". L'utilisation de cette option est considérée comme un accusé de réception indiquant 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 une valeur par défaut.

DataType

Type de données pour 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 jeu de chaînes.

Valeur du paramètre

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

Champs
name

string

Nom de ressource de la valeur du paramètre. Doit se présenter sous 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

Exemple : "/projects/123/settings/gcp-enableMyFeature/value"
value

Value

Valeur du paramètre. Le type de données de Value doit toujours correspondre au type de données défini par le paramètre parent.
etag

string

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

bool

Uniquement en sortie. Un 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 la valeur de DeleteSettingValueRequest.ignore_read_only est "true". L'utilisation de cette option est considérée comme un accusé de réception indiquant que la valeur du paramètre ne peut pas être recréée. Cette option est héritée du paramètre parent. Elle est fournie à titre indicatif. Pour en savoir plus, consultez Setting.read_only.
update_time

Timestamp

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

UpdateSettingValueRequest

Requête de UpdateSettingValue.

Champs
setting_value

SettingValue

Valeur du paramètre à mettre à jour. Consultez SettingValue pour connaître les champs obligatoires.

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

  • resourcesettings.settingvalues.update

Valeur

Données contenues dans 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 booléenne.
string_value

string

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

StringSet

Définit cette valeur comme un StringSet.

StringSet

Valeur d'un 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 50 chaînes au maximum.

Champs
values[]

string

Chaînes de l'ensemble