Package google.cloud.observability.v1

Index

Observabilité

Service décrivant les gestionnaires de ressources

CreateTraceScope

rpc CreateTraceScope(CreateTraceScopeRequest) returns (TraceScope)

Crée un TraceScope.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • observability.traceScopes.create

Pour en savoir plus, consultez la documentation IAM.
DeleteTraceScope

rpc DeleteTraceScope(DeleteTraceScopeRequest) returns (Empty)

Supprime un TraceScope.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.traceScopes.delete

Pour en savoir plus, consultez la documentation IAM.
GetBucket

rpc GetBucket(GetBucketRequest) returns (Bucket)

Obtenez une ressource de bucket.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.buckets.get

Pour en savoir plus, consultez la documentation IAM.
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Obtenez un ensemble de données.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.datasets.get

Pour en savoir plus, consultez la documentation IAM.
GetScope

rpc GetScope(GetScopeRequest) returns (Scope)

Récupère les détails d'un seul champ d'application.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.scopes.get

Pour en savoir plus, consultez la documentation IAM.
GetSettings

rpc GetSettings(GetSettingsRequest) returns (Settings)

Obtenir les paramètres

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.settings.get

Pour en savoir plus, consultez la documentation IAM.
GetTraceScope

rpc GetTraceScope(GetTraceScopeRequest) returns (TraceScope)

Récupère une ressource TraceScope.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.traceScopes.get

Pour en savoir plus, consultez la documentation IAM.
GetView

rpc GetView(GetViewRequest) returns (View)

Obtenez une vue.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.views.get

Pour en savoir plus, consultez la documentation IAM.
ListBuckets

rpc ListBuckets(ListBucketsRequest) returns (ListBucketsResponse)

Liste les buckets d'un projet dans un emplacement spécifique.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • observability.buckets.list

Pour en savoir plus, consultez la documentation IAM.
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Répertorie les ensembles de données d'un bucket.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • observability.datasets.list

Pour en savoir plus, consultez la documentation IAM.
ListTraceScopes

rpc ListTraceScopes(ListTraceScopesRequest) returns (ListTraceScopesResponse)

Liste les TraceScopes d'un projet dans un emplacement spécifique.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • observability.traceScopes.list

Pour en savoir plus, consultez la documentation IAM.
ListViews

rpc ListViews(ListViewsRequest) returns (ListViewsResponse)

Répertoriez les vues d'un ensemble de données.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • observability.views.list

Pour en savoir plus, consultez la documentation IAM.
UpdateScope

rpc UpdateScope(UpdateScopeRequest) returns (Scope)

Met à jour les paramètres d'un seul champ d'application.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.scopes.update

Pour en savoir plus, consultez la documentation IAM.
UpdateSettings

rpc UpdateSettings(UpdateSettingsRequest) returns (Operation)

Mettre à jour les paramètres

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.settings.update

Pour en savoir plus, consultez la documentation IAM.
UpdateTraceScope

rpc UpdateTraceScope(UpdateTraceScopeRequest) returns (TraceScope)

Met à jour un TraceScope.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • observability.traceScopes.update

Pour en savoir plus, consultez la documentation IAM.

Bucket

Configuration du bucket pour stocker les données d'observabilité.

Champs
name

string

Identifiant. Nom du bucket. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
display_name

string

Facultatif. Nom à afficher convivial.
description

string

Facultatif. Description du bucket.
create_time

Timestamp

Uniquement en sortie. Code temporel de création.
update_time

Timestamp

Uniquement en sortie. Horodatage de la mise à jour.
delete_time

Timestamp

Uniquement en sortie. Supprime le code temporel.
purge_time

Timestamp

Uniquement en sortie. Code temporel de la suppression définitive du bucket à l'état "Supprimé de façon réversible".
cmek_settings

CmekSettings

Facultatif. Paramètres permettant de configurer CMEK sur un bucket.

CmekSettings

Paramètres permettant de configurer CMEK pour un bucket.

Champs
kms_key

string

Facultatif. Nom de ressource de la clé Cloud KMS configurée. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]

Exemple :

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key
kms_key_version

