1// Copyright 2022 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.maps.mapsplatformdatasets.v1alpha; 18 19import "google/api/field_behavior.proto"; 20import "google/api/resource.proto"; 21import "google/maps/mapsplatformdatasets/v1alpha/data_source.proto"; 22import "google/protobuf/timestamp.proto"; 23 24option csharp_namespace = "Google.Maps.MapsPlatformDatasets.V1Alpha"; 25option go_package = "cloud.google.com/go/maps/mapsplatformdatasets/apiv1alpha/mapsplatformdatasetspb;mapsplatformdatasetspb"; 26option java_multiple_files = true; 27option java_outer_classname = "DatasetProto"; 28option java_package = "com.google.maps.mapsplatformdatasets.v1alpha"; 29option php_namespace = "Google\\Maps\\MapsPlatformDatasets\\V1alpha"; 30 31// A representation of a maps platform dataset. 32message Dataset { 33 option (google.api.resource) = { 34 type: "mapsplatformdatasets.googleapis.com/Dataset" 35 pattern: "projects/{project}/datasets/{dataset}" 36 }; 37 38 // Resource name, 39 // projects/{project}/datasets/{dataset_id} 40 string name = 1; 41 42 // Human readable name, shown in the console UI. Set by customer. 43 string display_name = 2; 44 45 // A description of this dataset; set by the customer. 46 string description = 3; 47 48 // The version of the dataset. 49 string version_id = 4; 50 51 // Specified use case(s) for this dataset. 52 repeated Usage usage = 5; 53 54 // Details about the source of the data for the dataset. 55 oneof data_source { 56 // A local file source for the dataset for a single upload. 57 LocalFileSource local_file_source = 6; 58 59 // A Google Cloud Storage file source for the dataset for a single upload. 60 GcsSource gcs_source = 7; 61 } 62 63 // The status of the import of the latest dataset version. 64 State status = 12; 65 66 // Output only. Time when the dataset was first created. 67 google.protobuf.Timestamp create_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; 68 69 // Output only. Time when the dataset metadata was last updated. 70 google.protobuf.Timestamp update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; 71 72 // Output only. Time when this version of dataset was created. (It happened when importing 73 // data to the dataset) 74 google.protobuf.Timestamp version_create_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; 75 76 // Output only. The description for this version of dataset. It is provided when importing 77 // data to the dataset. 78 string version_description = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; 79} 80 81// Usage specifies where the data is intended to be used to inform how to 82// process the data. 83enum Usage { 84 // The usage of this dataset is not set. 85 USAGE_UNSPECIFIED = 0; 86 87 // This dataset will be used for data driven styling. 88 USAGE_DATA_DRIVEN_STYLING = 1; 89 90 // This dataset will be used for area affordances in routing. 91 USAGE_AREA_AFFORDANCES = 2; 92 93 // This dataset will be used for assisted driving in routing. 94 USAGE_ASSISTED_DRIVING = 3; 95} 96 97// State specifies the status of the import of the latest dataset version. 98enum State { 99 // The state of this dataset is not set. 100 STATE_UNSPECIFIED = 0; 101 102 // The dataset version is getting imported. 103 STATE_IMPORTING = 1; 104 105 // The dataset version succeeded in getting imported. 106 STATE_IMPORT_SUCCEEDED = 2; 107 108 // The dataset version failed to get imported. 109 STATE_IMPORT_FAILED = 3; 110} 111