Game Services API (gameservices:v1beta)

2022-07-27

27 new methods

Additions

    Methods

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

      Parameter Order : name

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

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

      HTTP Method : PATCH

      Parameters :

        previewTime

          Format : google-datetime

          Location : query

          Type : string

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

        name

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

          Location : path

          Type : string

          Required : Yes

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

        updateMask

          Type : string

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

          Location : query

      Path : v1beta/{+name}:previewUpdate

      Description : Previews updating a GameServerCluster.

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

      Parameter Order : name

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

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

      Parameters :

        name

          Type : string

          Location : path

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

          Required : Yes

      Path : v1beta/{+name}

      Description : Deletes a single game server cluster.

      HTTP Method : DELETE

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

      HTTP Method : GET

      Parameter Order : name

      Description : Gets details of a single game server cluster.

      Path : v1beta/{+name}

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

      Parameters :

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

          • Type : string

          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.

          Location : query

        name

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

          Type : string

          Location : path

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

          Required : Yes

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

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

      Description : Previews deletion of a single game server cluster.

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

      Path : v1beta/{+name}:previewDelete

      Parameters :

        name

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

          Location : path

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

          Type : string

          Required : Yes

        previewTime

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

          Type : string

          Location : query

          Format : google-datetime

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

      Parameter Order : name

      HTTP Method : DELETE

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

      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.

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

      Parameters :

        previewTime

          Format : google-datetime

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

          Location : query

          Type : string

        view

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

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

          • Location : query

          Type : string

        gameServerClusterId

          Location : query

          Type : string

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

        parent

          Location : path

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

          Type : string

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

          Required : Yes

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

      Parameter Order : parent

      HTTP Method : POST

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

      Path : v1beta/{+parent}/gameServerClusters

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

      HTTP Method : GET

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

      Parameter Order : parent

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

      Parameters :

        parent

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

          Required : Yes

          Type : string

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

          Location : path

        pageToken

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

          Location : query

          Type : string

        filter

          Location : query

          Type : string

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

        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

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

          Format : int32

        view

          Location : query

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

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

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

      HTTP Method : PATCH

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

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

      Description : Patches a single game server cluster.

      Parameters :

        name

          Type : string

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

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

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

      Path : v1beta/{+name}

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

      Parameter Order : parent

      HTTP Method : POST

      Parameters :

        gameServerClusterId

          Type : string

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

          Location : query

        parent

          Location : path

          Type : string

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

          Required : Yes

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

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

      Path : v1beta/{+parent}/gameServerClusters

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

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

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

      HTTP Method : GET

      Description : Gets details of a single realm.

      Parameters :

        name

          Location : path

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

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

          Required : Yes

          Type : string

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

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

      Path : v1beta/{+name}

      Parameter Order : name

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

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

      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

        parent

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

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

          Type : string

          Required : Yes

          Location : path

        filter

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

          Type : string

          Location : query

        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.

          Type : integer

          Location : query

          Format : int32

        pageToken

          Type : string

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

          Location : query

      HTTP Method : GET

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

      Description : Lists realms in a given project and location.

      Path : v1beta/{+parent}/realms

      Parameter Order : parent

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

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

      Description : Previews patches to a single realm.

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

      Parameter Order : name

      Path : v1beta/{+name}:previewUpdate

      HTTP Method : PATCH

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

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

          Type : string

          Location : path

          Required : Yes

        previewTime

          Location : query

          Type : string

          Format : google-datetime

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

        updateMask

          Type : string

          Location : query

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

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

      HTTP Method : DELETE

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

      Parameter Order : name

      Parameters :

        name

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

          Required : Yes

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

          Type : string

          Location : path

      Path : v1beta/{+name}

      Description : Deletes a single realm.

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

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

      Path : v1beta/{+parent}/realms

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

      HTTP Method : POST

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

      Parameter Order : parent

      Parameters :

        parent

          Required : Yes

          Location : path

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

          Type : string

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

        realmId

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

          Type : string

          Location : query

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

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

      Parameter Order : name

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

      Path : v1beta/{+name}

      HTTP Method : PATCH

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

      Parameters :

        name

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

          Location : path

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

          Required : Yes

          Type : string

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

          Type : string

          Location : query

      Description : Patches a single realm.

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

      HTTP Method : GET

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

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

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

      Path : v1beta/{+parent}/configs

      Parameters :

        parent

          Required : Yes

          Location : path

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

          Type : string

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

        filter

          Location : query

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

          Type : string

        pageSize

          Location : query

          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.

          Format : int32

        pageToken

          Location : query

          Type : string

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

        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

      Parameter Order : parent

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

      Parameters :

        name

          Required : Yes

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

          Type : string

          Location : path

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

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

      Description : Gets details of a single game server config.

      Path : v1beta/{+name}

      Parameter Order : name

      HTTP Method : GET

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

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

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

      HTTP Method : DELETE

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

      Parameter Order : name

      Parameters :

        name

          Type : string

          Required : Yes

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

          Location : path

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

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

      Path : v1beta/{+name}

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

      HTTP Method : POST

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

      Parameter Order : parent

      Path : v1beta/{+parent}/configs

      Parameters :

        configId

          Location : query

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

          Type : string

        parent

          Location : path

          Required : Yes

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

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

          Type : string

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

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

      Parameter Order : name

      Path : v1beta/{+name}

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

      HTTP Method : DELETE

      Parameters :

        name

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

          Type : string

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

          Location : path

          Required : Yes

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

      Description : Deletes a single game server deployment.

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

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

      Parameters :

        deploymentId

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

          Location : query

          Type : string

        parent

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

          Required : Yes

          Location : path

          Type : string

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

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

      Parameter Order : parent

      HTTP Method : POST

      Path : v1beta/{+parent}/gameServerDeployments

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

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

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

      Path : v1beta/{+name}:fetchDeploymentState

      Parameter Order : name

      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.

      HTTP Method : POST

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

      Parameters :

        name

          Location : path

          Required : Yes

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

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

          Type : string

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

      Parameters :

        name

          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

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

          Type : string

          Location : path

        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

      Path : v1beta/{+name}/rollout

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

      HTTP Method : PATCH

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

      Parameter Order : name

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

      Path : v1beta/{+name}/rollout

      Parameter Order : name

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

      HTTP Method : GET

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

      Parameters :

        name

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

          Location : path

          Required : Yes

          Type : string

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

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

      Parameters :

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

          Location : query

          Type : string

          Format : google-fieldmask

        name

          Location : path

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

          Required : Yes

          Type : string

      Description : Patches a game server deployment.

      Path : v1beta/{+name}

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

      Parameter Order : name

      HTTP Method : PATCH

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

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

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

      HTTP Method : GET

      Description : Gets details of a single game server deployment.

      Path : v1beta/{+name}

      Parameter Order : name

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

          Location : path

          Required : Yes

          Type : string

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

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

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

      Parameter Order : name

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

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

      Parameters :

        name

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

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

          Type : string

          Required : Yes

        updateMask

          Type : string

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

          Format : google-fieldmask

        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

      HTTP Method : PATCH

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

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

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

      Path : v1beta/{+parent}/gameServerDeployments

      HTTP Method : GET

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

      Parameter Order : parent

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

      Parameters :

        filter

          Type : string

          Location : query

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

        parent

          Type : string

          Required : Yes

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

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

          Location : path

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

          Type : integer

          Format : int32

        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

