REST Resource: projects.locations.reportConfigs

Recurso: ReportConfig

Mensagem que descreve o objeto ReportConfig. ReportConfig é a configuração usada para gerar relatórios de inventário. Para obter informações sobre como definir vários campos, consulte o artigo Crie uma configuração de relatório de inventário.

Representação 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.
}
Campos
name

string

Identificador. Nome do recurso.

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

createTime

string (Timestamp format)

Apenas saída. A hora UTC em que a configuração do relatório de inventário foi criada. Este campo é preenchido automaticamente.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Apenas saída. A hora UTC em que a configuração do relatório de inventário foi atualizada. Este campo é preenchido automaticamente.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

frequencyOptions

object (FrequencyOptions)

A frequência da geração do relatório de inventário.

labels

map (key: string, value: string)

Etiquetas como pares de chave-valor

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayName

string

Nome a apresentar fornecido pelo utilizador que pode estar vazio e limitado a 256 carateres editáveis.

Campo de união report_format. Formato no qual o relatório de inventário é gerado. report_format só pode ser uma das seguintes opções:
csvOptions

object (CSVOptions)

Opções para relatórios formatados em CSV.

parquetOptions

object (ParquetOptions)

Opções para relatórios formatados em Parquet.

Campo de união report_kind. Opções de configuração para o conteúdo do relatório de inventário. report_kind só pode ser uma das seguintes opções:
objectMetadataReportOptions

object (ObjectMetadataReportOptions)

Opções para incluir metadados de objetos num relatório de inventário.

FrequencyOptions

FrequencyOptions recurso

Configuração da frequência para a geração de relatórios de inventário.

Representação JSON
{
  "frequency": enum (Frequency),
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Campos
frequency

enum (Frequency)

Frequência da geração de relatórios de inventário.

startDate

object (Date)

A data UTC para começar a gerar relatórios de inventário. Por exemplo,{"day": 15, "month": 8, "year": 2022}.

endDate

object (Date)

A data UTC para parar de gerar relatórios de inventário. Por exemplo,{"day": 15, "month": 8, "year": 2022}.

Frequência

A frequência com que os relatórios de inventário são gerados. Os valores são FREQUENCY_UNSPECIFIED, DAILY ou WEEKLY.

Enumerações
FREQUENCY_UNSPECIFIED Não especificado.
DAILY O relatório de inventário é gerado diariamente.
WEEKLY O relatório de inventário é gerado semanalmente.

Data

Representa uma data de calendário completa ou parcial, como um aniversário. A hora do dia e o fuso horário são especificados noutro local ou são insignificantes. A data é relativa ao calendário gregoriano. Isto pode representar uma das seguintes situações:

  • Uma data completa, com valores de ano, mês e dia diferentes de zero.
  • Um mês e um dia, com um ano zero (por exemplo, um aniversário).
  • Um ano sozinho, com um mês zero e um dia zero.
  • Um ano e um mês, com um dia zero (por exemplo, a data de validade de um cartão de crédito).

Tipos relacionados:

Representação JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Tem de estar entre 1 e 9999, ou 0 para especificar uma data sem um ano.

month

integer

Mês de um ano. O valor tem de estar compreendido entre 1 e 12 ou 0 para especificar um ano sem um mês e um dia.

day

integer

Dia de um mês. Tem de estar entre 1 e 31 e ser válido para o ano e o mês, ou 0 para especificar apenas um ano ou um ano e um mês em que o dia não é significativo.

CSVOptions

Opções para configurar relatórios de inventário no formato CSV.

Representação JSON
{
  "recordSeparator": string,
  "delimiter": string,
  "headerRequired": boolean
}
Campos
recordSeparator

string

Carateres separadores de registos em CSV.

delimiter

string

Carateres delimitadores em CSV.

headerRequired

boolean

Se estiver definida, inclui uma linha de cabeçalho no relatório CSV.

ParquetOptions

Este tipo não tem campos.

Opções para configurar relatórios de inventário no formato Parquet.

ObjectMetadataReportOptions

Opções para incluir metadados num relatório de inventário.

Representação 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.
}
Campos
metadataFields[]

string

Os campos de metadados incluídos num relatório de inventário.

Campo de união filter. Filtra contentores para gerar relatórios de inventário para o Cloud Storage. filter só pode ser uma das seguintes opções:
storageFilters

object (CloudStorageFilters)

Filtra contentores para gerar relatórios de inventário para o Cloud Storage.

Campo de união destination_options. Opções para armazenar relatórios no Cloud Storage. destination_options só pode ser uma das seguintes opções:
storageDestinationOptions

object (CloudStorageDestinationOptions)

Opções para armazenar relatórios no Cloud Storage.

CloudStorageFilters

Filtra contentores para gerar relatórios de inventário para o Cloud Storage.

Representação JSON
{
  "bucket": string
}
Campos
bucket

string

Opcional. Recipiente para o qual o relatório de inventário é gerado.

CloudStorageDestinationOptions

Opções para armazenar relatórios de inventário no Cloud Storage.

Representação JSON
{
  "bucket": string,
  "destinationPath": string
}
Campos
bucket

string

Opcional. O contentor de destino dos relatórios de inventário.

destinationPath

string

O caminho de destino no contentor onde os relatórios de inventário estão armazenados.

Métodos

create

Cria uma nova configuração de relatório de inventário num determinado projeto para uma determinada localização.

delete

Elimina uma configuração de relatório de inventário existente num determinado projeto para uma determinada localização.

get

Obtém a configuração do relatório de inventário num determinado projeto para uma determinada localização.

list

Apresenta as configurações de relatórios de inventário num determinado projeto para uma determinada localização.

patch

Atualiza uma configuração de relatório de inventário existente num determinado projeto para uma determinada localização.