Game Services API (gameservices:v1)

Additions

Methods


• ▼ ▲ gameservices.projects.locations.gameServerDeployments.delete

  Parameter Order: name

  Description: Deletes a single game server deployment.

  HTTP Method: DELETE

  Path: v1/{+name}

  Parameters:

  name

  Description: Required. The name of the game server deployment to delete, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}`.

  Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

  Location: path

  Type: string

  Required: Yes

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}

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

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.create

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

  HTTP Method: POST

  Description: Creates a new game server deployment in a given project and location.

  Parameters:

  deploymentId

  Description: Required. The ID of the game server deployment resource to create.

  Location: query

  Type: string

  parent

  Location: path

  Type: string

  Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}`.

  Pattern: ^projects/[^/]+/locations/[^/]+$

  Required: Yes

  Path: v1/{+parent}/gameServerDeployments

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments

  Parameter Order: parent

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.patch

  Description: Patches a game server deployment.

  HTTP Method: PATCH

  Parameters:

  updateMask

  Format: google-fieldmask

  Description: Required. The update mask to apply to the resource. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).

  Type: string

  Location: query

  name

  Required: Yes

  Description: The resource name of the game server deployment, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment`.

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

  Type: string

  Parameter Order: name

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}

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

  Path: v1/{+name}

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.getRollout

  Path: v1/{+name}/rollout

  Parameters:

  name

  Location: path

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

  Required: Yes

  Description: Required. The name of the game server deployment rollout to retrieve, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/rollout`.

  Description: Gets details of a single game server deployment rollout.

  HTTP Method: GET

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/rollout

  Parameter Order: name

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

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.previewRollout

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

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/rollout:preview

  Parameters:

  updateMask

  Type: string

  Format: google-fieldmask

  Location: query

  Description: Optional. The update mask to apply to the resource. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).

  name

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

  Description: The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.

  Required: Yes

  Location: path

  previewTime

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

  Type: string

  Location: query

  Format: google-datetime

  Path: v1/{+name}/rollout:preview

  HTTP Method: PATCH

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

  Parameter Order: name

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.get

  HTTP Method: GET

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}

  Description: Gets details of a single game server deployment.

  Path: v1/{+name}

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

  Parameters:

  name

  Description: Required. The name of the game server deployment to retrieve, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}`.

  Type: string

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

  Required: Yes

  Parameter Order: name

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.updateRollout

  Parameters:

  name

  Required: Yes

  Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

  Location: path

  Description: The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.

  Type: string

  updateMask

  Type: string

  Location: query

  Description: Required. The update mask to apply to the resource. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).

  Format: google-fieldmask

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

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/rollout

  Path: v1/{+name}/rollout

  HTTP Method: PATCH

  Description: 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, the following cases will not return an error: * The default_game_server_config is changed but all existing realms use the override. * A non-existing realm is explicitly called out in the game_server_config_overrides field.

  Parameter Order: name

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.list

  HTTP Method: GET

  Parameter Order: parent

  Description: Lists game server deployments in a given project and location.

  Parameters:

  filter

  Location: query

  Type: string

  Description: Optional. The filter to apply to list results (see [Filtering](https://google.aip.dev/160)).

  parent

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+$

  Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}`.

  Required: Yes

  Location: path

  orderBy

  Location: query

  Description: Optional. Specifies the ordering of results following [Cloud API syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).

  Type: string

  pageToken

  Location: query

  Type: string

  Description: Optional. The next_page_token value returned from a previous list request, if any.

  pageSize

  Type: integer

  Location: query

  Format: int32

  Description: Optional. The maximum number of items to return. If unspecified, the server picks an appropriate default. The server may return fewer items than requested. A caller should only rely on the response's next_page_token to determine if there are more GameServerDeployments left to be queried.

  Path: v1/{+parent}/gameServerDeployments

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

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.fetchDeploymentState

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

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}:fetchDeploymentState

  Description: 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.

  Path: v1/{+name}:fetchDeploymentState

  Parameter Order: name

  HTTP Method: POST

  Parameters:

  name

  Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

  Description: Required. The name of the game server deployment, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}`.

  Location: path

  Required: Yes

  Type: string

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.configs.create

  Description: 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.

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

  HTTP Method: POST

  Parameters:

  configId

  Location: query

  Description: Required. The ID of the game server config resource to create.

  Type: string

  parent

  Location: path

  Type: string

  Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/`.

  Required: Yes

  Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

  Path: v1/{+parent}/configs

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs

  Parameter Order: parent

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.configs.get

  Parameter Order: name

  HTTP Method: GET

  Parameters:

  name

  Required: Yes

  Location: path

  Type: string

  Description: Required. The name of the game server config to retrieve, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/{configId}`.

  Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+/configs/[^/]+$

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs/{configsId}

  Path: v1/{+name}

  Description: Gets details of a single game server config.

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

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.configs.delete

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

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs/{configsId}

  Description: Deletes a single game server config. The deletion fails if the game server config is referenced in a game server deployment rollout.

  HTTP Method: DELETE

  Parameter Order: name

  Parameters:

  name

  Description: Required. The name of the game server config to delete, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/{configId}`.

  Location: path

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+/configs/[^/]+$

  Required: Yes

  Path: v1/{+name}

