Package google.maps.mapsplatformdatasets.v1alpha

شاخص

MapsPlatformDatasetsV1Alpha

تعریف سرویس برای Maps Platform Datasets API.

CreateDataset

rpc CreateDataset( CreateDatasetRequest ) returns ( Dataset )

یک مجموعه داده جدید برای پروژه مشخص شده ایجاد کنید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع parent نیاز دارد:

  • mapsplatformdatasets.datasets.create

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

DeleteDataset

rpc DeleteDataset( DeleteDatasetRequest ) returns ( Empty )

مجموعه داده مشخص شده را حذف کنید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع name نیاز دارد:

  • mapsplatformdatasets.datasets.delete

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

مجموعه داده را دانلود کنید

rpc DownloadDataset( DownloadDatasetRequest ) returns ( DownloadDatasetResponse )

یک مجموعه داده را دانلود می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع name نیاز دارد:

  • mapsplatformdatasets.datasets.export

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

GetDataset

rpc GetDataset( GetDatasetRequest ) returns ( Dataset )

مجموعه داده را دریافت کنید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع name نیاز دارد:

  • mapsplatformdatasets.datasets.get

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

ImportDataset

rpc ImportDataset( ImportDatasetRequest ) returns ( ImportDatasetResponse )

نسخه جدیدی از داده ها را برای مجموعه داده وارد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع name نیاز دارد:

  • mapsplatformdatasets.datasets.import

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

ListDatasetErrors

rpc ListDatasetErrors( ListDatasetErrorsRequest ) returns ( ListDatasetErrorsResponse )

تمام خطاهای یک مجموعه داده را دریافت کنید (در حال حاضر این فقط برای موارد استفاده از DDS کار می کند).

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع name نیاز دارد:

  • mapsplatformdatasets.datasets.get

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

ListDatasets

rpc ListDatasets( ListDatasetsRequest ) returns ( ListDatasetsResponse )

تمام مجموعه داده ها را برای پروژه مشخص شده فهرست کنید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع parent نیاز دارد:

  • mapsplatformdatasets.datasets.list

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

UpdateDatasetMetadata

rpc UpdateDatasetMetadata( UpdateDatasetMetadataRequest ) returns ( Dataset )

ابرداده را برای مجموعه داده به روز کنید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع name نیاز دارد:

  • mapsplatformdatasets.datasets.update

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

CreateDatasetRequest

درخواست ایجاد مجموعه داده نقشه ها.

فیلدها
parent

string

مورد نیاز. پروژه والد که مجموعه داده را در اختیار خواهد داشت. قالب: پروژه ها/{$project}

dataset

Dataset

مورد نیاز. نسخه مجموعه داده برای ایجاد.

مجموعه داده

نمایشی از مجموعه داده های پلت فرم نقشه ها.

فیلدها
name

string

نام منبع، پروژه‌ها/{project}/datasets/{dataset_id}

display_name

string

نام قابل خواندن توسط انسان، نشان داده شده در رابط کاربری کنسول .

description

string

شرح این مجموعه داده

version_id

string

شناسه نسخه مجموعه داده.

usage[]

Usage

مورد(های) استفاده مشخص شده برای این مجموعه داده.

status

Status

فقط خروجی وضعیت این نسخه مجموعه داده.

create_time

Timestamp

فقط خروجی زمانی که مجموعه داده برای اولین بار ایجاد شد.

update_time

Timestamp

فقط خروجی زمانی که ابرداده مجموعه داده آخرین بار به روز شد.

version_create_time

Timestamp

فقط خروجی زمانی که این نسخه از مجموعه داده ایجاد شد. (این اتفاق هنگام وارد کردن داده به مجموعه داده رخ داد)

version_description

string

فقط خروجی توضیحات این نسخه از مجموعه داده. هنگام وارد کردن داده ها به مجموعه داده ارائه می شود.

data_source فیلد اتحادیه . جزئیات مربوط به منبع داده برای مجموعه داده. data_source تنها می تواند یکی از موارد زیر باشد:
local_file_source

LocalFileSource

یک منبع فایل محلی برای مجموعه داده برای یک بارگذاری.

gcs_source

GcsSource

منبع فایل Google Cloud Storage برای مجموعه داده برای یک بار آپلود.

DeleteDatasetRequest

درخواست حذف مجموعه داده

مجموعه داده حذف شود.

فیلدها
name

string

مورد نیاز. قالب: پروژه‌ها/${project}/datasets/{dataset_id}

دانلودDatasetRequest

درخواست دانلود مجموعه داده.

فیلدها
name

string

مجموعه داده برای واکشی. قالب: پروژه‌ها/${project}/datasets/${dataset_id}

DownloadDatasetResponse

پاسخ از دانلود مجموعه داده.

فرمت فایل

فرمت فایل در حال آپلود

Enums
FILE_FORMAT_UNSPECIFIED فرمت فایل نامشخص
FILE_FORMAT_GEOJSON فایل GeoJson.
FILE_FORMAT_KML فایل KML.
FILE_FORMAT_CSV فایل CSV.

منبع Gcs

جزئیات مربوط به منبع داده زمانی که در Google Cloud Storage باشد.

فیلدها
input_uri

string

URI داده منبع. به عنوان مثال، gs://my_bucket/my_object .

file_format

FileFormat

قالب فایل شی Google Cloud Storage. این عمدتا برای اعتبار سنجی استفاده می شود.

GetDatasetRequest

درخواست دریافت مجموعه داده مشخص شده

فیلدها
name

string

مورد نیاز. نام منبع projects/{project}/datasets/{dataset_id}

ImportDatasetRequest

درخواست وارد کردن نسخه جدیدی از مجموعه داده.

فیلدها
name

string

