Package google.maps.mapsplatformdatasets.v1

Índice

MapsPlatformDatasets

Definición del servicio para la API de Maps Platform Datasets.

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

Crea un conjunto de datos nuevo para el proyecto especificado.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • mapsplatformdatasets.datasets.create

Para obtener más información, consulta la documentación de IAM.
DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

Borra el conjunto de datos especificado.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • mapsplatformdatasets.datasets.delete

Para obtener más información, consulta la documentación de IAM.
DownloadDataset

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

Descarga un conjunto de datos.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • mapsplatformdatasets.datasets.export

Para obtener más información, consulta la documentación de IAM.
FetchDatasetErrors

rpc FetchDatasetErrors(FetchDatasetErrorsRequest) returns (FetchDatasetErrorsResponse)

Obtiene todos los errores de un conjunto de datos.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso dataset:

  • mapsplatformdatasets.datasets.get

Para obtener más información, consulta la documentación de IAM.
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Obtiene el conjunto de datos.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • mapsplatformdatasets.datasets.get

Para obtener más información, consulta la documentación de IAM.
ImportDataset

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

Importa una versión nueva de los datos para el conjunto de datos.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • mapsplatformdatasets.datasets.import

Para obtener más información, consulta la documentación de IAM.
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Muestra una lista de todos los conjuntos de datos del proyecto especificado.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • mapsplatformdatasets.datasets.list

Para obtener más información, consulta la documentación de IAM.
UpdateDatasetMetadata

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

Actualiza los metadatos del conjunto de datos.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • mapsplatformdatasets.datasets.update

Para obtener más información, consulta la documentación de IAM.

CreateDatasetRequest

Solicitud para crear un conjunto de datos de mapas.

Campos
parent

string

Obligatorio. Proyecto superior que será propietario del conjunto de datos. Formato: projects/{project}
dataset

Dataset

Obligatorio. La versión del conjunto de datos que se creará.

Conjunto de datos

Representación de un recurso de conjunto de datos.

Campos
name

string

Nombre del recurso. Formato: projects/{project}/datasets/{dataset_id}
display_name

string

Nombre legible por humanos, que se muestra en la IU de la consola.

Debe ser único en un proyecto.
description

string

Es una descripción de este conjunto de datos.
version_id

string

Es el ID de la versión del conjunto de datos.
usage[]

Usage

Caso de uso especificado para este conjunto de datos.
status

Status

Solo salida. El estado de la versión de este conjunto de datos.
create_time

Timestamp

Solo salida. Hora en la que se creó el conjunto de datos por primera vez.
update_time

Timestamp

Solo salida. Hora en la que se actualizaron por última vez los metadatos del conjunto de datos.
version_create_time

Timestamp

Solo salida. Hora en la que se creó esta versión.
version_description

string

Solo salida. La descripción de esta versión del conjunto de datos. Se proporciona cuando importas datos al conjunto de datos.
Campo de unión data_source. Detalles sobre la fuente de los datos para el conjunto de datos. Las direcciones (data_source) solo pueden ser una de las siguientes opciones:
local_file_source

LocalFileSource

Una fuente de archivo local para el conjunto de datos en una sola carga.
gcs_source

GcsSource

Una fuente de archivos de Google Cloud Storage para el conjunto de datos en una sola carga.

DeleteDatasetRequest

Solicitud para borrar un conjunto de datos.

Campos
name

string

Obligatorio. El nombre del conjunto de datos que se borrará. Formato: projects/{project}/datasets/{dataset_id}

DownloadDatasetRequest

Solicitud para descargar el conjunto de datos.

Campos
name

string

Nombre del recurso del conjunto de datos que se recuperará. Formato: projects/{project}/datasets/{dataset_id}

DownloadDatasetResponse

Objeto de respuesta de DownloadDataset.

FetchDatasetErrorsRequest

Es una solicitud para enumerar errores detallados que pertenecen a un conjunto de datos.

Campos
dataset

string

Obligatorio. El nombre del conjunto de datos para el que se enumerarán todos los errores. Formato: projects/{project}/datasets/{dataset_id}
page_size

int32

La cantidad máxima de errores que se muestran por página.

El valor máximo es 500. los valores superiores a 500 se limitarán a 500.

Si no se especifica, se mostrarán 50 errores como máximo.
page_token

string

El token de la página, recibido de una llamada anterior ListDatasetErrors. Proporciona esto para recuperar la página siguiente.

FetchDatasetErrorsResponse

Objeto de respuesta de FetchDatasetErrors.

Campos
next_page_token

string

Un token que se puede enviar como page_token para recuperar la página siguiente.

Si se omite este campo, no habrá páginas siguientes.
errors[]

Status

Son los errores asociados con un conjunto de datos.

FileFormat

El formato del archivo que se sube.

Enumeraciones
FILE_FORMAT_UNSPECIFIED Formato de archivo no especificado.
FILE_FORMAT_GEOJSON GeoJson.
FILE_FORMAT_KML Archivo KML.
FILE_FORMAT_CSV .CSV.

GcsSource

Los detalles sobre la fuente de datos cuando están en Google Cloud Storage.

Campos
input_uri

string

Es el URI de los datos de origen. Por ejemplo, gs://my_bucket/my_object.
file_format

