Method: projects.locations.realms.gameServerClusters.previewUpdate

Previews updating a GameServerCluster.

HTTP request

PATCH https://gameservices.googleapis.com/v1beta/{gameServerCluster.name=projects/*/locations/*/realms/*/gameServerClusters/*}:previewUpdate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
gameServerCluster.name

string

Required. The resource name of the game server cluster. Uses the form:

projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}. For example,

projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see

https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

previewTime

string (Timestamp format)

Optional. The target timestamp to compute the preview.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Request body

The request body contains an instance of GameServerCluster.

Response body

If successful, the response body contains data with the following structure:

Response message for GameServerClustersService.PreviewUpdateGameServerCluster

JSON representation
{
  "etag": string,
  "targetState": {
    object (TargetState)
  }
}
Fields
etag

string

The ETag of the game server cluster.

targetState

object (TargetState)

The target state.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.