مورد نیاز. نام منبع، پروژه‌ها/{project}/datasets/{dataset_id}

version_description

string

شرح داده های جدید وارد شده

data_source فیلد اتحادیه . جزئیات مربوط به منبع داده برای مجموعه داده. data_source تنها می تواند یکی از موارد زیر باشد:
local_file_source

LocalFileSource

یک منبع فایل محلی برای مجموعه داده برای یک بار وارد کردن.

gcs_source

GcsSource

منبع فایل Google Cloud Storage برای مجموعه داده برای یک بار وارد کردن.

ImportDatasetResponse

پاسخ از وارد کردن نسخه جدیدی از مجموعه داده.

فیلدها
name

string

مورد نیاز. نام منبع نسخه مجموعه داده جدید ایجاد شده، projects/{project}/datasets/{dataset_id}@{version_id}

ListDatasetErrorsRequest

درخواست فهرست کردن خطاهای دقیق متعلق به یک مجموعه داده.

فیلدها
name

string

مورد نیاز. قالب: پروژه‌ها/${project}/datasets/{dataset_id}

page_size

int32

حداکثر تعداد نسخه برای بازگشت در هر صفحه. پیش فرض 10 است.

page_token

string

نشانه صفحه، دریافت شده از تماس قبلی ListDatasetErrors. این را برای بازیابی صفحه بعدی ارائه کنید.

ListDatasetErrorsResponse

پاسخ ListDatasetErrors. یک رشته مکرر برای پیام های خطا برمی گرداند.

فیلدها
error_messages[]

string

خطاهای مربوط به یک مجموعه داده

next_page_token

string

نشانه ای که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد.

ListDatasetsRequest

درخواست فهرست کردن مجموعه داده‌های پروژه.

فیلدها
parent

string

مورد نیاز. نام پروژه برای فهرست کردن همه مجموعه داده ها.

page_size

int32

حداکثر تعداد نسخه برای بازگشت در هر صفحه. اگر نامشخص (یا صفر) باشد، تمام مجموعه داده ها برگردانده می شوند.

page_token

string

نشانه صفحه، دریافت شده از تماس قبلی ListDatasets. این را برای بازیابی صفحه بعدی ارائه کنید.

ListDatasetsResponse

پاسخ به مجموعه داده های لیست برای پروژه.

فیلدها
datasets[]

Dataset

تمام مجموعه داده های پروژه

next_page_token

string

نشانه ای که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد.

LocalFileSource

جزئیات مربوط به منبع داده زمانی که یک فایل محلی است.

فیلدها
filename

string

نام فایل و پسوند فایل آپلود شده.

file_format

FileFormat

فرمت فایلی که در حال آپلود است.

وضعیت

وضعیت نسخه مجموعه داده.

فیلدها
state

State

شماره را برای وضعیت اعلام کنید.

error_message

string

پیام خطایی که دلیل خرابی را نشان می دهد. اگر مجموعه داده ها در وضعیت ناموفق نباشند، خالی است.

ایالت

فهرستی از حالت ها برای نسخه مجموعه داده. اگر مقادیر در اینجا تغییر می کنند، روش های ابزار Status را به روز کنید.

Enums
STATE_UNSPECIFIED وضعیت این مجموعه داده تنظیم نشده است.
STATE_IMPORTING نسخه مجموعه داده در حال وارد شدن است.
STATE_IMPORT_SUCCEEDED نسخه مجموعه داده موفق شد وارد شود.
STATE_IMPORT_FAILED نسخه مجموعه داده وارد نشد.
STATE_DELETING مجموعه داده در حال حذف شدن است.
STATE_DELETION_FAILED وضعیت حذف ناموفق بود. این حالت نشان می دهد که حذف مجموعه داده ها ناموفق بوده است. حذف ممکن است دوباره امتحان شود.
STATE_PROCESSING وضعیت پردازش این حالت نشان دهنده تطابق اولیه و پردازش مجموعه داده ها با مجموعه داده های مشتق شده است.
STATE_PROCESSING_FAILED وضعیت پردازش ناموفق بود. این حالت نشان می دهد که پردازش ناموفق بوده و ممکن است خطاها را گزارش کند.
STATE_NEEDS_REVIEW وضعیت بررسی نیازها این حالت نشان می‌دهد که داده‌ها برای انتشار و ارائه برای استفاده خاص در دسترس هستند.
STATE_PUBLISHING وضعیت انتشارات این وضعیت نشان می دهد که انتشار در حال انجام است.
STATE_PUBLISHING_FAILED انتشارات شکست خورده است. این حالت نشان می دهد که انتشار شکست خورده است. انتشار ممکن است دوباره امتحان شود.
STATE_COMPLETED حالت تکمیل شده این حالت نشان دهنده موجود بودن مجموعه داده برای استفاده خاص آن است.

UpdateDatasetMetadataRequest

درخواست به روز رسانی فیلدهای فراداده مجموعه داده.

فیلدها
dataset

Dataset

مورد نیاز. مجموعه داده برای به روز رسانی نام مجموعه داده برای شناسایی مجموعه داده ای که قرار است به روز شود استفاده می شود. این نام دارای قالب است: projects/{project}/datasets/{dataset_id}

update_mask

FieldMask

لیست فیلدهایی که باید به روز شوند. از مقدار "*" برای جایگزینی کامل پشتیبانی کنید.

استفاده

Usage مشخص می‌کند که داده‌ها در کجا قرار است برای اطلاع از نحوه پردازش داده‌ها استفاده شوند.

Enums
USAGE_UNSPECIFIED استفاده از این مجموعه داده تنظیم نشده است.
USAGE_DATA_DRIVEN_STYLING این مجموعه داده برای یک استایل مبتنی بر داده استفاده خواهد شد.