REST Resource: projects.locations.datasetConfigs

Recurso: DatasetConfig

Mensagem que descreve as propriedades de configuração do conjunto de dados. Para mais informações, consulte Propriedades de configuração do conjunto de dados.

Representação JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "uid": string,
  "organizationNumber": string,
  "includeNewlyCreatedBuckets": boolean,
  "retentionPeriodDays": integer,
  "link": {
    object (Link)
  },
  "identity": {
    object (Identity)
  },
  "status": {
    object (Status)
  },
  "datasetConfigState": enum (ConfigState),
  "description": string,

  // Union field source_options can be only one of the following:
  "sourceProjects": {
    object (SourceProjects)
  },
  "sourceFolders": {
    object (SourceFolders)
  },
  "organizationScope": boolean,
  "cloudStorageObjectPath": string
  // End of list of possible types for union field source_options.

  // Union field cloud_storage_locations can be only one of the following:
  "includeCloudStorageLocations": {
    object (CloudStorageLocations)
  },
  "excludeCloudStorageLocations": {
    object (CloudStorageLocations)
  }
  // End of list of possible types for union field cloud_storage_locations.

  // Union field cloud_storage_buckets can be only one of the following:
  "includeCloudStorageBuckets": {
    object (CloudStorageBuckets)
  },
  "excludeCloudStorageBuckets": {
    object (CloudStorageBuckets)
  }
  // End of list of possible types for union field cloud_storage_buckets.
  "activityDataRetentionPeriodDays": integer
}
Campos
name

string

Identificador. Nome do recurso.
createTime

string (Timestamp format)

Apenas saída. A hora UTC em que a configuração do conjunto de dados foi criada. Esse campo é preenchido automaticamente.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes 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. O horário UTC em que a configuração do conjunto de dados foi atualizada pela última vez. Esse campo é preenchido automaticamente.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes 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".
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" }.
uid

string

Apenas saída. Identificador exclusivo gerado pelo sistema para o recurso.
organizationNumber

string (int64 format)

Opcional. ID do recurso da organização a que os projetos de origem precisam pertencer. Projetos que não pertencem à organização fornecida não são considerados ao criar o conjunto de dados.
includeNewlyCreatedBuckets

boolean

Se definido como true, a solicitação vai incluir todos os novos agrupamentos criados no conjunto de dados que atendem às regras de inclusão e exclusão.
retentionPeriodDays

integer

Número de dias de histórico que precisam ser retidos.
identity

object (Identity)

Identidade usada por este datasetConfig.
status

object (Status)

Apenas saída. Status do datasetConfig.
datasetConfigState

enum (ConfigState)

Apenas saída. Estado do datasetConfig.
description

string

Opcional. Uma descrição fornecida pelo usuário para a configuração do conjunto de dados.

Comprimento máximo: 256 caracteres.
Campo de união source_options. Define as opções para fornecer identificadores de origem para o conjunto de dados. source_options pode ser apenas de um dos tipos a seguir:
sourceProjects

object (SourceProjects)

Define as opções para fornecer projetos de origem para o conjunto de dados.
sourceFolders

object (SourceFolders)

Define as opções para fornecer pastas de origem para o conjunto de dados.
organizationScope

boolean

Define as opções para fornecer uma organização de origem para o conjunto de dados.
cloudStorageObjectPath

string

Somente entrada. Caminho do objeto do Cloud Storage que contém uma lista de números de projetos ou pastas a serem incluídos no conjunto de dados. Não pode conter uma mistura de projetos e pastas.

O objeto precisa ser um arquivo de texto em que cada linha tenha uma das seguintes entradas:

  • Número do projeto, formatado como projects/{projectNumber}, por exemplo, projects/1234567890.
  • Identificador da pasta, formatado como folders/{folder_number}, por exemplo, folders/9876543210. O caminho precisa estar no formato gs://{bucketName}/{objectName}.
Campo de união cloud_storage_locations. Locais do Cloud Storage a serem incluídos ou excluídos. cloud_storage_locations pode ser apenas de um dos tipos a seguir:
includeCloudStorageLocations

object (CloudStorageLocations)
excludeCloudStorageLocations

