feat: check status of long running operation by its name (#65)

For each client method returning a long running operation, a separate method to check its status is added. Added methods: `checkCreateGameServerClusterProgress`, `checkCreateGameServerConfigProgress`, `checkCreateGameServerDeploymentProgress`, `checkCreateRealmProgress`, `checkDeleteGameServerClusterProgress`, `checkDeleteGameServerConfigProgress`, `checkDeleteGameServerDeploymentProgress`, `checkDeleteRealmProgress`, `checkUpdateGameServerClusterProgress`, `checkUpdateGameServerDeploymentProgress`, `checkUpdateGameServerDeploymentRolloutProgress`, `checkUpdateRealmProgress`.
googleapis · May 6, 2020 · 3900875 · 3900875
1 parent dbccfc4
commit 3900875
Show file tree

Hide file tree

Showing 21 changed files with 1,194 additions and 186 deletions.
diff --git a/README.md b/README.md
@@ -99,9 +99,13 @@ has instructions for running the samples.
 
 | Sample                      | Source Code                       | Try it |
 | --------------------------- | --------------------------------- | ------ |
+| Create_cluster | [source code](https://github.com/googleapis/nodejs-game-servers/blob/master/samples/create_cluster.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-game-servers&page=editor&open_in_editor=samples/create_cluster.js,samples/README.md) |
 | Create_realm | [source code](https://github.com/googleapis/nodejs-game-servers/blob/master/samples/create_realm.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-game-servers&page=editor&open_in_editor=samples/create_realm.js,samples/README.md) |
+| Delete_cluster | [source code](https://github.com/googleapis/nodejs-game-servers/blob/master/samples/delete_cluster.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-game-servers&page=editor&open_in_editor=samples/delete_cluster.js,samples/README.md) |
 | Delete_realm | [source code](https://github.com/googleapis/nodejs-game-servers/blob/master/samples/delete_realm.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-game-servers&page=editor&open_in_editor=samples/delete_realm.js,samples/README.md) |
+| Get_cluster | [source code](https://github.com/googleapis/nodejs-game-servers/blob/master/samples/get_cluster.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-game-servers&page=editor&open_in_editor=samples/get_cluster.js,samples/README.md) |
 | Get_realm | [source code](https://github.com/googleapis/nodejs-game-servers/blob/master/samples/get_realm.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-game-servers&page=editor&open_in_editor=samples/get_realm.js,samples/README.md) |
+| List_clusters | [source code](https://github.com/googleapis/nodejs-game-servers/blob/master/samples/list_clusters.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-game-servers&page=editor&open_in_editor=samples/list_clusters.js,samples/README.md) |
 | List_realms | [source code](https://github.com/googleapis/nodejs-game-servers/blob/master/samples/list_realms.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-game-servers&page=editor&open_in_editor=samples/list_realms.js,samples/README.md) |
 | Create Game Server Realm | [source code](https://github.com/googleapis/nodejs-game-servers/blob/master/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-game-servers&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
 

diff --git a/protos/google/cloud/gaming/v1beta/common.proto b/protos/google/cloud/gaming/v1beta/common.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 Google LLC.
+// Copyright 2020 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,7 +11,6 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-//
 
 syntax = "proto3";
 

diff --git a/protos/google/cloud/gaming/v1beta/game_server_clusters.proto b/protos/google/cloud/gaming/v1beta/game_server_clusters.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 Google LLC.
+// Copyright 2020 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,7 +11,6 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-//
 
 syntax = "proto3";
 
@@ -25,6 +24,7 @@ import "google/protobuf/timestamp.proto";
 import "google/api/annotations.proto";
 
 option go_package = "google.golang.org/genproto/googleapis/cloud/gaming/v1beta;gaming";
+
 option java_multiple_files = true;
 option java_package = "com.google.cloud.gaming.v1beta";
 
@@ -35,7 +35,7 @@ message ListGameServerClustersRequest {
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
-      type: "gameservices.googleapis.com/GameServerCluster"
+      child_type: "gameservices.googleapis.com/GameServerCluster"
     }
   ];
 
@@ -90,7 +90,7 @@ message CreateGameServerClusterRequest {
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
-      type: "gameservices.googleapis.com/GameServerCluster"
+      child_type: "gameservices.googleapis.com/GameServerCluster"
     }
   ];
 
@@ -105,7 +105,12 @@ message CreateGameServerClusterRequest {
 message PreviewCreateGameServerClusterRequest {
   // Required. The parent resource name. Uses the form:
   // `projects/{project}/locations/{location}/realms/{realm}`.
-  string parent = 1 [(google.api.field_behavior) = REQUIRED];
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "gameservices.googleapis.com/GameServerCluster"
+    }
+  ];
 
   // Required. The ID of the Game Server Cluster resource to be created.
   string game_server_cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
@@ -143,7 +148,12 @@ message DeleteGameServerClusterRequest {
 message PreviewDeleteGameServerClusterRequest {
   // Required. The name of the Game Server Cluster to delete. Uses the form:
   // `projects/{project}/locations/{location}/gameServerClusters/{cluster}`.
-  string name = 1 [(google.api.field_behavior) = REQUIRED];
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "gameservices.googleapis.com/GameServerCluster"
+    }
+  ];
 
   // Optional. The target timestamp to compute the preview.
   google.protobuf.Timestamp preview_time = 2 [(google.api.field_behavior) = OPTIONAL];

diff --git a/protos/google/cloud/gaming/v1beta/game_server_clusters_service.proto b/protos/google/cloud/gaming/v1beta/game_server_clusters_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 Google LLC.
+// Copyright 2020 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,7 +11,6 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-//
 
 syntax = "proto3";
 
@@ -23,6 +22,7 @@ import "google/cloud/gaming/v1beta/game_server_clusters.proto";
 import "google/longrunning/operations.proto";
 
 option go_package = "google.golang.org/genproto/googleapis/cloud/gaming/v1beta;gaming";
+
 option java_multiple_files = true;
 option java_package = "com.google.cloud.gaming.v1beta";
 

diff --git a/protos/google/cloud/gaming/v1beta/game_server_configs.proto b/protos/google/cloud/gaming/v1beta/game_server_configs.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 Google LLC.
+// Copyright 2020 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,7 +11,6 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-//
 
 syntax = "proto3";
 
@@ -24,6 +23,7 @@ import "google/protobuf/timestamp.proto";
 import "google/api/annotations.proto";
 
 option go_package = "google.golang.org/genproto/googleapis/cloud/gaming/v1beta;gaming";
+
 option java_multiple_files = true;
 option java_package = "com.google.cloud.gaming.v1beta";
 
@@ -35,7 +35,7 @@ message ListGameServerConfigsRequest {
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
-      type: "gameservices.googleapis.com/GameServerConfig"
+      child_type: "gameservices.googleapis.com/GameServerConfig"
     }
   ];
 
@@ -91,7 +91,7 @@ message CreateGameServerConfigRequest {
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
-      type: "gameservices.googleapis.com/GameServerConfig"
+      child_type: "gameservices.googleapis.com/GameServerConfig"
     }
   ];
 

diff --git a/protos/google/cloud/gaming/v1beta/game_server_configs_service.proto b/protos/google/cloud/gaming/v1beta/game_server_configs_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 Google LLC.
+// Copyright 2020 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,7 +11,6 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-//
 
 syntax = "proto3";
 
@@ -23,6 +22,7 @@ import "google/cloud/gaming/v1beta/game_server_configs.proto";
 import "google/longrunning/operations.proto";
 
 option go_package = "google.golang.org/genproto/googleapis/cloud/gaming/v1beta;gaming";
+
 option java_multiple_files = true;
 option java_package = "com.google.cloud.gaming.v1beta";
 

diff --git a/protos/google/cloud/gaming/v1beta/game_server_deployments.proto b/protos/google/cloud/gaming/v1beta/game_server_deployments.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 Google LLC.
+// Copyright 2020 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,7 +11,6 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-//
 
 syntax = "proto3";
 
@@ -25,6 +24,7 @@ import "google/protobuf/timestamp.proto";
 import "google/api/annotations.proto";
 
 option go_package = "google.golang.org/genproto/googleapis/cloud/gaming/v1beta;gaming";
+
 option java_multiple_files = true;
 option java_package = "com.google.cloud.gaming.v1beta";
 
@@ -35,7 +35,7 @@ message ListGameServerDeploymentsRequest {
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
-      type: "gameservices.googleapis.com/GameServerDeployment"
+      child_type: "gameservices.googleapis.com/GameServerDeployment"
     }
   ];
 
@@ -105,7 +105,7 @@ message CreateGameServerDeploymentRequest {
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
-      type: "gameservices.googleapis.com/GameServerDeployment"
+      child_type: "gameservices.googleapis.com/GameServerDeployment"
     }
   ];
 

diff --git a/protos/google/cloud/gaming/v1beta/game_server_deployments_service.proto b/protos/google/cloud/gaming/v1beta/game_server_deployments_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 Google LLC.
+// Copyright 2020 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,7 +11,6 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-//
 
 syntax = "proto3";
 
@@ -23,6 +22,7 @@ import "google/cloud/gaming/v1beta/game_server_deployments.proto";
 import "google/longrunning/operations.proto";
 
 option go_package = "google.golang.org/genproto/googleapis/cloud/gaming/v1beta;gaming";
+
 option java_multiple_files = true;
 option java_package = "com.google.cloud.gaming.v1beta";
 
@@ -95,6 +95,11 @@ service GameServerDeploymentsService {
   }
 
   // Patches a single Game Server Deployment Rollout.
+  // The method will not return an error if the update does not affect any
+  // existing realms. For example - if the default_game_server_config is changed
+  // but all existing realms use the override, that is valid. Similarly, if a
+  // non existing realm is explicitly called out in game_server_config_overrides
+  // field, that will also not result in an error.
   rpc UpdateGameServerDeploymentRollout(UpdateGameServerDeploymentRolloutRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       patch: "/v1beta/{rollout.name=projects/*/locations/*/gameServerDeployments/*}/rollout"

diff --git a/protos/google/cloud/gaming/v1beta/realms.proto b/protos/google/cloud/gaming/v1beta/realms.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 Google LLC.
+// Copyright 2020 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,7 +11,6 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-//
 
 syntax = "proto3";
 
@@ -25,6 +24,7 @@ import "google/protobuf/timestamp.proto";
 import "google/api/annotations.proto";
 
 option go_package = "google.golang.org/genproto/googleapis/cloud/gaming/v1beta;gaming";
+
 option java_multiple_files = true;
 option java_package = "com.google.cloud.gaming.v1beta";
 
@@ -35,7 +35,7 @@ message ListRealmsRequest {
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
-      type: "gameservices.googleapis.com/Realm"
+      child_type: "gameservices.googleapis.com/Realm"
     }
   ];
 
@@ -90,7 +90,7 @@ message CreateRealmRequest {
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
-      type: "gameservices.googleapis.com/Realm"
+      child_type: "gameservices.googleapis.com/Realm"
     }
   ];
 

diff --git a/protos/google/cloud/gaming/v1beta/realms_service.proto b/protos/google/cloud/gaming/v1beta/realms_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 Google LLC.
+// Copyright 2020 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,7 +11,6 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-//
 
 syntax = "proto3";
 
@@ -23,6 +22,7 @@ import "google/cloud/gaming/v1beta/realms.proto";
 import "google/longrunning/operations.proto";
 
 option go_package = "google.golang.org/genproto/googleapis/cloud/gaming/v1beta;gaming";
+
 option java_multiple_files = true;
 option java_package = "com.google.cloud.gaming.v1beta";