Package google.maps.mapsplatformdatasets.v1alpha

Índice

MapsPlatformDatasetsV1Alpha

Es la definición del servicio de la API de Maps Platform Datasets.

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

Crea un conjunto de datos nuevo para el proyecto especificado.

Alcances de la 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 la 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 la 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.
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Obtén el conjunto de datos.

Alcances de la 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 nueva versión de los datos para el conjunto de datos.

Alcances de la 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.
ListDatasetErrors

rpc ListDatasetErrors(ListDatasetErrorsRequest) returns (ListDatasetErrorsResponse)

Obtiene todos los errores de un conjunto de datos (actualmente, esto solo funciona para el caso de uso de DDS).

Alcances de la 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.
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Enumera todos los conjuntos de datos del proyecto especificado.

Alcances de la 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 la 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

Es una solicitud para crear un conjunto de datos de Maps.

Campos
parent

string

Es obligatorio. Es el proyecto principal que será propietario del conjunto de datos. Formato: projects/{$project}
dataset

Dataset

Es obligatorio. Es la versión del conjunto de datos que se creará.

Conjunto de datos

Es una representación de un conjunto de datos de la plataforma de mapas.

Campos
name

string

Nombre del recurso, projects/{project}/datasets/{dataset_id}
display_name

string

Nombre legible por humanos que se muestra en la IU de la consola .
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

Son los casos de uso especificados para este conjunto de datos.
status

Status

Solo salida. Es el estado de esta versión del conjunto de datos.
create_time

Timestamp

Solo salida. Fecha y hora en que se creó el conjunto de datos por primera vez.
update_time

Timestamp

Solo salida. Fecha y hora en que se actualizaron los metadatos del conjunto de datos por última vez.
version_create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó esta versión del conjunto de datos. (Ocurrió cuando se importaron datos al conjunto de datos).
version_description

string

Solo salida. Es la descripción de esta versión del conjunto de datos. Se proporciona cuando se importan datos al conjunto de datos.
Campo de unión data_source. Son los detalles sobre la fuente de los datos del conjunto de datos. Las direcciones (data_source) solo pueden ser una de las siguientes opciones:
local_file_source

LocalFileSource

Es una fuente de archivos locales para el conjunto de datos de una sola carga.
gcs_source

GcsSource

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

DeleteDatasetRequest

Es una solicitud para borrar un conjunto de datos.

Es el conjunto de datos que se borrará.

Campos
name

string

Es obligatorio. Formato: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

Solicita descargar el conjunto de datos.

Campos
name

string

Es el conjunto de datos que se recuperará. Formato: projects/${project}/datasets/${dataset_id}

DownloadDatasetResponse

Es la respuesta a la descarga del conjunto de datos.

FileFormat

Es el formato del archivo que se sube.

Enumeraciones
FILE_FORMAT_UNSPECIFIED Es un formato de archivo sin especificar.
FILE_FORMAT_GEOJSON Archivo GeoJSON.
FILE_FORMAT_KML Es un archivo KML.
FILE_FORMAT_CSV .CSV.

GcsSource

Son los detalles sobre la fuente de datos cuando se encuentra 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

Es el formato de archivo del objeto de Google Cloud Storage. Se usa principalmente para la validación.

GetDatasetRequest

Solicitud para obtener el conjunto de datos especificado.

Campos
name

string

Es obligatorio. Nombre del recurso: projects/{project}/datasets/{dataset_id}

ImportDatasetRequest

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

Campos
name

string

Es obligatorio. Nombre del recurso, projects/{project}/datasets/{dataset_id}
version_description

string

Es una descripción de los datos nuevos que se importan.
Campo de unión data_source. Son los detalles sobre la fuente de los datos del conjunto de datos. Las direcciones (data_source) solo pueden ser una de las siguientes opciones:
local_file_source

LocalFileSource

Es una fuente de archivos local para el conjunto de datos de una importación única.
gcs_source

GcsSource

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

ImportDatasetResponse

Es la respuesta que se obtiene cuando se importa una nueva versión del conjunto de datos.

Campos
name

string

Es obligatorio. Es el nombre del recurso de la versión del conjunto de datos recién creado, projects/{project}/datasets/{dataset_id}@{version_id}.