string

Uniquement en sortie. Nom de ressource CryptoKeyVersion pour la clé Cloud KMS configurée. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]

Exemple :

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1

Ce champ en lecture seule permet de transmettre la CryptoKeyVersion spécifique configurée pour kms_key. Il est renseigné lorsque les paramètres CMEK sont associés à une seule version de clé.
service_account_id

string

Uniquement en sortie. Compte de service utilisé pour accéder à la clé.

CreateLinkRequest

Demande de création d'une association.

Champs
parent

string

Obligatoire. Nom de l'ensemble de données contenant ce lien. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

CreateTraceScopeRequest

Requête de création d'un TraceScope.

Champs
parent

string

Obligatoire. Nom complet de la ressource de l'emplacement où le champ d'application de trace doit être créé

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Exemple :

projects/my-project/locations/global
trace_scope_id

string

Obligatoire. Identifiant attribué par le client pour le champ d'application de la trace.
trace_scope

TraceScope

Obligatoire. Le nouveau champ d'application de trace.

Ensemble de données

Un ensemble de données est une collection de données qui présente une configuration spécifique. Un ensemble de données peut être associé à plusieurs tables. Un même bucket peut contenir plusieurs ensembles de données.

Champs
name

string

Identifiant. Nom de l'ensemble de données. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
display_name

string

Facultatif. Nom à afficher convivial.
description

string

Facultatif. Description de l'ensemble de données.
create_time

Timestamp

Uniquement en sortie. Code temporel de création.
delete_time

Timestamp

Uniquement en sortie. Supprime le code temporel.
purge_time

Timestamp

Uniquement en sortie. Code temporel indiquant quand l'ensemble de données à l'état de suppression réversible est purgé.

DeleteLinkRequest

Demande de suppression d'un lien.

Champs
name

string

Obligatoire. Nom du lien à supprimer. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

DeleteTraceScopeRequest

Requête de suppression d'un TraceScope.

Champs
name

string

Obligatoire. Nom complet de la ressource du champ de trace à supprimer :

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

Exemple :

projects/my-project/locations/global/traceScopes/my-trace-scope

GetBucketRequest

Requête permettant d'obtenir un bucket.

Champs
name

string

Obligatoire. Nom du bucket à récupérer. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

GetDatasetRequest

Requête permettant d'obtenir un ensemble de données.

Champs
name

string

Obligatoire. Nom de l'ensemble de données à récupérer. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

GetLinkRequest

Requête d'obtention d'un lien.

Champs
name

string

Obligatoire. Nom du lien à récupérer. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

GetScopeRequest

Message permettant d'obtenir un champ d'application.

Champs
name

string

Obligatoire. Nom de la ressource. Il a le format suivant :

projects/{project}/locations/{location}/scopes/{scope}

Le champ {location} doit être défini sur global. Le champ {scope} doit être défini sur _Default.

GetSettingsRequest

Requête pour obtenir les paramètres.

Champs
name

string

Obligatoire. Nom des paramètres à récupérer.

Format du nom :

"projects/[PROJECT_ID]/locations/[LOCATION]/settings"
"folders/[FOLDER_ID]/locations/[LOCATION]/settings"
"organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings"

GetTraceScopeRequest

Requête permettant d'obtenir un TraceScope.

Champs
name

string

Obligatoire. Nom de ressource du champ d'application de trace :

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

Exemple :

projects/my-project/locations/global/traceScopes/my-trace-scope

GetViewRequest

Requête d'obtention d'une vue.

Champs
name

string

Obligatoire. Nom de la vue à récupérer. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]

ListBucketsRequest

Requête pour lister les buckets.

Champs
parent

string

Obligatoire. Parent qui possède cette collection de buckets. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]
page_size

int32

Facultatif. Nombre maximal de buckets à renvoyer. Si aucune valeur n'est spécifiée, 100 buckets au maximum sont renvoyés. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListBuckets précédent. Fournissez-le pour récupérer la page suivante.
show_deleted

bool

Facultatif. Si la valeur est "true", la réponse inclura les buckets supprimés.

ListBucketsResponse

