Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: [mapsplatformdatasets] make v1 stable/default version #5390

Merged
merged 12 commits into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"product_documentation": "",
"client_documentation": "https://cloud.google.com/nodejs/docs/reference/mapsplatformdatasets/latest",
"issue_tracker": "https://github.com/googleapis/google-cloud-node/issues",
"release_level": "preview",
"release_level": "stable",
"language": "nodejs",
"repo": "googleapis/google-cloud-node",
"distribution_name": "@google-cloud/mapsplatformdatasets",
"api_id": "mapsplatformdatasets.googleapis.com",
"default_version": "v1alpha",
"default_version": "v1",
"requires_billing": true,
"library_type": "GAPIC_AUTO",
"api_shortname": "mapsplatformdatasets"
Expand Down
9 changes: 5 additions & 4 deletions packages/google-maps-mapsplatformdatasets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# [Maps Platform Datasets API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-mapsplatformdatasets)

[![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
[![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
[![npm version](https://img.shields.io/npm/v/@googlemaps/maps-platform-datasets.svg)](https://www.npmjs.org/package/@googlemaps/maps-platform-datasets)


Expand Down Expand Up @@ -159,13 +159,14 @@ This library follows [Semantic Versioning](http://semver.org/).



This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways
unless absolutely necessary (e.g. because of critical security issues) or with
an extensive deprecation period. Issues and requests against **stable** libraries
are addressed with the highest priority.




This library is considered to be in **preview**. This means it is still a
work-in-progress and under active development. Any release is subject to
backwards-incompatible changes at any time.


More Information: [Google Cloud Platform Launch Stages][launch_stages]
Expand Down
2 changes: 1 addition & 1 deletion packages/google-maps-mapsplatformdatasets/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@
"engines": {
"node": ">=14.0.0"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ syntax = "proto3";

package google.maps.mapsplatformdatasets.v1;

import "google/api/field_behavior.proto";
import "google/api/resource.proto";

option csharp_namespace = "Google.Maps.MapsPlatformDatasets.V1";
option go_package = "cloud.google.com/go/maps/mapsplatformdatasets/apiv1/mapsplatformdatasetspb;mapsplatformdatasetspb";
option java_multiple_files = true;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,23 @@ option java_package = "com.google.maps.mapsplatformdatasets.v1";
option objc_class_prefix = "MDV1";
option php_namespace = "Google\\Maps\\MapsPlatformDatasets\\V1";

// A representation of a Maps Dataset resource.
// A representation of a dataset resource.
message Dataset {
option (google.api.resource) = {
type: "mapsplatformdatasets.googleapis.com/Dataset"
pattern: "projects/{project}/datasets/{dataset}"
};

// Resource name,
// projects/{project}/datasets/{dataset_id}
// Resource name.
// Format: projects/{project}/datasets/{dataset_id}
string name = 1;

// Human readable name, shown in the console UI .
// Human readable name, shown in the console UI.
//
// Must be unique within a project.
string display_name = 2;

// A description of this dataset .
// A description of this dataset.
string description = 3;

// The version ID of the dataset.
Expand Down Expand Up @@ -72,7 +74,7 @@ message Dataset {
google.protobuf.Timestamp update_time = 9
[(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. Time when the data was uploaded.
// Output only. Time when this version was created.
google.protobuf.Timestamp version_create_time = 10
[(google.api.field_behavior) = OUTPUT_ONLY];

Expand Down Expand Up @@ -118,12 +120,12 @@ message Status {
// progress.
STATE_PUBLISHING = 9;

// The publishing failed states. This state represents that the
// publishing failed. Publishing may be retried.
// The publishing failed states. This state represents that the publishing
// failed. Publishing may be retried.
STATE_PUBLISHING_FAILED = 10;

// The completed state. This state represents the dataset being
// available for its specific usage.
// The completed state. This state represents the dataset being available
// for its specific usage.
STATE_COMPLETED = 11;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ package google.maps.mapsplatformdatasets.v1;

import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/maps/mapsplatformdatasets/v1/data_source.proto";
import "google/maps/mapsplatformdatasets/v1/dataset.proto";
import "google/protobuf/field_mask.proto";

Expand All @@ -33,7 +32,7 @@ option php_namespace = "Google\\Maps\\MapsPlatformDatasets\\V1";
// Request to create a maps dataset.
message CreateDatasetRequest {
// Required. Parent project that will own the dataset.
// Format: projects/{$project}
// Format: projects/{project}
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -47,19 +46,27 @@ message CreateDatasetRequest {

// Request to update the metadata fields of the dataset.
message UpdateDatasetMetadataRequest {
// Required. The dataset to update. The dataset's name is used to identify the
// dataset to be updated. The name has the format:
// projects/{project}/datasets/{dataset_id}
// Required. Resource name of the dataset to update.
// Format: projects/{project}/datasets/{dataset_id}
Dataset dataset = 1 [(google.api.field_behavior) = REQUIRED];

// The list of fields to be updated. Support the value "*" for full
// replacement.
// The list of fields to be updated.
//
// The value "*" is used for full replacement (default).
google.protobuf.FieldMask update_mask = 2;
}

// Request to get the specified dataset.
message GetDatasetRequest {
// Required. Resource name. projects/{project}/datasets/{dataset_id}
// Required. Resource name.
// Format: projects/{project}/datasets/{dataset_id}
//
//
// Can also fetch some special versions by appending "@" and a tag.
// Format: projects/{project}/datasets/{dataset_id}@{tag}
//
// Tag "active": The info of the latest completed version will be included,
// and NOT_FOUND if the dataset does not have one.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -71,37 +78,50 @@ message GetDatasetRequest {
// Request to list datasets for the project.
message ListDatasetsRequest {
// Required. The name of the project to list all the datasets for.
// Format: projects/{project}
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "cloudresourcemanager.googleapis.com/Project"
}
];

// The maximum number of versions to return per page.
// The maximum number of datasets to return per page.
//
// If unspecified (or zero), all datasets will be returned.
int32 page_size = 2;

// The page token, received from a previous ListDatasets call.
// Provide this to retrieve the subsequent page.
string page_token = 3;

// The tag that specifies the desired version for each dataset.
//
// Note that when pagination is also specified, some filtering can happen
// after pagination, which may cause the response to contain fewer datasets
// than the page size, even if it's not the last page.
//
// Tag "active": Each dataset in the response will include the info of its
// latest completed version, and the dataset will be skipped if it does not
// have one.
string tag = 4;
}

// Response to list datasets for the project.
// Response object of ListDatasets.
message ListDatasetsResponse {
// All the datasets for the project.
repeated Dataset datasets = 1;

// A token that can be sent as `page_token` to retrieve the next page.
//
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
}

// Request to delete a dataset.
//
// The dataset to be deleted.
message DeleteDatasetRequest {
// Required. Format: projects/${project}/datasets/{dataset_id}
// Required. The name of the dataset to delete.
// Format: projects/{project}/datasets/{dataset_id}
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ service MapsPlatformDatasets {
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";

// Create a new dataset for the specified project.
// Creates a new dataset for the specified project.
rpc CreateDataset(CreateDatasetRequest) returns (Dataset) {
option (google.api.http) = {
post: "/v1/{parent=projects/*}/datasets"
Expand All @@ -46,7 +46,7 @@ service MapsPlatformDatasets {
option (google.api.method_signature) = "parent,dataset";
}

// Update the metadata for the dataset.
// Updates the metadata for the dataset.
rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset) {
option (google.api.http) = {
patch: "/v1/{dataset.name=projects/*/datasets/*}"
Expand All @@ -55,23 +55,23 @@ service MapsPlatformDatasets {
option (google.api.method_signature) = "dataset,update_mask";
}

// Get the dataset.
// Gets the dataset.
rpc GetDataset(GetDatasetRequest) returns (Dataset) {
option (google.api.http) = {
get: "/v1/{name=projects/*/datasets/*}"
};
option (google.api.method_signature) = "name";
}

// List all the datasets for the specified project.
// Lists all the datasets for the specified project.
rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*}/datasets"
};
option (google.api.method_signature) = "parent";
}

// Delete the specified dataset .
// Deletes the specified dataset.
rpc DeleteDataset(DeleteDatasetRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/datasets/*}"
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions packages/google-maps-mapsplatformdatasets/protos/protos.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ function main(parent, dataset) {
*/
/**
* Required. Parent project that will own the dataset.
* Format: projects/{$project}
* Format: projects/{project}
*/
// const parent = 'abc123'
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ function main(name) {
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Format: projects/${project}/datasets/{dataset_id}
* Required. The name of the dataset to delete.
* Format: projects/{project}/datasets/{dataset_id}
*/
// const name = 'abc123'

Expand Down
Loading
Loading