delete(name, x__xgafv=None)
Deletes a single game server cluster.
+get(name, view=None, x__xgafv=None)
Gets details of a single game server cluster.
- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists game server clusters in a given project and location.
list_next(previous_request, previous_response)
patch(name, body=None, updateMask=None, x__xgafv=None)
Patches a single game server cluster.
- previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)
previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, view=None, x__xgafv=None)
Previews creation of a new game server cluster in a given project and location.
previewDelete(name, previewTime=None, x__xgafv=None)
get(name, x__xgafv=None)
+ get(name, view=None, x__xgafv=None)
Gets details of a single game server cluster.
Args:
name: string, Required. The name of the game server cluster to retrieve, in the following form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. (required)
+ view: string, 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, same as BASIC, which does not return the `cluster_state` field.
+ Allowed values
+ GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
+ BASIC - Include basic information of a GameServerCluster resource and omit `cluster_state`. This is the default value (for ListGameServerClusters, GetGameServerCluster and PreviewCreateGameServerCluster).
+ FULL - Include everything.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -216,6 +229,14 @@ Method Details
An object of the form:
{ # A game server cluster resource.
+ "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request.
+ "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster.
+ "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster.
+ "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes.
+ "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).
+ "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.
+ "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes.
+ },
"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
@@ -234,7 +255,7 @@ Method Details
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists game server clusters in a given project and location. Args: @@ -243,6 +264,11 @@Method Details
orderBy: string, Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order. pageSize: integer, Optional. The maximum number of items to return. If unspecified, the server will pick 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. pageToken: string, Optional. The next_page_token value returned from a previous List request, if any. + view: string, 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, same as BASIC, which does not return the `cluster_state` field. + Allowed values + GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. + BASIC - Include basic information of a GameServerCluster resource and omit `cluster_state`. This is the default value (for ListGameServerClusters, GetGameServerCluster and PreviewCreateGameServerCluster). + FULL - Include everything. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -254,6 +280,14 @@Method Details
{ # Response message for GameServerClustersService.ListGameServerClusters. "gameServerClusters": [ # The list of game server clusters. { # A game server cluster resource. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters. "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed. "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster. @@ -301,6 +335,14 @@Method Details
The object takes the form of: { # A game server cluster resource. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters. "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed. "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster. @@ -348,7 +390,7 @@Method Details
previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)
+ previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, view=None, x__xgafv=None)
Previews creation of a new game server cluster in a given project and location. Args: @@ -357,6 +399,14 @@Method Details
The object takes the form of: { # A game server cluster resource. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters. "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed. "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster. @@ -375,6 +425,11 @@Method Details
gameServerClusterId: string, Required. The ID of the game server cluster resource to be created. previewTime: string, Optional. The target timestamp to compute the preview. + view: string, Optional. This field is deprecated, preview will always return KubernetesClusterState. + Allowed values + GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. + BASIC - Include basic information of a GameServerCluster resource and omit `cluster_state`. This is the default value (for ListGameServerClusters, GetGameServerCluster and PreviewCreateGameServerCluster). + FULL - Include everything. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -384,6 +439,14 @@Method Details
An object of the form: { # Response message for GameServerClustersService.PreviewCreateGameServerCluster. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster in preview, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "etag": "A String", # The ETag of the game server cluster. "targetState": { # Encapsulates the Target state. # The target state. "details": [ # Details about Agones fleets. @@ -470,6 +533,14 @@Method Details
The object takes the form of: { # A game server cluster resource. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters. "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed. "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster. diff --git a/googleapiclient/discovery_cache/documents/gameservices.v1.json b/googleapiclient/discovery_cache/documents/gameservices.v1.json index 2583d85a33b..1c28e39b5e2 100644 --- a/googleapiclient/discovery_cache/documents/gameservices.v1.json +++ b/googleapiclient/discovery_cache/documents/gameservices.v1.json @@ -1103,6 +1103,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Optional. View for the returned GameServerCluster objects. When `FULL` is specified, the `cluster_state` field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the `cluster_state` field.", + "enum": [ + "GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "The default / unset value. The API will default to the BASIC view.", + "Include basic information of a GameServerCluster resource and omit `cluster_state`. This is the default value (for ListGameServerClusters, GetGameServerCluster and PreviewCreateGameServerCluster).", + "Include everything." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+name}", @@ -1149,6 +1164,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Optional. View for the returned GameServerCluster objects. When `FULL` is specified, the `cluster_state` field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the `cluster_state` field.", + "enum": [ + "GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "The default / unset value. The API will default to the BASIC view.", + "Include basic information of a GameServerCluster resource and omit `cluster_state`. This is the default value (for ListGameServerClusters, GetGameServerCluster and PreviewCreateGameServerCluster).", + "Include everything." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/gameServerClusters", @@ -1219,6 +1249,21 @@ "format": "google-datetime", "location": "query", "type": "string" + }, + "view": { + "description": "Optional. This field is deprecated, preview will always return KubernetesClusterState.", + "enum": [ + "GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "The default / unset value. The API will default to the BASIC view.", + "Include basic information of a GameServerCluster resource and omit `cluster_state`. This is the default value (for ListGameServerClusters, GetGameServerCluster and PreviewCreateGameServerCluster).", + "Include everything." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/gameServerClusters:previewCreate", @@ -1312,7 +1357,7 @@ } } }, - "revision": "20210622", + "revision": "20210714", "rootUrl": "https://gameservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -1765,6 +1810,11 @@ "description": "A game server cluster resource.", "id": "GameServerCluster", "properties": { + "clusterState": { + "$ref": "KubernetesClusterState", + "description": "Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request.", + "readOnly": true + }, "connectionInfo": { "$ref": "GameServerClusterConnectionInfo", "description": "The game server cluster connection information. This information is used to manage game server clusters." @@ -1968,6 +2018,63 @@ }, "type": "object" }, + "KubernetesClusterState": { + "description": "The state of the Kubernetes cluster.", + "id": "KubernetesClusterState", + "properties": { + "agonesVersionInstalled": { + "description": "Output only. The version of Agones currently installed in the registered Kubernetes cluster.", + "readOnly": true, + "type": "string" + }, + "agonesVersionTargeted": { + "description": "Output only. The version of Agones that is targeted to be installed in the cluster.", + "readOnly": true, + "type": "string" + }, + "installationState": { + "description": "Output only. The state for the installed versions of Agones/Kubernetes.", + "enum": [ + "INSTALLATION_STATE_UNSPECIFIED", + "AGONES_KUBERNETES_VERSION_SUPPORTED", + "AGONES_VERSION_UNSUPPORTED", + "AGONES_KUBERNETES_VERSION_UNSUPPORTED", + "AGONES_VERSION_UNRECOGNIZED", + "KUBERNETES_VERSION_UNRECOGNIZED", + "VERSION_VERIFICATION_FAILED", + "AGONES_NOT_INSTALLED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The combination of Agones and Kubernetes versions is supported by Google Cloud Game Servers.", + "The installed version of Agones is not supported by Google Cloud Game Servers.", + "The installed version of Agones is supported by Google Cloud Game Servers, but the installed version of Kubernetes is not recommended or supported by the version of Agones.", + "The installed version of Agones is not recognized because the Agones controller's image name does not have a version string reported as {major}.{minor}(.{patch}).", + "The server version of Kubernetes cluster is not recognized because the API server didn't return parsable version info on path/version.", + "Failed to read or verify the version of Agones or Kubernetes. See version_installed_error_message for details.", + "Agones is not installed." + ], + "readOnly": true, + "type": "string" + }, + "kubernetesVersionInstalled": { + "description": "Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).", + "readOnly": true, + "type": "string" + }, + "provider": { + "description": "Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.", + "readOnly": true, + "type": "string" + }, + "versionInstalledErrorMessage": { + "description": "Output only. The detailed error message for the installed versions of Agones/Kubernetes.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "LabelSelector": { "description": "The label selector, used to group labels on the resources.", "id": "LabelSelector", @@ -2342,6 +2449,11 @@ "description": "Response message for GameServerClustersService.PreviewCreateGameServerCluster.", "id": "PreviewCreateGameServerClusterResponse", "properties": { + "clusterState": { + "$ref": "KubernetesClusterState", + "description": "Output only. The state of the Kubernetes cluster in preview, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request.", + "readOnly": true + }, "etag": { "description": "The ETag of the game server cluster.", "type": "string"