Game Services API (gameservices:v1beta)

2022-07-30

27 removed methods

Deletions

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

      HTTP Method : GET

      Path : v1beta/{+name}

      Parameters :

        name

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

          Type : string

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

          Required : Yes

          Location : path

      Parameter Order : name

      Description : Gets details of a single game server config.

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

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

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

      Path : v1beta/{+parent}/configs

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

      Parameters :

        pageToken

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

          Location : query

          Type : string

        filter

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

          Type : string

          Location : query

        parent

          Type : string

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

          Location : path

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

          Required : Yes

        pageSize

          Location : query

          Format : int32

          Type : integer

          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.

        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

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

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

      Parameter Order : parent

      HTTP Method : GET

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

      Parameter Order : parent

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

      HTTP Method : POST

      Path : v1beta/{+parent}/configs

      Parameters :

        configId

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

          Type : string

          Location : query

        parent

          Required : Yes

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

          Location : path

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

          Type : string

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

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

      HTTP Method : DELETE

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

      Parameter Order : name

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

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

      Path : v1beta/{+name}

      Parameters :

        name

          Required : Yes

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

          Location : path

          Type : string

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

  • gameservices.projects.locations.gameServerDeployments.getRollout

      Parameter Order : name

      Path : v1beta/{+name}/rollout

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

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

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

      HTTP Method : GET

      Parameters :

        name

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

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

          Location : path

          Type : string

  • gameservices.projects.locations.gameServerDeployments.list

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

      Path : v1beta/{+parent}/gameServerDeployments

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

      Parameters :

        pageToken

          Type : string

          Location : query

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

        orderBy

          Type : string

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

          Location : query

        pageSize

          Type : integer

          Format : int32

          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.

        parent

          Type : string

          Location : path

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

          Required : Yes

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

        filter

          Location : query

          Type : string

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

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

      HTTP Method : GET

      Parameter Order : parent

  • gameservices.projects.locations.gameServerDeployments.delete

      Parameter Order : name

      Parameters :

        name

          Required : Yes

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

          Type : string

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

          Location : path

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

      Path : v1beta/{+name}

      Description : Deletes a single game server deployment.

      HTTP Method : DELETE

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

  • gameservices.projects.locations.gameServerDeployments.patch

      Path : v1beta/{+name}

      Description : Patches a game server deployment.

      Parameters :

        updateMask

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

          Type : string

          Format : google-fieldmask

        name

          Required : Yes

          Type : string

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

          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

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

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

      Parameter Order : name

      HTTP Method : PATCH

  • gameservices.projects.locations.gameServerDeployments.get

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

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

      Parameters :

        name

          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/[^/]+$

          Location : path

          Type : string

          Required : Yes

      Description : Gets details of a single game server deployment.

      Path : v1beta/{+name}

      Parameter Order : name

      HTTP Method : GET

  • gameservices.projects.locations.gameServerDeployments.updateRollout

      Parameter Order : name

      Parameters :

        name

          Location : path

          Required : Yes

          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

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

        updateMask

          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

          Format : google-fieldmask

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

      Path : v1beta/{+name}/rollout

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

      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

  • gameservices.projects.locations.gameServerDeployments.fetchDeploymentState

      HTTP Method : POST

      Path : v1beta/{+name}:fetchDeploymentState

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

      Parameter Order : name

      Flat Path : v1beta/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.

      Parameters :

        name

          Location : path

          Required : Yes

          Type : string

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

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

  • gameservices.projects.locations.gameServerDeployments.create

      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

        deploymentId

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

          Location : query

          Type : string

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

      Parameter Order : parent

      Path : v1beta/{+parent}/gameServerDeployments

      HTTP Method : POST

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

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

  • gameservices.projects.locations.gameServerDeployments.previewRollout

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

      Parameters :

        updateMask

          Format : google-fieldmask

          Type : string

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

          Location : query

        previewTime

          Format : google-datetime

          Location : query

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

          Type : string

        name

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

          Required : Yes

          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

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

      HTTP Method : PATCH

      Parameter Order : name

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

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

  • gameservices.projects.locations.realms.previewUpdate

      Description : Previews patches to a single realm.

      HTTP Method : PATCH

      Path : v1beta/{+name}:previewUpdate

      Parameter Order : name

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

      Parameters :

        previewTime

          Type : string

          Location : query

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

          Format : google-datetime

        name

          Required : Yes

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

          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

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

          Type : string

          Format : google-fieldmask

          Location : query

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

  • gameservices.projects.locations.realms.patch

      HTTP Method : PATCH

      Parameter Order : name

      Parameters :

        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

        name

          Location : path

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

          Required : Yes

          Type : string

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

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

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

      Description : Patches a single realm.

      Path : v1beta/{+name}

  • gameservices.projects.locations.realms.delete

      Parameters :

        name

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

          Required : Yes

          Location : path

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

          Type : string

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

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

      Path : v1beta/{+name}

      HTTP Method : DELETE

      Parameter Order : name

      Description : Deletes a single realm.

  • gameservices.projects.locations.realms.get

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

      HTTP Method : GET

      Parameters :

        name

          Required : Yes

          Type : string

          Location : path

          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

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

      Description : Gets details of a single realm.

      Path : v1beta/{+name}

  • gameservices.projects.locations.realms.list

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

      Path : v1beta/{+parent}/realms

      HTTP Method : GET

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

      Description : Lists realms in a given project and location.

      Parameter Order : parent

      Parameters :

        orderBy

          Type : string

          Location : query

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

        pageToken

          Type : string

          Location : query

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

        filter

          Location : query

          Type : string

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

        parent

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

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

          Location : path

          Type : string

          Required : Yes

        pageSize

          Format : int32

          Type : integer

          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.

          Location : query

  • gameservices.projects.locations.realms.create

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

      Parameters :

        realmId

          Type : string

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

          Location : query

        parent

          Type : string

          Required : Yes

          Location : path

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

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

      Path : v1beta/{+parent}/realms

      HTTP Method : POST

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

      Parameter Order : parent

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

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

      Parameter Order : name

      HTTP Method : DELETE

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

      Path : v1beta/{+name}:previewDelete

      Description : Previews deletion of a single game server cluster.

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

      Parameters :

        previewTime

          Type : string

          Location : query

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

          Format : google-datetime

        name

          Location : path

          Type : string

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

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

      HTTP Method : PATCH

      Path : v1beta/{+name}:previewUpdate

      Parameter Order : name

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

      Description : Previews updating a GameServerCluster.

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

      Parameters :

        updateMask

          Type : string

          Location : query

          Format : google-fieldmask

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

        name

          Required : Yes

          Type : string

          Location : path

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

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

        previewTime

          Location : query

          Format : google-datetime

          Type : string

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

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

      Path : v1beta/{+name}

      Parameters :

        name

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

          Required : Yes

          Location : path

          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

        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

      Description : Patches a single game server cluster.

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

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

      Parameter Order : name

      HTTP Method : PATCH

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

      HTTP Method : DELETE

      Description : Deletes a single game server cluster.

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

      Parameters :

        name

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

          Required : Yes

          Location : path

          Type : string

      Parameter Order : name

      Path : v1beta/{+name}

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

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

      Parameters :

        view

          Location : query

          Type : string

          Enum :

        • GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED
        • BASIC
        • FULL
        • 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`.
        • 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.

        name

          Required : Yes

          Type : string

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

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

          Location : path

      HTTP Method : GET

      Parameter Order : name

      Path : v1beta/{+name}

      Description : Gets details of a single game server cluster.

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

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

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

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

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

      Path : v1beta/{+parent}/gameServerClusters

      Parameters :

        pageToken

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

          Location : query

          Type : string

        orderBy

          Type : string

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

          Location : query

        filter

          Type : string

          Location : query

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

        pageSize

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

          Location : query

          Type : integer

        view

          Enum :

        • GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED
        • BASIC
        • FULL
        • Type : string

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

          Location : query

        parent

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

          Required : Yes

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

          Type : string

          Location : path

      Parameter Order : parent

      HTTP Method : GET

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

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

      Parameters :

        parent

          Location : path

          Required : Yes

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

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

          Type : string

        gameServerClusterId

          Type : string

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

          Location : query

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

      HTTP Method : POST

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

      Parameter Order : parent

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

      Path : v1beta/{+parent}/gameServerClusters

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

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

      Parameters :

        parent

          Location : path

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

          Type : string

          Required : Yes

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

        gameServerClusterId

          Type : string

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

          Location : query

        previewTime

          Location : query

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

          Type : string

          Format : google-datetime

        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. This field is deprecated. Preview will always return KubernetesClusterState.

          Type : string

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

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

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

      HTTP Method : POST

      Parameter Order : parent