Game Services API: projects. Deploy and manage infrastructure for global multiplayer gaming experiences. See: https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects
Game Services API: projects. Deploy and manage infrastructure for global multiplayer gaming experiences. See: https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects
(locations-gameServerDeployments-configs-create$ auth parameters body)
Required parameters: parent
Optional parameters: configId
Body:
{:name string, :scalingConfigs [{:name string, :fleetAutoscalerSpec string, :schedules [Schedule], :selectors [LabelSelector]}], :labels {}, :updateTime string, :createTime string, :description string, :fleetConfigs [{:fleetSpec string, :name string}]}
Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/configs/create Required parameters: parent Optional parameters: configId Body: {:name string, :scalingConfigs [{:name string, :fleetAutoscalerSpec string, :schedules [Schedule], :selectors [LabelSelector]}], :labels {}, :updateTime string, :createTime string, :description string, :fleetConfigs [{:fleetSpec string, :name string}]} Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.
(locations-gameServerDeployments-configs-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/configs/delete Required parameters: name Optional parameters: none Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.
(locations-gameServerDeployments-configs-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets details of a single game server config.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/configs/get Required parameters: name Optional parameters: none Gets details of a single game server config.
(locations-gameServerDeployments-configs-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, orderBy, pageToken, filter
Lists game server configs in a given project, location, and game server deployment.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/configs/list Required parameters: parent Optional parameters: pageSize, orderBy, pageToken, filter Lists game server configs in a given project, location, and game server deployment.
(locations-gameServerDeployments-create$ auth parameters body)
Required parameters: parent
Optional parameters: deploymentId
Body:
{:description string, :updateTime string, :labels {}, :etag string, :name string, :createTime string}
Creates a new game server deployment in a given project and location.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/create Required parameters: parent Optional parameters: deploymentId Body: {:description string, :updateTime string, :labels {}, :etag string, :name string, :createTime string} Creates a new game server deployment in a given project and location.
(locations-gameServerDeployments-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a single game server deployment.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/delete Required parameters: name Optional parameters: none Deletes a single game server deployment.
(locations-gameServerDeployments-fetchDeploymentState$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{}
Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/fetchDeploymentState Required parameters: name Optional parameters: none Body: {} Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.
(locations-gameServerDeployments-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets details of a single game server deployment.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/get Required parameters: name Optional parameters: none Gets details of a single game server deployment.
(locations-gameServerDeployments-getIamPolicy$ auth parameters)
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-gameServerDeployments-getRollout$ auth parameters)
Required parameters: name
Optional parameters: none
Gets details a single game server deployment rollout.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/getRollout Required parameters: name Optional parameters: none Gets details a single game server deployment rollout.
(locations-gameServerDeployments-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, filter, pageToken, orderBy
Lists game server deployments in a given project and location.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/list Required parameters: parent Optional parameters: pageSize, filter, pageToken, orderBy Lists game server deployments in a given project and location.
(locations-gameServerDeployments-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:description string, :updateTime string, :labels {}, :etag string, :name string, :createTime string}
Patches a game server deployment.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/patch Required parameters: name Optional parameters: updateMask Body: {:description string, :updateTime string, :labels {}, :etag string, :name string, :createTime string} Patches a game server deployment.
(locations-gameServerDeployments-previewRollout$ auth parameters body)
Required parameters: name
Optional parameters: previewTime, updateMask
Body:
{:etag string, :name string, :gameServerConfigOverrides [{:realmsSelector RealmSelector, :configVersion string}], :updateTime string, :createTime string, :defaultGameServerConfig string}
Previews the game server deployment rollout. This API does not mutate the rollout resource.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/previewRollout Required parameters: name Optional parameters: previewTime, updateMask Body: {:etag string, :name string, :gameServerConfigOverrides [{:realmsSelector RealmSelector, :configVersion string}], :updateTime string, :createTime string, :defaultGameServerConfig string} Previews the game server deployment rollout. This API does not mutate the rollout resource.
(locations-gameServerDeployments-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:auditConfigs [AuditConfig], :bindings [Binding], :version integer, :rules [Rule], :etag string, :iamOwned boolean}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:auditConfigs [AuditConfig], :bindings [Binding], :version integer, :rules [Rule], :etag string, :iamOwned boolean}, :updateMask string} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(locations-gameServerDeployments-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
(locations-gameServerDeployments-updateRollout$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:etag string, :name string, :gameServerConfigOverrides [{:realmsSelector RealmSelector, :configVersion string}], :updateTime string, :createTime string, :defaultGameServerConfig string}
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.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/gameServerDeployments/updateRollout Required parameters: name Optional parameters: updateMask Body: {:etag string, :name string, :gameServerConfigOverrides [{:realmsSelector RealmSelector, :configVersion string}], :updateTime string, :createTime string, :defaultGameServerConfig string} 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.
(locations-get$ auth parameters)
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/get
Required parameters: name
Optional parameters: none
Gets information about a location.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/get Required parameters: name Optional parameters: none Gets information about a location.
(locations-list$ auth parameters)
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/list
Required parameters: name
Optional parameters: pageSize, pageToken, includeUnrevealedLocations, filter
Lists information about the supported locations for this service.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/list Required parameters: name Optional parameters: pageSize, pageToken, includeUnrevealedLocations, filter Lists information about the supported locations for this service.
(locations-operations-cancel$ auth parameters body)
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/operations/cancel
Required parameters: name
Optional parameters: none
Body:
{}
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/operations/cancel Required parameters: name Optional parameters: none Body: {} Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
(locations-operations-delete$ auth parameters)
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/operations/delete
Required parameters: name
Optional parameters: none
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/operations/delete Required parameters: name Optional parameters: none Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
(locations-operations-get$ auth parameters)
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/operations/get
Required parameters: name
Optional parameters: none
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/operations/get Required parameters: name Optional parameters: none Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
(locations-operations-list$ auth parameters)
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/operations/list
Required parameters: name
Optional parameters: pageToken, pageSize, filter
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/operations/list Required parameters: name Optional parameters: pageToken, pageSize, filter Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
(locations-realms-create$ auth parameters body)
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/create
Required parameters: parent
Optional parameters: realmId
Body:
{:description string, :name string, :etag string, :updateTime string, :labels {}, :timeZone string, :createTime string}
Creates a new realm in a given project and location.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/create Required parameters: parent Optional parameters: realmId Body: {:description string, :name string, :etag string, :updateTime string, :labels {}, :timeZone string, :createTime string} Creates a new realm in a given project and location.
(locations-realms-delete$ auth parameters)
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/delete
Required parameters: name
Optional parameters: none
Deletes a single realm.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/delete Required parameters: name Optional parameters: none Deletes a single realm.
(locations-realms-gameServerClusters-create$ auth parameters body)
Required parameters: parent
Optional parameters: gameServerClusterId
Body:
{:name string, :updateTime string, :etag string, :createTime string, :clusterState {:agonesVersionInstalled string, :agonesVersionTargeted string, :provider string, :versionInstalledErrorMessage string, :installationState string, :kubernetesVersionInstalled string}, :labels {}, :connectionInfo {:gkeClusterReference GkeClusterReference, :namespace string}, :description string}
Creates a new game server cluster in a given project and location.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/gameServerClusters/create Required parameters: parent Optional parameters: gameServerClusterId Body: {:name string, :updateTime string, :etag string, :createTime string, :clusterState {:agonesVersionInstalled string, :agonesVersionTargeted string, :provider string, :versionInstalledErrorMessage string, :installationState string, :kubernetesVersionInstalled string}, :labels {}, :connectionInfo {:gkeClusterReference GkeClusterReference, :namespace string}, :description string} Creates a new game server cluster in a given project and location.
(locations-realms-gameServerClusters-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a single game server cluster.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/gameServerClusters/delete Required parameters: name Optional parameters: none Deletes a single game server cluster.
(locations-realms-gameServerClusters-get$ auth parameters)
Required parameters: name
Optional parameters: view
Gets details of a single game server cluster.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/gameServerClusters/get Required parameters: name Optional parameters: view Gets details of a single game server cluster.
(locations-realms-gameServerClusters-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, view, orderBy, pageToken, filter
Lists game server clusters in a given project and location.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/gameServerClusters/list Required parameters: parent Optional parameters: pageSize, view, orderBy, pageToken, filter Lists game server clusters in a given project and location.
(locations-realms-gameServerClusters-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :updateTime string, :etag string, :createTime string, :clusterState {:agonesVersionInstalled string, :agonesVersionTargeted string, :provider string, :versionInstalledErrorMessage string, :installationState string, :kubernetesVersionInstalled string}, :labels {}, :connectionInfo {:gkeClusterReference GkeClusterReference, :namespace string}, :description string}
Patches a single game server cluster.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/gameServerClusters/patch Required parameters: name Optional parameters: updateMask Body: {:name string, :updateTime string, :etag string, :createTime string, :clusterState {:agonesVersionInstalled string, :agonesVersionTargeted string, :provider string, :versionInstalledErrorMessage string, :installationState string, :kubernetesVersionInstalled string}, :labels {}, :connectionInfo {:gkeClusterReference GkeClusterReference, :namespace string}, :description string} Patches a single game server cluster.
(locations-realms-gameServerClusters-previewCreate$ auth parameters body)
Required parameters: parent
Optional parameters: previewTime, view, gameServerClusterId
Body:
{:name string, :updateTime string, :etag string, :createTime string, :clusterState {:agonesVersionInstalled string, :agonesVersionTargeted string, :provider string, :versionInstalledErrorMessage string, :installationState string, :kubernetesVersionInstalled string}, :labels {}, :connectionInfo {:gkeClusterReference GkeClusterReference, :namespace string}, :description string}
Previews creation of a new game server cluster in a given project and location.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/gameServerClusters/previewCreate Required parameters: parent Optional parameters: previewTime, view, gameServerClusterId Body: {:name string, :updateTime string, :etag string, :createTime string, :clusterState {:agonesVersionInstalled string, :agonesVersionTargeted string, :provider string, :versionInstalledErrorMessage string, :installationState string, :kubernetesVersionInstalled string}, :labels {}, :connectionInfo {:gkeClusterReference GkeClusterReference, :namespace string}, :description string} Previews creation of a new game server cluster in a given project and location.
(locations-realms-gameServerClusters-previewDelete$ auth parameters)
Required parameters: name
Optional parameters: previewTime
Previews deletion of a single game server cluster.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/gameServerClusters/previewDelete Required parameters: name Optional parameters: previewTime Previews deletion of a single game server cluster.
(locations-realms-gameServerClusters-previewUpdate$ auth parameters body)
Required parameters: name
Optional parameters: updateMask, previewTime
Body:
{:name string, :updateTime string, :etag string, :createTime string, :clusterState {:agonesVersionInstalled string, :agonesVersionTargeted string, :provider string, :versionInstalledErrorMessage string, :installationState string, :kubernetesVersionInstalled string}, :labels {}, :connectionInfo {:gkeClusterReference GkeClusterReference, :namespace string}, :description string}
Previews updating a GameServerCluster.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/gameServerClusters/previewUpdate Required parameters: name Optional parameters: updateMask, previewTime Body: {:name string, :updateTime string, :etag string, :createTime string, :clusterState {:agonesVersionInstalled string, :agonesVersionTargeted string, :provider string, :versionInstalledErrorMessage string, :installationState string, :kubernetesVersionInstalled string}, :labels {}, :connectionInfo {:gkeClusterReference GkeClusterReference, :namespace string}, :description string} Previews updating a GameServerCluster.
(locations-realms-get$ auth parameters)
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/get
Required parameters: name
Optional parameters: none
Gets details of a single realm.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/get Required parameters: name Optional parameters: none Gets details of a single realm.
(locations-realms-list$ auth parameters)
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/list
Required parameters: parent
Optional parameters: pageToken, orderBy, pageSize, filter
Lists realms in a given project and location.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/list Required parameters: parent Optional parameters: pageToken, orderBy, pageSize, filter Lists realms in a given project and location.
(locations-realms-patch$ auth parameters body)
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:description string, :name string, :etag string, :updateTime string, :labels {}, :timeZone string, :createTime string}
Patches a single realm.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/patch Required parameters: name Optional parameters: updateMask Body: {:description string, :name string, :etag string, :updateTime string, :labels {}, :timeZone string, :createTime string} Patches a single realm.
(locations-realms-previewUpdate$ auth parameters body)
Required parameters: name
Optional parameters: previewTime, updateMask
Body:
{:description string, :name string, :etag string, :updateTime string, :labels {}, :timeZone string, :createTime string}
Previews patches to a single realm.
https://cloud.google.com/solutions/gaming/api/reference/rest/v1/projects/locations/realms/previewUpdate Required parameters: name Optional parameters: previewTime, updateMask Body: {:description string, :name string, :etag string, :updateTime string, :labels {}, :timeZone string, :createTime string} Previews patches to a single realm.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close