GameServerClustersServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gaming_v1.services.game_server_clusters_service.transports.base.GameServerClustersServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
The game server cluster maps to Kubernetes clusters running Agones and is used to manage fleets within clusters.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
GameServerClustersServiceTransport | The transport used by the client instance. |
Methods
GameServerClustersServiceClient
GameServerClustersServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gaming_v1.services.game_server_clusters_service.transports.base.GameServerClustersServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates 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, GameServerClustersServiceTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_game_server_cluster
create_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.CreateGameServerClusterRequest, dict]] = 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 |
Union[google.cloud.gaming_v1.types.CreateGameServerClusterRequest, dict]
The request object. Request message for GameServerClustersService.CreateGameServerCluster. |
parent |
str
Required. The parent resource name, in the following form: |
game_server_cluster |
google.cloud.gaming_v1.types.GameServerCluster
Required. The game server cluster resource to be created. This corresponds to the |
game_server_cluster_id |
str
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 |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be GameServerCluster A game server cluster resource. |
delete_game_server_cluster
delete_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.DeleteGameServerClusterRequest, dict]] = 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 |
Union[google.cloud.gaming_v1.types.DeleteGameServerClusterRequest, dict]
The request object. Request message for GameServerClustersService.DeleteGameServerCluster. |
name |
str
Required. The name of the game server cluster to delete, in the following 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 |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for 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 |
GameServerClustersServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
GameServerClustersServiceClient | 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 |
GameServerClustersServiceClient | The constructed client. |
game_server_cluster_path
game_server_cluster_path(project: str, location: str, realm: str, cluster: str)
Returns a fully-qualified game_server_cluster string.
get_game_server_cluster
get_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.GetGameServerClusterRequest, dict]] = 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 |
Union[google.cloud.gaming_v1.types.GetGameServerClusterRequest, dict]
The request object. Request message for GameServerClustersService.GetGameServerCluster. |
name |
str
Required. The name of the game server cluster to retrieve, in the following 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 |
google.cloud.gaming_v1.types.GameServerCluster | A game server cluster resource. |
list_game_server_clusters
list_game_server_clusters(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.ListGameServerClustersRequest, dict]] = 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 |
Union[google.cloud.gaming_v1.types.ListGameServerClustersRequest, dict]
The request object. Request message for GameServerClustersService.ListGameServerClusters. |
parent |
str
Required. The parent resource name, in the following 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 |
google.cloud.gaming_v1.services.game_server_clusters_service.pagers.ListGameServerClustersPager | Response message for GameServerClustersService.ListGameServerClusters. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_game_server_cluster_path
parse_game_server_cluster_path(path: str)
Parses a game_server_cluster path into its component segments.
preview_create_game_server_cluster
preview_create_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.PreviewCreateGameServerClusterRequest, dict]] = 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 |
Union[google.cloud.gaming_v1.types.PreviewCreateGameServerClusterRequest, dict]
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 |
google.cloud.gaming_v1.types.PreviewCreateGameServerClusterResponse | Response message for GameServerClustersService.PreviewCreateGameServerCluster. |
preview_delete_game_server_cluster
preview_delete_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.PreviewDeleteGameServerClusterRequest, dict]] = 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 |
Union[google.cloud.gaming_v1.types.PreviewDeleteGameServerClusterRequest, dict]
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 |
google.cloud.gaming_v1.types.PreviewDeleteGameServerClusterResponse | Response message for GameServerClustersService.PreviewDeleteGameServerCluster. |
preview_update_game_server_cluster
preview_update_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.PreviewUpdateGameServerClusterRequest, dict]] = 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 |
Union[google.cloud.gaming_v1.types.PreviewUpdateGameServerClusterRequest, dict]
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 |
google.cloud.gaming_v1.types.PreviewUpdateGameServerClusterResponse | Response message for GameServerClustersService.PreviewUpdateGameServerCluster |
update_game_server_cluster
update_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.UpdateGameServerClusterRequest, dict]] = 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 |
Union[google.cloud.gaming_v1.types.UpdateGameServerClusterRequest, dict]
The request object. Request message for GameServerClustersService.UpdateGameServerCluster. |
game_server_cluster |
google.cloud.gaming_v1.types.GameServerCluster
Required. The game server cluster to be updated. Only fields specified in update_mask are updated. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
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 |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be GameServerCluster A game server cluster resource. |