REST Resource: projects.locations.datasetConfigs

Recurso: DatasetConfig

Mensaje que describe las propiedades de configuración del conjunto de datos. Para obtener más información, consulta Propiedades de configuración de conjuntos de datos.

Representación 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. Nombre del recurso.
createTime

string (Timestamp format)

Solo de salida. Hora UTC en la que se creó la configuración del conjunto de datos. Este campo se rellena automáticamente.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo de salida. Hora UTC en la que se actualizó por última vez la configuración del conjunto de datos. Este campo se rellena automáticamente.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Etiquetas como pares clave-valor

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }
uid

string

Solo de salida. Identificador único generado por el sistema para el recurso.
organizationNumber

string (int64 format)

Opcional. ID de recurso de organización al que deben pertenecer los proyectos de origen. Los proyectos que no pertenecen a la organización proporcionada no se tienen en cuenta al crear el conjunto de datos.
includeNewlyCreatedBuckets

boolean

Si se le asigna el valor true, la solicitud incluye todos los segmentos creados recientemente en el conjunto de datos que cumplen las reglas de inclusión y exclusión.
retentionPeriodDays

integer

Número de días del historial que se debe conservar.
identity

object (Identity)

Identidad usada por este datasetConfig.
status

object (Status)

Solo de salida. Estado de datasetConfig.
datasetConfigState

enum (ConfigState)

Solo de salida. Estado de datasetConfig.
description

string

Opcional. Descripción proporcionada por el usuario para la configuración del conjunto de datos.

Longitud máxima: 256 caracteres.
Campo de unión source_options. Define las opciones para proporcionar identificadores de origen del conjunto de datos. source_options solo puede ser una de las siguientes cosas:
sourceProjects

object (SourceProjects)

Define las opciones para proporcionar proyectos de origen para el conjunto de datos.
sourceFolders

object (SourceFolders)

Define las opciones para proporcionar carpetas de origen del conjunto de datos.
organizationScope

boolean

Define las opciones para proporcionar una organización de origen para el conjunto de datos.
cloudStorageObjectPath

string

Solo de entrada. Ruta del objeto de Cloud Storage que contiene una lista de números de proyectos o carpetas que se incluirán en el conjunto de datos. No puede contener una combinación de proyectos y carpetas.

El objeto debe ser un archivo de texto en el que cada línea tenga una de las siguientes entradas:

  • Número de proyecto con el formato projects/{projectNumber}. Por ejemplo, projects/1234567890.
  • Identificador de carpeta con el formato folders/{folder_number}. Por ejemplo, folders/9876543210. La ruta debe tener el formato gs://{bucketName}/{objectName}.
Campo de unión cloud_storage_locations. Ubicaciones de Cloud Storage que se deben incluir o excluir. cloud_storage_locations solo puede ser una de las siguientes cosas:
includeCloudStorageLocations

object (CloudStorageLocations)
excludeCloudStorageLocations

object (CloudStorageLocations)
Campo de unión cloud_storage_buckets. Segmentos de Cloud Storage que se deben incluir o excluir. cloud_storage_buckets solo puede ser una de las siguientes cosas:
includeCloudStorageBuckets

object (CloudStorageBuckets)
excludeCloudStorageBuckets

object (CloudStorageBuckets)

SourceProjects

Colección de números de proyecto

Representación JSON 
{
  "projectNumbers": [
    string
  ]
}
Campos
projectNumbers[]

string (int64 format)

SourceFolders

Especifica un conjunto de carpetas que se incluirán en el conjunto de datos.

Representación JSON 
{
  "folderNumbers": [
    string
  ]
}
Campos
folderNumbers[]

string (int64 format)

Opcional. Lista de números de carpetas que se incluirán en el conjunto de datos.

CloudStorageLocations

Colección de ubicaciones de Cloud Storage.

Representación JSON 
{
  "locations": [
    string
  ]
}
Campos
locations[]

string

CloudStorageBuckets

Colección de segmentos de Cloud Storage.

Representación JSON 
{
  "cloudStorageBuckets": [
    {
      object (CloudStorageBucket)
    }
  ]
}
Campos
cloudStorageBuckets[]

object (CloudStorageBucket)

CloudStorageBucket

Define el segmento por su nombre o un patrón de regex para que coincida con los segmentos.

Representación 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ón cloud_storage_bucket.

cloud_storage_bucket solo puede ser una de las siguientes cosas:
bucketName

string

Nombre del segmento de Cloud Storage.
bucketPrefixRegex

string

Un patrón de regex para los nombres de los segmentos que coincidan con la regex. La expresión regular debe seguir la sintaxis especificada en google/re2 en GitHub.

Identidad

Identity permite al usuario proporcionar el tipo de identidad que se va a usar y genera la cadena de identidad que se puede usar para los cambios en las políticas de gestión de identidades y accesos.

Representación JSON 
{
  "name": string,
  "type": enum (IdentityType)
}
Campos
name

string

Solo de salida. Nombre de la identidad.
type

enum (IdentityType)

Tipo de identidad que se va a usar en datasetConfig.

IdentityType

Tipo de cuenta de servicio que se va a usar para la configuración del conjunto de datos.

Enumeraciones
IDENTITY_TYPE_UNSPECIFIED El valor predeterminado no está especificado y no debe usarse.
IDENTITY_TYPE_PER_CONFIG Cuenta de servicio gestionada por Google por recurso.
IDENTITY_TYPE_PER_PROJECT Cuenta de servicio gestionada por Google por proyecto.

ConfigState

Estado de la configuración.

Enumeraciones
CONFIG_STATE_UNSPECIFIED Estado sin especificar.
CONFIG_STATE_ACTIVE Una configuración activa indica que está ingiriendo datos.
CONFIG_STATE_VERIFICATION_IN_PROGRESS En este estado, se verifica la configuración para comprobar si tiene varios permisos.
CONFIG_STATE_CREATED Se crea la configuración y es necesario realizar más pasos.
CONFIG_STATE_PROCESSING La configuración se está procesando

Métodos

create

 Crea una configuración de conjunto de datos en un proyecto y una ubicación determinados.

delete

 Elimina una configuración de conjunto de datos de un proyecto y una ubicación concretos.

get

 Obtiene la configuración del conjunto de datos de un proyecto y una ubicación concretos.

linkDataset

 Vincula un conjunto de datos a BigQuery en un proyecto determinado y en una ubicación concreta.

list

 Muestra las configuraciones de conjuntos de datos de un proyecto y una ubicación determinados.

patch

 Actualiza la configuración de un conjunto de datos de un proyecto y una ubicación determinados.

unlinkDataset

 Desvincula un conjunto de datos de BigQuery en un proyecto determinado y en una ubicación concreta.