Method: projects.locations.gameServerDeployments.previewRollout

Previews the game server deployment rollout. This API does not mutate the rollout resource.

HTTP request

PATCH https://gameservices.googleapis.com/v1beta/{rollout.name=projects/*/locations/*/gameServerDeployments/*}/rollout:preview

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
rollout.name

string

The resource name of the game server deployment rollout, in the following form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout. For example,

projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. 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. Defaults to the immediately after the proposed rollout completes.

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 GameServerDeploymentRollout.

Response body

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

Response message for gameServerDeployments.previewRollout. This has details about the Agones fleet and autoscaler to be actuated.

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

string

Locations that could not be reached on this request.

etag

string

ETag of the game server deployment.

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.