GameServerClustersServiceClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gaming_v1.services.game_server_clusters_service.transports.base.GameServerClustersServiceTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-game-servers/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)
The game server cluster maps to Kubernetes clusters running Agones and is used to manage fleets within clusters.
Methods
GameServerClustersServiceClient
GameServerClustersServiceClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gaming_v1.services.game_server_clusters_service.transports.base.GameServerClustersServiceTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-game-servers/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)
Instantiate the game server clusters service client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
create_game_server_cluster
create_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.CreateGameServerClusterRequest] = None, *, parent: Optional[str] = None, game_server_cluster: Optional[google.cloud.gaming_v1.types.game_server_clusters.GameServerCluster] = None, game_server_cluster_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new game server cluster in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for GameServerClustersService.CreateGameServerCluster. |
parent |
Required. The parent resource name. Uses the form: |
game_server_cluster |
Required. The game server cluster resource to be created. This corresponds to the |
game_server_cluster_id |
Required. The ID of the game server cluster resource to be created. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| An object representing a long-running operation. The result type for the operation will be .game_server_clusters.GameServerCluster |
delete_game_server_cluster
delete_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.DeleteGameServerClusterRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a single game server cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for GameServerClustersService.DeleteGameServerCluster. |
name |
Required. The name of the game server cluster to delete. Uses the form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| An object representing a long-running operation. The result type for the operation will be .empty.Empty Empty is empty JSON object {} . |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
{@api.name} | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
{@api.name} | The constructed client. |
game_server_cluster_path
game_server_cluster_path(project: str, location: str, realm: str, cluster: str)
Return a fully-qualified game_server_cluster string.
get_game_server_cluster
get_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.GetGameServerClusterRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets details of a single game server cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for GameServerClustersService.GetGameServerCluster. |
name |
Required. The name of the game server cluster to retrieve. Uses the form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| A game server cluster resource. |
list_game_server_clusters
list_game_server_clusters(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.ListGameServerClustersRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists game server clusters in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for GameServerClustersService.ListGameServerClusters. |
parent |
Required. The parent resource name. Uses the form: "projects/{project}/locations/{location}/realms/{realm}". This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Response message for GameServerClustersService.ListGameServerClusters. Iterating over this object will yield results and resolve additional pages automatically. |
parse_game_server_cluster_path
parse_game_server_cluster_path(path: str)
Parse a game_server_cluster path into its component segments.
preview_create_game_server_cluster
preview_create_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.PreviewCreateGameServerClusterRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Previews creation of a new game server cluster in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for GameServerClustersService.PreviewCreateGameServerCluster. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Response message for GameServerClustersService.PreviewCreateGameServerCluster. |
preview_delete_game_server_cluster
preview_delete_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.PreviewDeleteGameServerClusterRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Previews deletion of a single game server cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for GameServerClustersService.PreviewDeleteGameServerCluster. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Response message for GameServerClustersService.PreviewDeleteGameServerCluster. |
preview_update_game_server_cluster
preview_update_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.PreviewUpdateGameServerClusterRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Previews updating a GameServerCluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for GameServerClustersService.UpdateGameServerCluster. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Response message for GameServerClustersService.PreviewUpdateGameServerCluster |
update_game_server_cluster
update_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.UpdateGameServerClusterRequest] = None, *, game_server_cluster: Optional[google.cloud.gaming_v1.types.game_server_clusters.GameServerCluster] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Patches a single game server cluster.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for GameServerClustersService.UpdateGameServerCluster. |
game_server_cluster |
Required. The game server cluster to be updated. Only fields specified in update_mask are updated. This corresponds to the |
update_mask |
Required. Mask of fields to update. At least one path must be supplied in this field. For the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| An object representing a long-running operation. The result type for the operation will be .game_server_clusters.GameServerCluster |