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 del conjunto 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 salida. Es la hora UTC en la que se creó la configuración del conjunto de datos. Este campo se completa automáticamente.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas 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 salida. La hora (UTC) en la que se actualizó por última vez la configuración del conjunto de datos. Este campo se completa automáticamente.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas 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 salida. Es el identificador único generado por el sistema para el recurso.

organizationNumber

string (int64 format)

Opcional. Es el ID del recurso de la organización al que deben pertenecer los proyectos de origen. Cuando se crea el conjunto de datos, no se consideran los proyectos que no pertenecen a la organización proporcionada.

includeNewlyCreatedBuckets

boolean

Si se establece en true, la solicitud incluye todos los buckets recién creados en el conjunto de datos que cumplen con las reglas de inclusión y exclusión.

retentionPeriodDays

integer

Cantidad de días de historial que se deben retener.

identity

object (Identity)

Es la identidad que usa este datasetConfig.

status

object (Status)

Solo salida. Estado de datasetConfig.

datasetConfigState

enum (ConfigState)

Solo salida. Estado de datasetConfig.

description

string

Opcional. Es una descripción que proporciona 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 para el conjunto de datos. source_options puede ser solo uno de los siguientes:
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 para el conjunto de datos.

organizationScope

boolean

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

cloudStorageObjectPath

string

Solo entrada. Es la ruta de acceso al objeto de Cloud Storage que contiene una lista de números de proyectos o carpetas para incluir 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:

  • Es el número de proyecto con el formato projects/{projectNumber}, por ejemplo, projects/1234567890.
  • Es el 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 incluirán o excluirán cloud_storage_locations puede ser solo uno de los siguientes:
includeCloudStorageLocations

object (CloudStorageLocations)

excludeCloudStorageLocations

object (CloudStorageLocations)

Campo de unión cloud_storage_buckets. Buckets de Cloud Storage que se incluirán o excluirán cloud_storage_buckets puede ser solo uno de los siguientes:
includeCloudStorageBuckets

object (CloudStorageBuckets)

excludeCloudStorageBuckets

object (CloudStorageBuckets)

SourceProjects

Colección de números de proyectos

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. Es la lista de números de carpetas que se incluirán en el conjunto de datos.

CloudStorageLocations

Es una colección de ubicaciones de Cloud Storage.

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

string

CloudStorageBuckets

Es una colección de buckets de Cloud Storage.

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

object (CloudStorageBucket)

CloudStorageBucket

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

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 puede ser una de las siguientes opciones:

bucketName

string

Es el nombre del bucket de Cloud Storage.

bucketPrefixRegex

string

Es un patrón de regex para los nombres de bucket que coinciden con la regex. La regex debe seguir la sintaxis especificada en google/re2 en GitHub.

Identidad

Identity permite que el usuario proporcione el tipo de identidad que se usará y muestra la cadena de identidad que se puede usar para los cambios en la política de IAM.

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

string

Solo salida. Es el nombre de la identidad.

type

enum (IdentityType)

Es el tipo de identidad que se usará para datasetConfig.

IdentityType

Es el tipo de cuenta de servicio que se usará para la configuración del conjunto de datos.

Enums
IDENTITY_TYPE_UNSPECIFIED El valor predeterminado no se especifica y no se debe usar.
IDENTITY_TYPE_PER_CONFIG Cuenta de servicio administrada por Google por recurso
IDENTITY_TYPE_PER_PROJECT Cuenta de servicio administrada por Google por proyecto

ConfigState

Estado de la configuración.

Enums
CONFIG_STATE_UNSPECIFIED Estado sin especificar.
CONFIG_STATE_ACTIVE La configuración activa indica que la configuración transfiere datos de forma activa.
CONFIG_STATE_VERIFICATION_IN_PROGRESS En este estado, se verifica la configuración para varios permisos.
CONFIG_STATE_CREATED Se creó la configuración y se debe realizar un procesamiento adicional.
CONFIG_STATE_PROCESSING La configuración está en proceso

Métodos

create

Crea una configuración de conjunto de datos en un proyecto determinado para una ubicación determinada.

delete

Borra la configuración de un conjunto de datos en un proyecto determinado para una ubicación determinada.

get

Obtiene la configuración del conjunto de datos en un proyecto determinado para una ubicación determinada.

linkDataset

Vincula un conjunto de datos a BigQuery en un proyecto determinado para una ubicación determinada.

list

Muestra una lista de las configuraciones de los conjuntos de datos en un proyecto determinado para una ubicación determinada.

patch

Actualiza la configuración de un conjunto de datos en un proyecto determinado para una ubicación determinada.

unlinkDataset

Desvincula un conjunto de datos de BigQuery en un proyecto determinado para una ubicación determinada.