Package google.maps.mapsplatformdatasets.v1

Índice

MapsPlatformDatasets

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

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

Crea un conjunto de datos nuevo para el proyecto especificado.

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

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

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

GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Obtén el conjunto de datos.

Permisos 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 del conjunto de datos.

Permisos 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)

Enumera todos los conjuntos de datos del proyecto especificado.

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

Permisos 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á el 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 conjunto de datos de Maps Platform.

Campos
name

string

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

display_name

string

Nombre legible que se muestra en la IU de la consola .

description

string

Es una descripción de este conjunto de datos .

version_id

string

El ID de versión del conjunto de datos.

usage[]

Usage

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. Hora en la que se creó el conjunto de datos por primera vez.

update_time

Timestamp

Solo salida. Hora a 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 del conjunto de datos. (Ocurrió cuando se importaban datos al conjunto de datos)

version_description

string

Solo salida. 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. 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

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

gcs_source

GcsSource

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

DeleteDatasetRequest

Solicitud para borrar un conjunto de datos.

El conjunto de datos que se borrará.

Campos
name

string

Obligatorio. Format: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

Solicita descargar el conjunto de datos.

Campos
name

string

El conjunto de datos que se recuperará. Format: projects/${project}/datasets/${dataset_id}

DownloadDatasetResponse

Respuesta de la descarga del conjunto de datos.

FileFormat

El formato del archivo que se sube.

Enumeradores
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 se encuentra en Google Cloud Storage.

Campos
input_uri

string

URI de datos de origen. Por ejemplo, gs://my_bucket/my_object.

file_format

FileFormat

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

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

ImportDatasetRequest

Solicita importar una versión nueva del conjunto de datos.

Campos
name

string

Obligatorio. Nombre del recurso, 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 del 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

Respuesta de la importación de una versión nueva del conjunto de datos.

Campos
name

string

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

ListDatasetsRequest

Solicitud para enumerar los conjuntos de datos del proyecto.

Campos
parent

string

Obligatorio. El nombre del proyecto para el que se enumerarán todos los conjuntos de datos.

page_size

int32

La cantidad máxima de versiones que se muestran por página. Si no se especifica (o si no se especifica ningún valor), se mostrarán todos los conjuntos de datos.

page_token

string

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

ListDatasetsResponse

Respuesta para enumerar conjuntos de datos del proyecto.

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

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

Campos
filename

string

Es el nombre y la extensión del archivo subido.

file_format

FileFormat

El formato del archivo que se sube.

Estado

Estado de la versión del conjunto de datos.

Campos
state

State

Es una enumeración de estado para el estado.

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.

Enumeradores
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 se importaron a un conjunto de datos correctamente.
STATE_IMPORT_FAILED No se pudieron importar los datos a un conjunto de datos.
STATE_DELETING Se está borrando el conjunto de datos.
STATE_DELETION_FAILED Estado de error de eliminación. Este estado representa que no se pudo borrar el conjunto de datos. Puedes volver a intentar la eliminación.
STATE_PROCESSING Se están procesando los datos.
STATE_PROCESSING_FAILED Estado de error de procesamiento. Este estado indica que el procesamiento falló y puede informar errores.
STATE_NEEDS_REVIEW Este estado no se utiliza actualmente.
STATE_PUBLISHING Es el estado de publicación. Este estado indica que la publicación está en curso.
STATE_PUBLISHING_FAILED Los estados de publicación con errores Este estado indica que la publicación falló. Es posible que se vuelva a intentar la publicación.
STATE_COMPLETED Es el estado completo. Este estado representa el conjunto de datos disponible para su uso específico.

UpdateDatasetMetadataRequest

Solicita actualizar los campos de metadatos del conjunto de datos.

Campos
dataset

Dataset

Obligatorio. 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 siguiente formato: projects/{project}/datasets/{dataset_id}

update_mask

FieldMask

La lista de campos que se actualizará. Admite el valor "*" para un reemplazo completo.

Uso

El uso especifica dónde se deben usar los datos para informar cómo se deben procesar.

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