• ▼ ▲ gameservices.projects.locations.gameServerDeployments.configs.list

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

  Path: v1/{+parent}/configs

  Parameter Order: parent

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gameServerDeployments/{gameServerDeploymentsId}/configs

  HTTP Method: GET

  Parameters:

  orderBy

  Description: Optional. Specifies the ordering of results following [Cloud API syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).

  Type: string

  Location: query

  filter

  Type: string

  Description: Optional. The filter to apply to list results (see [Filtering](https://google.aip.dev/160)).

  Location: query

  pageToken

  Type: string

  Description: Optional. The next_page_token value returned from a previous list request, if any.

  Location: query

  pageSize

  Location: query

  Description: Optional. The maximum number of items to return. If unspecified, the server picks an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerConfigs left to be queried.

  Type: integer

  Format: int32

  parent

  Type: string

  Location: path

  Required: Yes

  Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/*`.

  Pattern: ^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$

  Description: Lists game server configs in a given project, location, and game server deployment.

• ▼ ▲ gameservices.projects.locations.realms.list

  Parameter Order: parent

  Path: v1/{+parent}/realms

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

  Parameters:

  parent

  Pattern: ^projects/[^/]+/locations/[^/]+$

  Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}`.

  Type: string

  Required: Yes

  Location: path

  filter

  Description: Optional. The filter to apply to list results (see [Filtering](https://google.aip.dev/160)).

  Location: query

  Type: string

  orderBy

  Description: Optional. Specifies the ordering of results following [Cloud API syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).

  Type: string

  Location: query

  pageSize

  Location: query

  Format: int32

  Description: Optional. The maximum number of items to return. If unspecified, the server picks an appropriate default. The server may return fewer items than requested. A caller should only rely on the response's next_page_token to determine if there are more realms left to be queried.

  Type: integer

  pageToken

  Type: string

  Location: query

  Description: Optional. The next_page_token value returned from a previous list request, if any.

  HTTP Method: GET

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms

  Description: Lists realms in a given project and location.

• ▼ ▲ gameservices.projects.locations.realms.get

  Parameters:

  name

  Location: path

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$

  Required: Yes

  Description: Required. The name of the realm to retrieve, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`.

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}

  Description: Gets details of a single realm.

  Parameter Order: name

  HTTP Method: GET

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

  Path: v1/{+name}

• ▼ ▲ gameservices.projects.locations.realms.create

  Description: Creates a new realm in a given project and location.

  Parameter Order: parent

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms

  Path: v1/{+parent}/realms

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

  HTTP Method: POST

  Parameters:

  parent

  Pattern: ^projects/[^/]+/locations/[^/]+$

  Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}`.

  Type: string

  Required: Yes

  Location: path

  realmId

  Location: query

  Type: string

  Description: Required. The ID of the realm resource to create.

• ▼ ▲ gameservices.projects.locations.realms.patch

  Path: v1/{+name}

  Parameter Order: name

  Description: Patches a single realm.

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

  Parameters:

  updateMask

  Location: query

  Format: google-fieldmask

  Type: string

  Description: Required. The update mask to apply to the resource. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).

  name

  Description: The resource name of the realm, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`. For example, `projects/my-project/locations/global/realms/my-realm`.

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$

  Required: Yes

  Location: path

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}

  HTTP Method: PATCH

• ▼ ▲ gameservices.projects.locations.realms.delete

  Parameters:

  name

  Description: Required. The name of the realm to delete, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`.

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$

  Type: string

  Required: Yes

  Location: path

  Path: v1/{+name}

  Parameter Order: name

  HTTP Method: DELETE

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}

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

  Description: Deletes a single realm.

• ▼ ▲ gameservices.projects.locations.realms.previewUpdate

  Description: Previews patches to a single realm.

  Path: v1/{+name}:previewUpdate

  Parameters:

  name

  Description: The resource name of the realm, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`. For example, `projects/my-project/locations/global/realms/my-realm`.

  Type: string

  Required: Yes

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$

  Location: path

  updateMask

  Description: Required. The update mask to apply to the resource. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).

  Location: query

  Type: string

  Format: google-fieldmask

  previewTime

  Location: query

  Type: string

  Format: google-datetime

  Description: Optional. The target timestamp to compute the preview.

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

  HTTP Method: PATCH

  Parameter Order: name

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}:previewUpdate

• ▼ ▲ gameservices.projects.locations.realms.gameServerClusters.get

  HTTP Method: GET

  Path: v1/{+name}

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters/{gameServerClustersId}

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

  Parameter Order: name

  Parameters:

  view

  Enum:

  • GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED
  • BASIC
  • FULL

  Description: Optional. View for the returned GameServerCluster objects. When `FULL` is specified, the `cluster_state` field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is `GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED`, the same as `BASIC`, which does not return the `cluster_state` field.

  Enum Descriptions:

  • If the value is not set, Google Cloud Game Servers defaults to the `BASIC` view.
  • Includes basic information of a GameServerCluster resource and omits `cluster_state`. This is the default value (for methods ListGameServerClusters, GetGameServerCluster, and PreviewCreateGameServerCluster).
  • Include basic information of a GameServerCluster resource as well as `cluster_state`.

  Location: query

  Type: string

  name

  Location: path

  Description: Required. The name of the game server cluster to retrieve, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`.

  Required: Yes

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$

  Description: Gets details of a single game server cluster.

• ▼ ▲ gameservices.projects.locations.realms.gameServerClusters.list

  Description: Lists game server clusters in a given project and location.

  Path: v1/{+parent}/gameServerClusters

  Parameter Order: parent

  HTTP Method: GET

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters

  Parameters:

  view

  Type: string

  Enum:

  • GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED
  • BASIC
  • FULL

  Location: query

  Description: Optional. View for the returned GameServerCluster objects. When `FULL` is specified, the `cluster_state` field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is `GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED`, the same as `BASIC`, which does not return the `cluster_state` field.

  Enum Descriptions:

  • If the value is not set, Google Cloud Game Servers defaults to the `BASIC` view.
  • Includes basic information of a GameServerCluster resource and omits `cluster_state`. This is the default value (for methods ListGameServerClusters, GetGameServerCluster, and PreviewCreateGameServerCluster).
  • Include basic information of a GameServerCluster resource as well as `cluster_state`.

  pageToken

  Location: query

  Type: string

  Description: Optional. The next_page_token value returned from a previous list request, if any.

  orderBy

  Location: query

  Description: Optional. Specifies the ordering of results following [Cloud API syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).

  Type: string

  parent

  Required: Yes

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$

  Location: path

  Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`.

  Type: string

  pageSize

  Description: Optional. The maximum number of items to return. If unspecified, the server picks an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried.

  Format: int32

  Location: query

  Type: integer

  filter

  Location: query

  Type: string

  Description: Optional. The filter to apply to list results (see [Filtering](https://google.aip.dev/160)).

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

• ▼ ▲ gameservices.projects.locations.realms.gameServerClusters.create

  Parameters:

  parent

  Type: string

  Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`.

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$

  Required: Yes

  Location: path

  gameServerClusterId

  Type: string

  Description: Required. The ID of the game server cluster resource to create.

  Location: query

  Parameter Order: parent

  HTTP Method: POST

  Description: Creates a new game server cluster in a given project and location.

  Path: v1/{+parent}/gameServerClusters

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

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters

• ▼ ▲ gameservices.projects.locations.realms.gameServerClusters.delete

  HTTP Method: DELETE

  Description: Deletes a single game server cluster.

  Path: v1/{+name}

  Parameters:

  name

  Description: Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{locationId}/gameServerClusters/{gameServerClusterId}`.

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters/{gameServerClustersId}

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

• ▼ ▲ gameservices.projects.locations.realms.gameServerClusters.previewUpdate

  Path: v1/{+name}:previewUpdate

  Parameters:

  previewTime

  Format: google-datetime

  Location: query

  Type: string

  Description: Optional. The target timestamp to compute the preview.

  updateMask

  Type: string

  Description: Required. Mask of fields to update. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).

  Location: query

  Format: google-fieldmask

  name

  Description: Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`.

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$

  Required: Yes

  Location: path

  Description: Previews updating a GameServerCluster.

  HTTP Method: PATCH

  Parameter Order: name

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters/{gameServerClustersId}:previewUpdate

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

• ▼ ▲ gameservices.projects.locations.realms.gameServerClusters.previewDelete

  Path: v1/{+name}:previewDelete

  Description: Previews deletion of a single game server cluster.

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

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters/{gameServerClustersId}:previewDelete

  Parameters:

  name

  Location: path

  Description: Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{locationId}/gameServerClusters/{gameServerClusterId}`.

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$

  Required: Yes

  previewTime

  Type: string

  Location: query

  Format: google-datetime

  Description: Optional. The target timestamp to compute the preview.

  Parameter Order: name

  HTTP Method: DELETE

• ▼ ▲ gameservices.projects.locations.realms.gameServerClusters.patch

  Parameter Order: name

  Parameters:

  name

  Description: Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`.

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$

  Type: string

  Required: Yes

  Location: path

  updateMask

  Type: string

  Format: google-fieldmask

  Description: Required. The update mask to apply to the resource. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).

  Location: query

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters/{gameServerClustersId}

  HTTP Method: PATCH

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

  Path: v1/{+name}

  Description: Patches a single game server cluster.

• ▼ ▲ gameservices.projects.locations.realms.gameServerClusters.previewCreate

  HTTP Method: POST

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}/gameServerClusters:previewCreate

  Parameters:

  gameServerClusterId

  Description: Required. The ID of the game server cluster resource to create.

  Type: string

  Location: query

  parent

  Pattern: ^projects/[^/]+/locations/[^/]+/realms/[^/]+$

  Location: path

  Type: string

  Description: Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`.

  Required: Yes

  previewTime

  Format: google-datetime

  Location: query

  Type: string

  Description: Optional. The target timestamp to compute the preview.

  view

  Enum Descriptions:

  • If the value is not set, Google Cloud Game Servers defaults to the `BASIC` view.
  • Includes basic information of a GameServerCluster resource and omits `cluster_state`. This is the default value (for methods ListGameServerClusters, GetGameServerCluster, and PreviewCreateGameServerCluster).
  • Include basic information of a GameServerCluster resource as well as `cluster_state`.

  Location: query

  Enum:

  • GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED
  • BASIC
  • FULL

  Type: string

  Description: Optional. This field is deprecated. Preview will always return KubernetesClusterState.

  Path: v1/{+parent}/gameServerClusters:previewCreate

  Parameter Order: parent

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

  Description: Previews creation of a new game server cluster in a given project and location.