1// Copyright 2023 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.v1; 18 19import "google/api/field_behavior.proto"; 20import "google/api/resource.proto"; 21import "google/maps/mapsplatformdatasets/v1/data_source.proto"; 22import "google/protobuf/timestamp.proto"; 23 24option csharp_namespace = "Google.Maps.MapsPlatformDatasets.V1"; 25option go_package = "cloud.google.com/go/maps/mapsplatformdatasets/apiv1/mapsplatformdatasetspb;mapsplatformdatasetspb"; 26option java_multiple_files = true; 27option java_outer_classname = "DatasetProto"; 28option java_package = "com.google.maps.mapsplatformdatasets.v1"; 29option objc_class_prefix = "MDV1"; 30option php_namespace = "Google\\Maps\\MapsPlatformDatasets\\V1"; 31 32// A representation of a Maps Dataset resource. 33message Dataset { 34 option (google.api.resource) = { 35 type: "mapsplatformdatasets.googleapis.com/Dataset" 36 pattern: "projects/{project}/datasets/{dataset}" 37 }; 38 39 // Resource name, 40 // projects/{project}/datasets/{dataset_id} 41 string name = 1; 42 43 // Human readable name, shown in the console UI . 44 string display_name = 2; 45 46 // A description of this dataset . 47 string description = 3; 48 49 // The version ID of the dataset. 50 string version_id = 4; 51 52 // Specified use case for this dataset. 53 repeated Usage usage = 5; 54 55 // Details about the source of the data for the dataset. 56 oneof data_source { 57 // A local file source for the dataset for a single upload. 58 LocalFileSource local_file_source = 6; 59 60 // A Google Cloud Storage file source for the dataset for a single upload. 61 GcsSource gcs_source = 7; 62 } 63 64 // Output only. The status of this dataset version. 65 Status status = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; 66 67 // Output only. Time when the dataset was first created. 68 google.protobuf.Timestamp create_time = 8 69 [(google.api.field_behavior) = OUTPUT_ONLY]; 70 71 // Output only. Time when the dataset metadata was last updated. 72 google.protobuf.Timestamp update_time = 9 73 [(google.api.field_behavior) = OUTPUT_ONLY]; 74 75 // Output only. Time when the data was uploaded. 76 google.protobuf.Timestamp version_create_time = 10 77 [(google.api.field_behavior) = OUTPUT_ONLY]; 78 79 // Output only. The description for this version of dataset. It is provided 80 // when importing data to the dataset. 81 string version_description = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; 82} 83 84// Status of the dataset. 85message Status { 86 // A list of states for the dataset. 87 enum State { 88 // The state of this dataset is not set. 89 STATE_UNSPECIFIED = 0; 90 91 // Data is being imported to a dataset. 92 STATE_IMPORTING = 1; 93 94 // Importing data to a dataset succeeded. 95 STATE_IMPORT_SUCCEEDED = 2; 96 97 // Importing data to a dataset failed. 98 STATE_IMPORT_FAILED = 3; 99 100 // The dataset is in the process of getting deleted. 101 STATE_DELETING = 4; 102 103 // The deletion failed state. This state represents that dataset deletion 104 // has failed. Deletion may be retried. 105 STATE_DELETION_FAILED = 5; 106 107 // Data is being processed. 108 STATE_PROCESSING = 6; 109 110 // The processing failed state. This state represents that processing has 111 // failed and may report errors. 112 STATE_PROCESSING_FAILED = 7; 113 114 // This state is currently not used. 115 STATE_NEEDS_REVIEW = 8; 116 117 // The publishing state. This state represents the publishing is in 118 // progress. 119 STATE_PUBLISHING = 9; 120 121 // The publishing failed states. This state represents that the 122 // publishing failed. Publishing may be retried. 123 STATE_PUBLISHING_FAILED = 10; 124 125 // The completed state. This state represents the dataset being 126 // available for its specific usage. 127 STATE_COMPLETED = 11; 128 } 129 130 // State enum for status. 131 State state = 1; 132 133 // Error message indicating reason of failure. It is empty if the datasets is 134 // not in a failed state. 135 string error_message = 2; 136} 137 138// Usage specifies where the data is intended to be used to inform how to 139// process the data. 140enum Usage { 141 // The usage of this dataset is not set. 142 USAGE_UNSPECIFIED = 0; 143 144 // This dataset will be used for data driven styling. 145 USAGE_DATA_DRIVEN_STYLING = 1; 146} 147