game_server_configs_service.proto 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. // Copyright 2021 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. syntax = "proto3";
  15. package google.cloud.gaming.v1;
  16. import "google/api/annotations.proto";
  17. import "google/api/client.proto";
  18. import "google/cloud/gaming/v1/game_server_configs.proto";
  19. import "google/longrunning/operations.proto";
  20. option go_package = "google.golang.org/genproto/googleapis/cloud/gaming/v1;gaming";
  21. option java_multiple_files = true;
  22. option java_package = "com.google.cloud.gaming.v1";
  23. // The game server config configures the game servers in an Agones fleet.
  24. service GameServerConfigsService {
  25. option (google.api.default_host) = "gameservices.googleapis.com";
  26. option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
  27. // Lists game server configs in a given project, location, and game server
  28. // deployment.
  29. rpc ListGameServerConfigs(ListGameServerConfigsRequest) returns (ListGameServerConfigsResponse) {
  30. option (google.api.http) = {
  31. get: "/v1/{parent=projects/*/locations/*/gameServerDeployments/*}/configs"
  32. };
  33. option (google.api.method_signature) = "parent";
  34. }
  35. // Gets details of a single game server config.
  36. rpc GetGameServerConfig(GetGameServerConfigRequest) returns (GameServerConfig) {
  37. option (google.api.http) = {
  38. get: "/v1/{name=projects/*/locations/*/gameServerDeployments/*/configs/*}"
  39. };
  40. option (google.api.method_signature) = "name";
  41. }
  42. // Creates a new game server config in a given project, location, and game
  43. // server deployment. Game server configs are immutable, and are not applied
  44. // until referenced in the game server deployment rollout resource.
  45. rpc CreateGameServerConfig(CreateGameServerConfigRequest) returns (google.longrunning.Operation) {
  46. option (google.api.http) = {
  47. post: "/v1/{parent=projects/*/locations/*/gameServerDeployments/*}/configs"
  48. body: "game_server_config"
  49. };
  50. option (google.api.method_signature) = "parent,game_server_config";
  51. option (google.longrunning.operation_info) = {
  52. response_type: "GameServerConfig"
  53. metadata_type: "OperationMetadata"
  54. };
  55. }
  56. // Deletes a single game server config. The deletion will fail if the game
  57. // server config is referenced in a game server deployment rollout.
  58. rpc DeleteGameServerConfig(DeleteGameServerConfigRequest) returns (google.longrunning.Operation) {
  59. option (google.api.http) = {
  60. delete: "/v1/{name=projects/*/locations/*/gameServerDeployments/*/configs/*}"
  61. };
  62. option (google.api.method_signature) = "name";
  63. option (google.longrunning.operation_info) = {
  64. response_type: "google.protobuf.Empty"
  65. metadata_type: "OperationMetadata"
  66. };
  67. }
  68. }