REST Resource: projects.locations.datasetConfigs

Recurso: DatasetConfig

Mensagem que descreve as propriedades de configuração do conjunto de dados. Para mais informações, consulte o artigo 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.
}
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. 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 conjunto de dados foi atualizada pela última vez. 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".
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" }.
uid

string

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

string (int64 format)

Opcional. ID do recurso da organização à qual os projetos de origem devem pertencer. Os projetos que não pertencem à organização fornecida não são considerados na criação do conjunto de dados.
includeNewlyCreatedBuckets

boolean

Se estiver definido como true, o pedido inclui todos os novos grupos criados no conjunto de dados que cumprem as regras de inclusão e exclusão.
retentionPeriodDays

integer

Número de dias do histórico que têm de ser retidos.
identity

object (Identity)

Identidade usada por este datasetConfig.
status

object (Status)

Apenas saída. Estado do datasetConfig.
datasetConfigState

enum (ConfigState)

Apenas saída. Estado do datasetConfig.
description

string

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

Comprimento máximo: 256 carateres.
Campo de união source_options. Define as opções para fornecer identificadores de origem para o conjunto de dados. source_options só pode ser uma das seguintes opções:
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

Apenas entrada. Caminho do objeto do Cloud Storage que contém uma lista de números de projetos ou pastas a incluir no conjunto de dados. Não pode conter uma combinação de projetos e pastas.

O objeto tem de ser um ficheiro de texto em que cada linha tem 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 tem de estar no formato gs://{bucketName}/{objectName}.
Campo de união cloud_storage_locations. Localizações do Cloud Storage a incluir ou excluir. cloud_storage_locations só pode ser uma das seguintes opções:
includeCloudStorageLocations

object (CloudStorageLocations)
excludeCloudStorageLocations

object (CloudStorageLocations)
Campo de união cloud_storage_buckets. Contentores do Cloud Storage a incluir ou excluir. cloud_storage_buckets só pode ser uma das seguintes opções:
includeCloudStorageBuckets

object (CloudStorageBuckets)
excludeCloudStorageBuckets

object (CloudStorageBuckets)

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 incluir no conjunto de dados

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

string (int64 format)

Opcional. A lista de números de pastas a incluir no conjunto de dados.

CloudStorageLocations

Coleção de localizações do Cloud Storage.

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

string

CloudStorageBuckets

Coleção de contentores do Cloud Storage.

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

object (CloudStorageBucket)

CloudStorageBucket

Define o contentor pelo respetivo nome ou um padrão de regex para corresponder a contentores.

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 só pode ser uma das seguintes opções:
bucketName

string

Nome do contentor do Cloud Storage.
bucketPrefixRegex

string

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

Identidade

A identidade permite ao utilizador fornecer o tipo de identidade a usar e produz a string de identidade que pode ser usada para alterações de políticas de 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 usar para o datasetConfig.

IdentityType

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

Enumerações
IDENTITY_TYPE_UNSPECIFIED O valor predefinido não está especificado e não deve ser usado.
IDENTITY_TYPE_PER_CONFIG Conta de serviço gerida pela Google por recurso.
IDENTITY_TYPE_PER_PROJECT Conta de serviço gerida pela Google por projeto.

ConfigState

Estado da configuração.

Enumerações
CONFIG_STATE_UNSPECIFIED Estado não especificado.
CONFIG_STATE_ACTIVE A configuração ativa indica que a configuração está a carregar dados ativamente.
CONFIG_STATE_VERIFICATION_IN_PROGRESS Neste estado, a configuração está a ser validada para várias autorizações.
CONFIG_STATE_CREATED A configuração é criada e é necessário processamento adicional.
CONFIG_STATE_PROCESSING A configuração está a ser processada

Métodos

create

 Cria uma configuração do conjunto de dados num determinado projeto para uma determinada localização.

delete

 Elimina uma configuração do conjunto de dados num determinado projeto para uma determinada localização.

get

 Obtém a configuração do conjunto de dados num determinado projeto para uma determinada localização.

linkDataset

 Associa um conjunto de dados ao BigQuery num determinado projeto para uma determinada localização.

list

 Apresenta as configurações do conjunto de dados num determinado projeto para uma determinada localização.

patch

 Atualiza a configuração de um conjunto de dados num determinado projeto para uma determinada localização.

unlinkDataset

 Desassocia um conjunto de dados do BigQuery num determinado projeto para uma determinada localização.