object (CloudStorageLocations)
Campo de união cloud_storage_buckets. Buckets do Cloud Storage a serem incluídos ou excluídos. cloud_storage_buckets pode ser apenas de um dos tipos a seguir:
includeCloudStorageBuckets

object (CloudStorageBuckets)
excludeCloudStorageBuckets

object (CloudStorageBuckets)
activityDataRetentionPeriodDays

integer

Opcional. Quando definido, substitui o período de armazenamento dos dados de atividade. Se não for definido, os dados de atividade vão usar o valor especificado em retentionPeriodDays.

SourceProjects

Coleção de números de projetos

Representação JSON 
{
  "projectNumbers": [
    string
  ]
}
Campos
projectNumbers[]

string (int64 format)

SourceFolders

Especifica um conjunto de pastas a serem incluídas no conjunto de dados

Representação JSON 
{
  "folderNumbers": [
    string
  ]
}
Campos
folderNumbers[]

string (int64 format)

Opcional. A lista de números de pastas a serem incluídos no conjunto de dados.

CloudStorageLocations

Coleção de locais do Cloud Storage.

Representação JSON 
{
  "locations": [
    string
  ]
}
Campos
locations[]

string

CloudStorageBuckets

Coleção de buckets do Cloud Storage.

Representação JSON 
{
  "cloudStorageBuckets": [
    {
      object (CloudStorageBucket)
    }
  ]
}
Campos
cloudStorageBuckets[]

object (CloudStorageBucket)

CloudStorageBucket

Define o bucket pelo nome ou por um padrão de regex para corresponder a buckets.

Representação JSON 
{

  // Union field cloud_storage_bucket can be only one of the following:
  "bucketName": string,
  "bucketPrefixRegex": string
  // End of list of possible types for union field cloud_storage_bucket.
}
Campos

Campo de união cloud_storage_bucket.

cloud_storage_bucket pode ser apenas de um dos tipos a seguir:
bucketName

string

Nome do bucket do Cloud Storage.
bucketPrefixRegex

string

Um padrão regex para nomes de buckets que correspondem à regex. A regex precisa seguir a sintaxe especificada em google/re2 no GitHub.

Identidade

A identidade permite que o usuário forneça o tipo de identidade a ser usada e gera a string de identidade que pode ser usada para mudanças na política do IAM.

Representação JSON 
{
  "name": string,
  "type": enum (IdentityType)
}
Campos
name

string

Apenas saída. Nome da identidade.
type

enum (IdentityType)

Tipo de identidade a ser usada para o datasetConfig.

IdentityType

Tipo de conta de serviço a ser usada para a configuração do conjunto de dados.

Tipos enumerados
IDENTITY_TYPE_UNSPECIFIED O padrão não é especificado e não deve ser usado.
IDENTITY_TYPE_PER_CONFIG Conta de serviço gerenciado pelo Google por recurso.
IDENTITY_TYPE_PER_PROJECT Conta de serviço gerenciado pelo Google por projeto.

ConfigState

Estado da configuração.

Tipos enumerados
CONFIG_STATE_UNSPECIFIED Estado não especificado.
CONFIG_STATE_ACTIVE Uma configuração ativa indica que ela está ingerindo dados.
CONFIG_STATE_VERIFICATION_IN_PROGRESS Nesse estado, a configuração está sendo verificada para várias permissões.
CONFIG_STATE_CREATED A configuração foi criada e precisa de mais processamento.
CONFIG_STATE_PROCESSING A configuração está sendo processada

Métodos

create

 Cria uma configuração de conjunto de dados em um determinado projeto para um determinado local.

delete

 Exclui uma configuração de conjunto de dados em um determinado projeto e local.

get

 Recebe a configuração do conjunto de dados em um determinado projeto para um determinado local.

linkDataset

 Vincula um conjunto de dados ao BigQuery em um determinado projeto e local.

list

 Lista as configurações de conjunto de dados em um determinado projeto e local.

patch

 Atualiza uma configuração de conjunto de dados em um determinado projeto para um determinado local.

unlinkDataset

 Desvincula um conjunto de dados do BigQuery em um determinado projeto e local.