Game Services API (gameservices:v1)

2022-07-29

27 removed methods

Deletions

    Methods
  • gameservices.projects.locations.gameServerDeployments.configs.create

      Parameters :

        parent

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

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

          Required : Yes

          Type : string

          Location : path

        configId

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

          Type : string

          Location : query

      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.

      Parameter Order : parent

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

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

      HTTP Method : POST

      Path : v1/{+parent}/configs

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

      HTTP Method : GET

      Parameter Order : parent

      Parameters :

        pageToken

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

          Location : query

          Type : string

        parent

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

          Type : string

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

          Location : path

          Required : Yes

        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

        filter

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

          Location : query

          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 GameServerConfigs left to be queried.

          Location : query

          Type : integer

          Format : int32

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

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

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

      Path : v1/{+parent}/configs

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

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

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

      Parameter Order : name

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

      HTTP Method : DELETE

      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}`.

          Required : Yes

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

          Location : path

          Type : string

      Path : v1/{+name}

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

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

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

      Description : Gets details of a single game server config.

      Parameter Order : name

      Parameters :

        name

          Required : Yes

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

          Location : path

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

          Type : string

      Path : v1/{+name}

      HTTP Method : GET

  • gameservices.projects.locations.gameServerDeployments.previewRollout

      HTTP Method : PATCH

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

      Parameters :

        name

          Type : string

          Location : path

          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

        updateMask

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

          Format : google-fieldmask

          Location : query

          Type : string

        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

      Parameter Order : name

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

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

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

  • gameservices.projects.locations.gameServerDeployments.create

      Parameters :

        deploymentId

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

          Type : string

          Location : query

        parent

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

          Type : string

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

          Location : path

          Required : Yes

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

      Parameter Order : parent

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

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

      HTTP Method : POST

      Path : v1/{+parent}/gameServerDeployments

  • gameservices.projects.locations.gameServerDeployments.fetchDeploymentState

      Parameters :

        name

          Type : string

          Location : path

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

          Required : Yes

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

      Path : v1/{+name}:fetchDeploymentState

      HTTP Method : POST

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

      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.

      Parameter Order : name

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

  • gameservices.projects.locations.gameServerDeployments.patch

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

      Path : v1/{+name}

      Parameter Order : name

      HTTP Method : PATCH

      Description : Patches a game server deployment.

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

      Parameters :

        name

          Type : string

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

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

          Required : Yes

          Location : path

        updateMask

          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

          Format : google-fieldmask

  • gameservices.projects.locations.gameServerDeployments.updateRollout

      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.

      HTTP Method : PATCH

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

      Path : v1/{+name}/rollout

      Parameter Order : name

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

      Parameters :

        updateMask

          Location : query

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

        name

          Type : string

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

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

          Location : path

          Required : Yes

  • gameservices.projects.locations.gameServerDeployments.list

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

      Path : v1/{+parent}/gameServerDeployments

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

      Parameters :

        parent

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

          Type : string

          Required : Yes

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

          Location : path

        pageToken

          Location : query

          Type : string

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

        filter

          Type : string

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

          Location : query

        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

          Format : int32

          Type : integer

          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 the response's next_page_token to determine if there are more GameServerDeployments left to be queried.

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

      Parameter Order : parent

      HTTP Method : GET

  • gameservices.projects.locations.gameServerDeployments.getRollout

      Parameter Order : name

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

      HTTP Method : GET

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

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

      Path : v1/{+name}/rollout

      Parameters :

        name

          Location : path

          Type : string

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

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

          Required : Yes

  • gameservices.projects.locations.gameServerDeployments.get

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

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

      HTTP Method : GET

      Parameter Order : name

      Description : Gets details of a single game server deployment.

      Parameters :

        name

          Type : string

          Location : path

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

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

          Required : Yes

      Path : v1/{+name}

  • gameservices.projects.locations.gameServerDeployments.delete

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

      Path : v1/{+name}

      Description : Deletes a single game server deployment.

      HTTP Method : DELETE

      Parameters :

        name

          Required : Yes

          Type : string

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

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

          Location : path

      Parameter Order : name

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

  • gameservices.projects.locations.realms.get

      Parameters :

        name

          Required : Yes

          Location : path

          Type : string

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

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

      Parameter Order : name

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

      Description : Gets details of a single realm.

      Path : v1/{+name}

      HTTP Method : GET

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

  • gameservices.projects.locations.realms.previewUpdate

      Path : v1/{+name}:previewUpdate

      Description : Previews patches to a single realm.

      HTTP Method : PATCH

      Parameters :

        previewTime

          Type : string

          Location : query

          Format : google-datetime

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

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

          Location : path

          Required : Yes

          Type : string

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

        updateMask

          Location : query

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

          Format : google-fieldmask

          Type : string

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

      Parameter Order : name

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

  • gameservices.projects.locations.realms.list

      HTTP Method : GET

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

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

      Parameter Order : parent

      Path : v1/{+parent}/realms

      Parameters :

        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 the response's next_page_token to determine if there are more realms left to be queried.

          Format : int32

          Location : query

          Type : integer

        orderBy

          Location : query

          Type : string

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

        filter

          Type : string

          Location : query

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

        parent

          Location : path

          Required : Yes

          Type : string

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

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

        pageToken

          Location : query

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

          Type : string

      Description : Lists realms in a given project and location.

  • gameservices.projects.locations.realms.create

      Path : v1/{+parent}/realms

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

      HTTP Method : POST

      Parameter Order : parent

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

      Parameters :

        realmId

          Type : string

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

          Location : query

        parent

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

          Location : path

          Type : string

          Required : Yes

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

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

  • gameservices.projects.locations.realms.patch

      Path : v1/{+name}

      HTTP Method : PATCH

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

      Parameters :

        updateMask

          Format : google-fieldmask

          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

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

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

          Type : string

          Location : path

          Required : Yes

      Parameter Order : name

      Description : Patches a single realm.

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

  • gameservices.projects.locations.realms.delete

      Path : v1/{+name}

      Parameter Order : name

      Description : Deletes a single realm.

      Parameters :

        name

          Location : path

          Type : string

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

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

          Required : Yes

      HTTP Method : DELETE

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

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

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

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

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

      Path : v1/{+name}:previewUpdate

      HTTP Method : PATCH

      Description : Previews updating a GameServerCluster.

      Parameter Order : name

      Parameters :

        name

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

          Type : string

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

          Location : path

          Required : Yes

        updateMask

          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

          Type : string

        previewTime

          Format : google-datetime

          Location : query

          Type : string

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

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

      Path : v1/{+name}:previewDelete

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

      Parameters :

        name

          Required : Yes

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

          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

        previewTime

          Type : string

          Location : query

          Format : google-datetime

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

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

      Parameter Order : name

      HTTP Method : DELETE

      Description : Previews deletion of a single game server cluster.

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

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

      Parameters :

        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.

          Location : query

          Format : int32

          Type : integer

        parent

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

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

          Location : path

          Type : string

          Required : Yes

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

          Type : string

        filter

          Location : query

          Type : string

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

        pageToken

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

          Type : string

          Location : query

        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

      Path : v1/{+parent}/gameServerClusters

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

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

      Parameter Order : parent

      HTTP Method : GET

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

      Parameters :

        name

          Type : string

          Location : path

          Required : Yes

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

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

      Parameter Order : name

      Path : v1/{+name}

      HTTP Method : DELETE

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

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

      Description : Deletes a single game server cluster.

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

      HTTP Method : PATCH

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

      Description : Patches a single game server cluster.

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

      Parameter Order : name

      Parameters :

        updateMask

          Format : google-fieldmask

          Type : string

          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

        name

          Location : path

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

          Type : string

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

          Required : Yes

      Path : v1/{+name}

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

      Parameters :

        parent

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

          Location : path

          Required : Yes

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

          Type : string

        gameServerClusterId

          Type : string

          Location : query

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

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

      Path : v1/{+parent}/gameServerClusters

      Parameter Order : parent

      HTTP Method : POST

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

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

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

      Path : v1/{+name}

      Parameters :

        name

          Type : string

          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

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

        view

          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 :

        • GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED
        • BASIC
        • FULL
        • Location : query

          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`.
        • Type : string

      Parameter Order : name

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

      HTTP Method : GET

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

      Description : Gets details of a single game server cluster.

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

      Parameter Order : parent

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

      Parameters :

        view

          Location : query

          Type : string

          Enum :

        • GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED
        • BASIC
        • FULL
        • Description : Optional. This field is deprecated. Preview will always return KubernetesClusterState.

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

        parent

          Required : Yes

          Location : path

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

          Type : string

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

        previewTime

          Location : query

          Type : string

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

          Format : google-datetime

        gameServerClusterId

          Location : query

          Type : string

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

      HTTP Method : POST

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

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

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