REST Resource: projects.locations.reportConfigs

Ressource: ReportConfig

Message décrivant l'objet ReportConfig. ReportConfig est la configuration utilisée pour générer des rapports d'inventaire. Pour savoir comment définir différents champs, consultez Créer une configuration de rapport d'inventaire.

Représentation JSON
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "frequencyOptions": {
    object (FrequencyOptions)
  },
  "labels": {
    string: string,
    ...
  },
  "displayName": string,

  // Union field report_format can be only one of the following:
  "csvOptions": {
    object (CSVOptions)
  },
  "parquetOptions": {
    object (ParquetOptions)
  }
  // End of list of possible types for union field report_format.

  // Union field report_kind can be only one of the following:
  "objectMetadataReportOptions": {
    object (ObjectMetadataReportOptions)
  }
  // End of list of possible types for union field report_kind.
}
Champs
name

string

Identifiant. Nom de la ressource.

Format : projects/{projectId}/locations/{location}/reportConfigs/{report-config-id}.

createTime

string (Timestamp format)

Uniquement en sortie. Heure UTC à laquelle la configuration du rapport d'inventaire a été créée. Ce champ est renseigné automatiquement.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Uniquement en sortie. Heure UTC à laquelle la configuration du rapport d'inventaire a été mise à jour. Ce champ est renseigné automatiquement.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

frequencyOptions

object (FrequencyOptions)

Fréquence de génération du rapport d'inventaire.

labels

map (key: string, value: string)

Étiquettes sous forme de paires clé-valeur

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayName

string

Nom à afficher fourni par l'utilisateur, qui peut être vide et limité à 256 caractères, et qui peut être modifié.

Champ d'union report_format. Format dans lequel le rapport d'inventaire est généré. report_format ne peut être qu'un des éléments suivants :
csvOptions

object (CSVOptions)

Options pour les rapports au format CSV.

parquetOptions

object (ParquetOptions)

Options pour les rapports au format Parquet.

Champ d'union report_kind. Options de configuration du contenu des rapports sur l'inventaire. report_kind ne peut être qu'un des éléments suivants :
objectMetadataReportOptions

object (ObjectMetadataReportOptions)

Options permettant d'inclure des métadonnées d'objet dans un rapport d'inventaire.

FrequencyOptions

FrequencyOptions ressource

Configuration de la fréquence de génération des rapports d'inventaire.

Représentation JSON
{
  "frequency": enum (Frequency),
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Champs
frequency

enum (Frequency)

Fréquence de génération des rapports d'inventaire.

startDate

object (Date)

Date UTC à laquelle commencer à générer des rapports d'inventaire. Par exemple,{"day": 15, "month": 8, "year": 2022}.

endDate

object (Date)

Date UTC à laquelle vous souhaitez cesser de générer des rapports d'inventaire. Par exemple,{"day": 15, "month": 8, "year": 2022}.

Fréquence

Fréquence à laquelle les rapports d'inventaire sont générés. Les valeurs sont FREQUENCY_UNSPECIFIED, DAILY ou WEEKLY.

Enums
FREQUENCY_UNSPECIFIED Non spécifié.
DAILY Le rapport d'inventaire est généré quotidiennement.
WEEKLY Le rapport sur l'inventaire est généré chaque semaine.

Date

Représente une date du calendrier entière ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. La date est donnée selon le calendrier grégorien. Il peut s'agir de l'un des éléments suivants:

  • Une date complète, avec des valeurs non nulles pour l'année, le mois et le jour.
  • un mois et un jour, avec une année nulle (par exemple, un anniversaire) ;
  • une année seule, avec un mois et un jour nuls ;
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés:

Représentation JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Champs
year

integer

Année de la date. Elle doit être comprise entre 1 et 9999, ou égale à 0 pour spécifier une date sans année.

month

integer

Mois d'une année. Il doit être compris entre 1 et 12, ou égal à 0 pour spécifier une année sans mois ni jour.

day

integer

Jour d'un mois. Il doit être compris entre 1 et 31, et valide pour l'année et le mois, ou égal à 0 pour spécifier une année seule, ou une année et un mois où le jour n'est pas significatif.

CSVOptions

Options permettant de configurer des rapports d'inventaire au format CSV.

Représentation JSON
{
  "recordSeparator": string,
  "delimiter": string,
  "headerRequired": boolean
}
Champs
recordSeparator

string

Caractères de séparateur d'enregistrements dans un fichier CSV.

delimiter

string

Caractères délimiteurs dans le format CSV.

headerRequired

boolean

Si défini, inclut une ligne d'en-tête dans le rapport CSV.

ParquetOptions

Ce type ne comporte aucun champ.

Options permettant de configurer des rapports d'inventaire au format Parquet.

ObjectMetadataReportOptions

Options permettant d'inclure des métadonnées dans un rapport d'inventaire.

Représentation JSON
{
  "metadataFields": [
    string
  ],

  // Union field filter can be only one of the following:
  "storageFilters": {
    object (CloudStorageFilters)
  }
  // End of list of possible types for union field filter.

  // Union field destination_options can be only one of the following:
  "storageDestinationOptions": {
    object (CloudStorageDestinationOptions)
  }
  // End of list of possible types for union field destination_options.
}
Champs
metadataFields[]

string

Champs de métadonnées inclus dans un rapport d'inventaire.

Champ d'union filter. Filtre les buckets pour générer des rapports d'inventaire pour Cloud Storage. filter ne peut être qu'un des éléments suivants :
storageFilters

object (CloudStorageFilters)

Filtre les buckets pour générer des rapports d'inventaire pour Cloud Storage.

Champ d'union destination_options. Options de stockage des rapports dans Cloud Storage. destination_options ne peut être qu'un des éléments suivants :
storageDestinationOptions

object (CloudStorageDestinationOptions)

Options de stockage des rapports dans Cloud Storage.

CloudStorageFilters

Filtre les buckets pour générer des rapports d'inventaire pour Cloud Storage.

Représentation JSON
{
  "bucket": string
}
Champs
bucket

string

Facultatif. Bucket pour lequel le rapport d'inventaire est généré.

CloudStorageDestinationOptions

Options permettant de stocker des rapports d'inventaire dans Cloud Storage.

Représentation JSON
{
  "bucket": string,
  "destinationPath": string
}
Champs
bucket

string

Facultatif. Bucket de destination des rapports d'inventaire.

destinationPath

string

Chemin de destination dans le bucket où les rapports d'inventaire sont stockés.

Méthodes

create

Crée une configuration de rapport d'inventaire dans un projet donné pour un emplacement donné.

delete

Supprime une configuration de rapport d'inventaire existante dans un projet donné pour un emplacement donné.

get

Récupère la configuration du rapport d'inventaire dans un projet donné pour un emplacement donné.

list

Répertorie les configurations de rapports d'inventaire d'un projet donné pour un emplacement donné.

patch

Met à jour une configuration de rapport d'inventaire existante dans un projet donné pour un emplacement donné.