Réponse pour la liste des buckets.

Champs
buckets[]

Bucket

Facultatif. Liste des buckets.
next_page_token

string

Facultatif. Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

ListDatasetsRequest

Requête pour lister les ensembles de données.

Champs
parent

string

Obligatoire. Bucket parent qui possède cette collection d'ensembles de données. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
page_size

int32

Facultatif. Nombre maximal d'ensembles de données à renvoyer. Si aucune valeur n'est spécifiée, 100 ensembles de données au maximum sont renvoyés. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListDatasets précédent. Fournissez-le pour récupérer la page suivante.
show_deleted

bool

Facultatif. Si la valeur est "true", la réponse inclura les ensembles de données supprimés.

ListDatasetsResponse

Réponse pour la liste des ensembles de données.

Champs
datasets[]

Dataset

Liste des ensembles de données.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

ListLinksRequest

Demande de liens vers des fiches.

Champs
parent

string

Obligatoire. Ensemble de données parent qui possède cette collection de liens. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
page_size

int32

Facultatif. Nombre maximal de liens à renvoyer. Si aucune valeur n'est spécifiée, 100 liens au maximum sont renvoyés. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListLinks précédent. Fournissez-le pour récupérer la page suivante.

ListLinksResponse

Réponse pour la liste des liens.

Champs
next_page_token

string

Facultatif. Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

ListTraceScopesRequest

Requête pour lister les TraceScopes.

Champs
parent

string

Obligatoire. Nom complet de la ressource de l'établissement pour lequel rechercher les champs d'application de trace :

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Exemple :

projects/my-project/locations/global
page_size

int32

Facultatif. Nombre maximal de résultats à renvoyer pour cette requête.

Les valeurs non positives sont ignorées. La présence de next_page_token dans la réponse indique que d'autres résultats peuvent être disponibles.
page_token

string

Facultatif. Si elle est présente, récupérez le prochain lot de résultats de l'appel précédent à cette méthode. page_token doit être la valeur de next_page_token de la réponse précédente. Les valeurs des autres paramètres de la méthode doivent être identiques à celles de l'appel précédent.

ListTraceScopesResponse

Réponse pour la liste des TraceScopes.

Champs
trace_scopes[]

TraceScope

Facultatif. Liste des portées de trace.
next_page_token

string

Facultatif. Si la réponse peut contenir plus de résultats que ceux qui y figurent, next_page_token est inclus. Pour obtenir l'ensemble de résultats suivant, appelez à nouveau la même méthode en utilisant la valeur de next_page_token comme page_token.

ListViewsRequest

Requête pour les vues de fiches.

Champs
parent

string

Obligatoire. Ensemble de données dont les vues doivent être listées. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
page_size

int32

Facultatif. Nombre maximal de vues à renvoyer. Si aucune valeur n'est spécifiée, 100 vues au maximum sont renvoyées. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListViews précédent. Fournissez-le pour récupérer la page suivante.

ListViewsResponse

Réponse pour la liste des vues.

Champs
views[]

View

Liste des vues.
next_page_token

string

Facultatif. Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

OperationMetadata

Représente les métadonnées de l'opération de longue durée.

Champs
create_time

Timestamp

Uniquement en sortie. Heure à laquelle l'opération a été créée.
end_time

Timestamp

Uniquement en sortie. Heure à laquelle l'opération a terminé son exécution.
target

string

Uniquement en sortie. Chemin d'accès à la ressource défini par le serveur pour la cible de l'opération.
verb

string

Uniquement en sortie. Nom du verbe exécuté par l'opération.
status_message

string

Uniquement en sortie. Statut lisible de l'opération, le cas échéant.
requested_cancellation

bool

Uniquement en sortie. Détermine si l'utilisateur a demandé l'annulation de l'opération. Les opérations qui ont bien été annulées possèdent la valeur [Operation.error][] avec un code d'état google.rpc.Status.code de 1, correspondant au code Code.CANCELLED.
api_version

string

Uniquement en sortie. Version de l'API ayant permis de démarrer l'opération.

Champ d'application

Message décrivant l'objet Scope

