GameServerConfigsServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gaming_v1.services.game_server_configs_service.transports.base.GameServerConfigsServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-game-servers/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
The game server config configures the game servers in an Agones fleet.
Inheritance
builtins.object > GameServerConfigsServiceAsyncClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
GameServerConfigsServiceTransport | The transport used by the client instance. |
Methods
GameServerConfigsServiceAsyncClient
GameServerConfigsServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gaming_v1.services.game_server_configs_service.transports.base.GameServerConfigsServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-game-servers/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the game server configs service client.
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, `.GameServerConfigsServiceTransport`]
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 |
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_config
create_game_server_config(request: Optional[google.cloud.gaming_v1.types.game_server_configs.CreateGameServerConfigRequest] = None, *, parent: Optional[str] = None, game_server_config: Optional[google.cloud.gaming_v1.types.game_server_configs.GameServerConfig] = 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 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.
Name | Description |
request |
CreateGameServerConfigRequest
The request object. Request message for GameServerConfigsService.CreateGameServerConfig. |
parent |
`str`
Required. The parent resource name. Uses the form: |
game_server_config |
GameServerConfig
Required. The game server config 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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be GameServerConfig A game server config resource. |
delete_game_server_config
delete_game_server_config(request: Optional[google.cloud.gaming_v1.types.game_server_configs.DeleteGameServerConfigRequest] = 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 config. The deletion will fail if the game server config is referenced in a game server deployment rollout.
Name | Description |
request |
DeleteGameServerConfigRequest
The request object. Request message for GameServerConfigsService.DeleteGameServerConfig. |
name |
`str`
Required. The name of the game server config 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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
GameServerConfigsServiceAsyncClient | 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.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
GameServerConfigsServiceAsyncClient | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
GameServerConfigsServiceAsyncClient | The constructed client. |
game_server_config_path
game_server_config_path(project: str, location: str, deployment: str, config: str)
Returns a fully-qualified game_server_config string.
get_game_server_config
get_game_server_config(request: Optional[google.cloud.gaming_v1.types.game_server_configs.GetGameServerConfigRequest] = 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 config.
Name | Description |
request |
GetGameServerConfigRequest
The request object. Request message for GameServerConfigsService.GetGameServerConfig. |
name |
`str`
Required. The name of the game server config 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. |
Type | Description |
google.cloud.gaming_v1.types.GameServerConfig | A game server config resource. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
list_game_server_configs
list_game_server_configs(request: Optional[google.cloud.gaming_v1.types.game_server_configs.ListGameServerConfigsRequest] = 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 configs in a given project, location, and game server deployment.
Name | Description |
request |
ListGameServerConfigsRequest
The request object. Request message for GameServerConfigsService.ListGameServerConfigs. |
parent |
`str`
Required. The parent resource name. 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. |
Type | Description |
google.cloud.gaming_v1.services.game_server_configs_service.pagers.ListGameServerConfigsAsyncPager | Response message for GameServerConfigsService.ListGameServerConfigs. 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_config_path
parse_game_server_config_path(path: str)
Parses a game_server_config path into its component segments.