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 saber como definir vários campos, consulte Criar 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. Esse campo é preenchido automaticamente.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. 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. Esse campo é preenchido automaticamente.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. 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 de geração do relatório de inventário.
labels

map (key: string, value: string)

Rótulos como pares de chave-valor

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
displayName

string

Nome de exibição fornecido pelo usuário, que pode ficar vazio e é limitado a 256 caracteres e editável.
Campo de união report_format. Formato em que o relatório de inventário é gerado. report_format pode ser apenas de um dos tipos a seguir:
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 pode ser apenas de um dos tipos a seguir:
objectMetadataReportOptions

object (ObjectMetadataReportOptions)

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

FrequencyOptions

FrequencyOptions recurso

Configuração de 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 de 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 em que você quer 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.

Enums
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 inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero;
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero;
  • um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).

Tipos relacionados:

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

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.
month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.
day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e 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

Caracteres de delimitador de registros em CSV.
delimiter

string

Caracteres delimitadores em CSV.
headerRequired

boolean

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

ParquetOptions

Esse tipo não tem campos.

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

ObjectMetadataReportOptions

Opções para incluir metadados em um 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 em um relatório de inventário.
Campo de união filter. Filtra buckets para gerar relatórios de inventário do Cloud Storage. filter pode ser apenas de um dos tipos a seguir:
storageFilters

object (CloudStorageFilters)

Filtra buckets para gerar relatórios de inventário do Cloud Storage.
Campo de união destination_options. Opções para armazenar relatórios no Cloud Storage. destination_options pode ser apenas de um dos tipos a seguir:
storageDestinationOptions

object (CloudStorageDestinationOptions)

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

CloudStorageFilters

Filtra buckets para gerar relatórios de inventário do Cloud Storage.

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

string

Opcional. Bucket em que 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 bucket de destino dos relatórios de inventário.
destinationPath

string

O caminho de destino no bucket em que os relatórios de inventário são armazenados.

Métodos

create

 Cria uma nova configuração de relatório de inventário em um determinado projeto para um local específico.

delete

 Exclui uma configuração de relatório de inventário em um determinado projeto para um local.

get

 Recebe a configuração do relatório de inventário em um determinado projeto para um determinado local.

list

 Lista as configurações de relatório de inventário em um determinado projeto para um local específico.

patch

 Atualiza uma configuração de relatório de inventário em um determinado projeto para um local.