Champs
name

string

Identifiant. Nom de la ressource. Il a le format suivant :

projects/{project}/locations/{location}/scopes/{scope}

Le champ {location} doit être défini sur global. Le champ {scope} doit être défini sur _Default.
update_time

Timestamp

Uniquement en sortie. Horodatage de la mise à jour. Remarque : Le code temporel de mise à jour pour le champ d'application par défaut n'est pas défini au départ.
log_scope

string

Obligatoire. Nom complet de la ressource LogScope. Exemple :

//logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope
trace_scope

string

Obligatoire. Nom de ressource du TraceScope. Exemple :

projects/myproject/locations/global/traceScopes/my-trace-scope

Paramètres

Décrit les paramètres associés à un projet, une organisation ou un dossier.

Champs
name

string

Identifiant. Nom de ressource des paramètres.
default_storage_location

string

Facultatif. Emplacement à utiliser lorsque des ressources régionales sont provisionnées par Google Cloud.
service_account_id

string

Uniquement en sortie. Compte de service pour le conteneur de ressources donné, tel qu'un projet ou un dossier. Cloud Observability l'utilisera pour effectuer des actions dans le projet du conteneur, comme accéder aux clés KMS ou créer des liens. Le compte de service est toujours le même pour chaque conteneur de ressources, quelle que soit la région.
kms_key_name

string

Facultatif. Nom de ressource de la clé Cloud KMS configurée.

Format du nom de la clé KMS :

"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"

Exemple :

"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"

TraceScope

Un champ d'application de trace est un ensemble de ressources dont les traces sont interrogées ensemble.

Champs
name

string

Identifiant. Nom de ressource du champ d'application de la trace.

Exemple :

projects/my-project/locations/global/traceScopes/my-trace-scope
resource_names[]

string

Obligatoire. Noms des projets inclus dans ce champ d'application de trace.

  • projects/[PROJECT_ID]

Un champ d'application de trace peut inclure jusqu'à 20 projets.
description

string

Facultatif. Décrit le champ d'application de cette trace.

La description ne doit pas dépasser 8 000 caractères.
create_time

Timestamp

Uniquement en sortie. Code temporel de création du champ d'application de trace.
update_time

Timestamp

Uniquement en sortie. Horodatage de la dernière mise à jour du champ d'application de la trace.

UpdateLinkRequest

Requête de mise à jour d'un lien.

Champs
update_mask

FieldMask

Facultatif. Liste des champs à mettre à jour.

UpdateScopeRequest

Message permettant de mettre à jour un Scope.

Champs
update_mask

FieldMask

Facultatif. Le masque de champ permet de spécifier les champs à écraser dans la ressource Scope lors de la mise à jour. Les champs spécifiés dans le paramètre update_mask sont relatifs à la ressource, et non à la requête complète. Un champ est écrasé s'il figure dans le masque. Si l'utilisateur ne fournit pas de masque, tous les champs présents dans la requête sont écrasés.
scope

Scope

Obligatoire. Ressource en cours de mise à jour.

UpdateSettingsRequest

Requête de mise à jour des paramètres.

Champs
settings

Settings

Obligatoire. Paramètres à modifier.

Le champ "name" des paramètres permet d'identifier la ressource à mettre à jour.
update_mask

FieldMask

Facultatif. Masque de champ spécifiant les champs des paramètres à mettre à jour.

UpdateTraceScopeRequest

Requête de mise à jour d'un TraceScope.

Champs
trace_scope

TraceScope

Obligatoire. Nouveau champ d'application de la trace.
update_mask

FieldMask

Facultatif. Liste des champs à mettre à jour.

Afficher

Une vue correspond à une représentation en lecture seule d'un sous-ensemble des données d'un ensemble de données.

Champs
name

string

Identifiant. Nom de la vue. Il a le format suivant :

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]
display_name

string

Facultatif. Nom à afficher convivial.
description

string

Facultatif. Description de la vue.
create_time

Timestamp

Uniquement en sortie. Code temporel de création.
update_time

Timestamp

Uniquement en sortie. Horodatage de la mise à jour.