FileFormat

El formato de archivo del objeto de Google Cloud Storage. Esto se usa principalmente para la validación.

GetDatasetRequest

Solicitud para obtener el conjunto de datos especificado.

Campos
name

string

Obligatorio. Nombre del recurso. Formato: projects/{project}/datasets/{dataset_id}

También puedes agregar "@" para recuperar algunas versiones especiales y una etiqueta. Formato: projects/{project}/datasets/{dataset_id}@{tag}

Etiqueta “active”: Se incluirá la información de la última versión completada, y NOT_FOUND si el conjunto de datos no tiene una.

ImportDatasetRequest

Solicitud para importar una nueva versión del conjunto de datos.

Campos
name

string

Obligatorio. Nombre del recurso. Formato: projects/{project}/datasets/{dataset_id}
version_description

string

Una descripción de los datos nuevos que se importan.
Campo de unión data_source. Detalles sobre la fuente de los datos para el conjunto de datos. Las direcciones (data_source) solo pueden ser una de las siguientes opciones:
local_file_source

LocalFileSource

Una fuente de archivo local para el conjunto de datos para una importación única.
gcs_source

GcsSource

Una fuente de archivo de Google Cloud Storage para el conjunto de datos para una importación única.

ImportDatasetResponse

Objeto de respuesta de ImportDataset.

Campos
name

string

Obligatorio. Nombre del recurso de la versión del conjunto de datos recién creado. Formato: projects/{project}/datasets/{dataset_id}@{version_id}

ListDatasetsRequest

Es una solicitud para enumerar los conjuntos de datos del proyecto.

Campos
parent

string

Obligatorio. El nombre del proyecto para el que se enumeran todos los conjuntos de datos. Formato: projects/{project}
page_size

int32

La cantidad máxima de conjuntos de datos que se mostrarán por página.

Si no se especifica (o es cero), se mostrarán todos los conjuntos de datos.
page_token

string

El token de la página, recibido de una llamada anterior a ListDatasets. Proporciona esto para recuperar la página siguiente.
tag

string

Es la etiqueta que especifica la versión deseada para cada conjunto de datos.

Ten en cuenta que cuando también se especifica la paginación, se pueden aplicar algunos filtros después de la paginación, lo que puede provocar que la respuesta contenga menos conjuntos de datos que el tamaño de la página, incluso si no es la última página.

Etiqueta “activa”: Cada conjunto de datos en la respuesta incluirá la información de su última versión completada, y el conjunto de datos se omitirá si no tiene una.

ListDatasetsResponse

Objeto de respuesta de ListDatasets.

Campos
datasets[]

Dataset

Todos los conjuntos de datos del proyecto.
next_page_token

string

Un token que se puede enviar como page_token para recuperar la página siguiente.

Si se omite este campo, no habrá páginas siguientes.

LocalFileSource

Los detalles sobre la fuente de datos cuando es un archivo local.

Campos
filename

string

Es el nombre del archivo subido.
file_format

FileFormat

El formato del archivo que se sube.

Estado

Estado del conjunto de datos.

Campos
state

State

Establece el estado enum.
error_message

string

Mensaje de error que indica el motivo del error. Estará vacío si los conjuntos de datos no tienen un estado de error.

Estado

Es una lista de estados para el conjunto de datos.

Enumeraciones
STATE_UNSPECIFIED No se estableció el estado de este conjunto de datos.
STATE_IMPORTING Se están importando los datos a un conjunto de datos.
STATE_IMPORT_SUCCEEDED Los datos a un conjunto de datos se importaron correctamente.
STATE_IMPORT_FAILED No se pudieron importar los datos a un conjunto de datos.
STATE_DELETING El conjunto de datos está en proceso de eliminación.
STATE_DELETION_FAILED El estado de error de eliminación. Este estado indica que no se pudo borrar el conjunto de datos. Se puede reintentar la eliminación.
STATE_PROCESSING Se están procesando los datos.
STATE_PROCESSING_FAILED El estado de error de procesamiento. Este estado indica que se produjo un error en el procesamiento y puede informar errores.
STATE_NEEDS_REVIEW Este estado no se usa actualmente.
STATE_PUBLISHING Es el estado de publicación. Este estado indica que la publicación está en curso.
STATE_PUBLISHING_FAILED Estados de error en la publicación. Este estado indica que falló la publicación. Se puede reintentar la publicación.
STATE_COMPLETED El estado completo. Este estado representa el conjunto de datos disponible para su uso específico.

UpdateDatasetMetadataRequest

Solicitud para actualizar los campos de metadatos del conjunto de datos.

Campos
dataset

Dataset

Obligatorio. Nombre del recurso del conjunto de datos a actualizar. Formato: projects/{project}/datasets/{dataset_id}
update_mask

FieldMask

La lista de campos que se actualizarán.

El valor “*” se usa para el reemplazo completo (predeterminado).

Uso

El uso especifica dónde se usarán los datos para informar cómo procesarlos.

Enumeraciones
USAGE_UNSPECIFIED El uso de este conjunto de datos no está establecido.
USAGE_DATA_DRIVEN_STYLING Este conjunto de datos se usará para el diseño basado en datos.