ListDatasetErrorsRequest

Solicitud para enumerar los errores detallados que pertenecen a un conjunto de datos.

Campos
name

string

Es obligatorio. Formato: projects/${project}/datasets/{dataset_id}
page_size

int32

Es la cantidad máxima de versiones que se devolverán por página. La configuración predeterminada es 10.
page_token

string

Es el token de página que se recibió de una llamada a ListDatasetErrors anterior. Proporciona esto para recuperar la página siguiente.

ListDatasetErrorsResponse

Es la respuesta de ListDatasetErrors. Devuelve una cadena repetida para los mensajes de error.

Campos
error_messages[]

string

Son los errores que pertenecen a un conjunto de datos.
next_page_token

string

Es 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.

ListDatasetsRequest

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

Campos
parent

string

Es obligatorio. Es el nombre del proyecto para el que se enumerarán todos los conjuntos de datos.
page_size

int32

Es la cantidad máxima de versiones que se devolverán por página. Si no se especifica (o se establece en cero), se devolverán todos los conjuntos de datos.
page_token

string

Es el token de página que se recibió de una llamada a ListDatasets anterior. Proporciona esto para recuperar la página siguiente.

ListDatasetsResponse

Es la respuesta para enumerar los conjuntos de datos del proyecto.

Campos
datasets[]

Dataset

Son todos los conjuntos de datos del proyecto.
next_page_token

string

Es 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

Son los detalles sobre la fuente de datos cuando se trata de un archivo local.

Campos
filename

string

Nombre de archivo y extensión del archivo subido
file_format

FileFormat

Es el formato del archivo que se está subiendo.

Estado

Es el estado de la versión del conjunto de datos.

Campos
state

State

Es una enumeración de estado.
error_message

string

Es el mensaje de error que indica el motivo de la falla. Está vacío si el conjunto de datos no se encuentra en un estado de error.

Estado

Es una lista de estados para la versión del conjunto de datos. Si se modifican los valores aquí, considera actualizar los métodos de utilidad de Status.

Enumeraciones
STATE_UNSPECIFIED No se estableció el estado de este conjunto de datos.
STATE_IMPORTING Se está importando la versión del conjunto de datos.
STATE_IMPORT_SUCCEEDED La versión del conjunto de datos se importó correctamente.
STATE_IMPORT_FAILED No se pudo importar la versión del conjunto de datos.
STATE_DELETING El conjunto de datos está en proceso de eliminación.
STATE_DELETION_FAILED Es el estado de error de eliminación. Este estado representa que no se pudo borrar el conjunto de datos. Se puede volver a intentar la eliminación.
STATE_PROCESSING Es el estado de procesamiento. Este estado representa la correlación y el procesamiento iniciales de los conjuntos de datos para obtener conjuntos de datos derivados.
STATE_PROCESSING_FAILED Es el estado de error en el procesamiento. Este estado indica que falló el procesamiento y que se pueden informar errores.
STATE_NEEDS_REVIEW Es el estado de la revisión de necesidades. Este estado representa que los datos están disponibles para publicarse y publicarse para el uso específico.
STATE_PUBLISHING Es el estado de publicación. Este estado indica que la publicación está en curso.
STATE_PUBLISHING_FAILED Son los estados de error de publicación. Este estado indica que falló la publicación. Es posible que se vuelva a intentar la publicación.
STATE_COMPLETED Es el estado completado. Este estado representa que el conjunto de datos está disponible para su uso específico.

UpdateDatasetMetadataRequest

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

Campos
dataset

Dataset

Es obligatorio. Es el conjunto de datos que se actualizará. El nombre del conjunto de datos se usa para identificar el conjunto de datos que se actualizará. El nombre tiene el formato projects/{project}/datasets/{dataset_id}.
update_mask

FieldMask

Es la lista de campos que se actualizarán. Admite el valor "*" para el reemplazo completo.

Uso

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

Enumeraciones
USAGE_UNSPECIFIED No se configuró el uso de este conjunto de datos.
USAGE_DATA_DRIVEN_STYLING Este conjunto de datos se usará para el diseño basado en datos.