27 removed methods

Deletions

    Methods

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

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

      HTTP Method : PATCH

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

      Parameter Order : name

      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.

      Parameters :

        updateMask

          Format : google-fieldmask

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

        name

          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

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

          Location : path

          Type : string

      Path : v1beta/{+name}/rollout

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

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

      Path : v1beta/{+name}

      HTTP Method : GET

      Description : Gets details of a single game server deployment.

      Parameter Order : name

      Parameters :

        name

          Required : Yes

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

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

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

      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.

      Parameter Order : name

      Path : v1beta/{+name}:fetchDeploymentState

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

      Parameters :

        name

          Type : string

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

          Location : path

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

          Required : Yes

      HTTP Method : POST

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

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

      HTTP Method : PATCH

      Parameter Order : name

      Parameters :

        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

        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

      Description : Patches a game server deployment.

      Path : v1beta/{+name}

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

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

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

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

      Parameter Order : parent

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

      Path : v1beta/{+parent}/gameServerDeployments

      Parameters :

        pageToken

          Location : query

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

          Type : string

        filter

          Location : query

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

          Type : string

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

          Type : integer

        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

        parent

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

          Location : path

          Required : Yes

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

          Type : string

      HTTP Method : GET

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

      HTTP Method : POST

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

      Parameter Order : parent

      Parameters :

        deploymentId

          Type : string

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

          Location : query

        parent

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

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

          Required : Yes

          Location : path

          Type : string

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

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

      Path : v1beta/{+parent}/gameServerDeployments

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

      Path : v1beta/{+name}

      Parameter Order : name

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

      Parameters :

        name

          Type : string

          Required : Yes

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

          Location : path

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

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

      Description : Deletes a single game server deployment.

      HTTP Method : DELETE

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

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

      HTTP Method : PATCH

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

      Parameters :

        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

          Type : string

          Location : query

        name

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

          Required : Yes

          Type : string

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

        previewTime

          Format : google-datetime

          Type : string

          Location : query

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

      Parameter Order : name

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

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

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

      Parameters :

        name

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

          Type : string

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

          Location : path

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

      HTTP Method : GET

      Parameter Order : name

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

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

      Path : v1beta/{+name}/rollout

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

      Path : v1beta/{+parent}/configs

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

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

      HTTP Method : POST

      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.

      Parameters :

        configId

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

          Type : string

          Location : query

        parent

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

          Type : string

          Required : Yes

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

          Location : path

      Parameter Order : parent

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

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

      Parameters :

        name

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

          Required : Yes

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

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

      Path : v1beta/{+name}

      HTTP Method : DELETE

      Parameter Order : name

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

      Parameters :

        name

          Location : path

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

          Required : Yes

          Type : string

      HTTP Method : GET

      Parameter Order : name

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

      Path : v1beta/{+name}

      Description : Gets details of a single game server config.

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

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

      Path : v1beta/{+parent}/configs

      Parameters :

        filter

          Type : string

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

          Location : query

        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.

          Type : integer

          Location : query

          Format : int32

        parent

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

          Location : path

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

          Required : Yes

          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

        pageToken

          Location : query

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

          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.

      HTTP Method : GET

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

      Parameter Order : parent

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

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

      Description : Deletes a single game server cluster.

      Parameter Order : name

      HTTP Method : DELETE

      Parameters :

        name

          Type : string

          Location : path

          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

      Path : v1beta/{+name}

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

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

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

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

      Parameters :

        parent

          Required : Yes

          Type : string

          Location : path

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

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

        previewTime

          Format : google-datetime

          Location : query

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

          Type : string

        gameServerClusterId

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

          Type : string

          Location : query

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

          • Type : string

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

          Enum :

        • GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED
        • BASIC
        • FULL

          • Location : query

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

      HTTP Method : POST

      Parameter Order : parent

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

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

      HTTP Method : GET

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

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

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

      Path : v1beta/{+parent}/gameServerClusters

      Parameters :

        pageSize

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

          Location : query

          Format : int32

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

        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

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

        view

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

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

        • GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED
        • BASIC
        • FULL

      Parameter Order : parent

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

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

      HTTP Method : PATCH

      Description : Previews updating a GameServerCluster.

      Parameter Order : name

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

      Path : v1beta/{+name}:previewUpdate

      Parameters :

        previewTime

          Location : query

          Format : google-datetime

          Type : string

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

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

          Type : string

          Format : google-fieldmask

          Location : query

        name

          Location : path

          Required : Yes

          Type : string

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

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

      Parameter Order : name

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

      Parameters :

        view

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

          • Type : string

          Enum :

        • GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED
        • BASIC
        • FULL

        name

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

          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

          Location : path

      Path : v1beta/{+name}

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

      HTTP Method : GET

      Description : Gets details of a single game server cluster.

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

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

      Parameters :

        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

          Format : google-fieldmask

          Location : query

        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

      Path : v1beta/{+name}

      Parameter Order : name

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

      Description : Patches a single game server cluster.

      HTTP Method : PATCH

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

      HTTP Method : DELETE

      Description : Previews deletion of a single game server cluster.

      Path : v1beta/{+name}:previewDelete

      Parameter Order : name

      Parameters :

        previewTime

          Type : string

          Format : google-datetime

          Location : query

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

        name

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

          Required : Yes

          Location : path

          Type : string

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

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

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

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

      Path : v1beta/{+parent}/gameServerClusters

      HTTP Method : POST

      Parameter Order : parent

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

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

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

      Parameters :

        parent

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

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

          Type : string

          Location : path

          Required : Yes

        gameServerClusterId

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

          Location : query

          Type : string

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

      Parameters :

        pageSize

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

          Type : integer

        filter

          Location : query

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

          Type : string

        parent

          Location : path

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

          Required : Yes

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

          Type : string

        pageToken

          Location : query

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

          Type : string

        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

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

      Path : v1beta/{+parent}/realms

      Parameter Order : parent

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

      HTTP Method : GET

      Description : Lists realms in a given project and location.

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

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

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

      Parameter Order : name

      Description : Patches a single realm.

      HTTP Method : PATCH

      Parameters :

        name

          Required : Yes

          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

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

          Type : string

          Location : query

      Path : v1beta/{+name}

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

      Description : Deletes a single realm.

      Parameter Order : name

      HTTP Method : DELETE

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

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

      Path : v1beta/{+name}

      Parameters :

        name

          Required : Yes

          Type : string

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

          Location : path

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

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

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

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

      Parameter Order : parent

      HTTP Method : POST

      Parameters :

        parent

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

          Required : Yes

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

          Location : path

          Type : string

        realmId

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

          Location : query

          Type : string

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

      Path : v1beta/{+parent}/realms

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

      Parameter Order : name

      Path : v1beta/{+name}

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

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

      Description : Gets details of a single realm.

      HTTP Method : GET

      Parameters :

        name

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

          Required : Yes

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

      Path : v1beta/{+name}:previewUpdate

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

      Parameter Order : name

      Description : Previews patches to a single realm.

      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

        previewTime

          Format : google-datetime

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

          Type : string

          Location : query

        name

          Location : path

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

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

          Required : Yes

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

      HTTP Method : PATCH