Google Cloud Game Servers V1 Client - Class PreviewGameServerDeploymentRolloutRequest (1.0.5)

Reference documentation and code samples for the Google Cloud Game Servers V1 Client class PreviewGameServerDeploymentRolloutRequest.

Request message for PreviewGameServerDeploymentRollout.

Generated from protobuf message google.cloud.gaming.v1.PreviewGameServerDeploymentRolloutRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ rollout Google\Cloud\Gaming\V1\GameServerDeploymentRollout

Required. The game server deployment rollout to be updated. Only fields specified in update_mask are updated.

↳ update_mask Google\Protobuf\FieldMask

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

↳ preview_time Google\Protobuf\Timestamp

Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes.

getRollout

Required. The game server deployment rollout to be updated.

Only fields specified in update_mask are updated.

Returns
TypeDescription
Google\Cloud\Gaming\V1\GameServerDeploymentRollout|null

hasRollout

clearRollout

setRollout

Required. The game server deployment rollout to be updated.

Only fields specified in update_mask are updated.

Parameter
NameDescription
var Google\Cloud\Gaming\V1\GameServerDeploymentRollout
Returns
TypeDescription
$this

getUpdateMask

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

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

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

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

getPreviewTime

Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasPreviewTime

clearPreviewTime

setPreviewTime

Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this