Class GameServerConfigsServiceAsyncClient (0.3.0)

GameServerConfigsServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gaming_v1beta.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.9/site-packages/google/api_core/client_options.py'> = None)

The game server config configures the game servers in an Agones fleet.

Methods

GameServerConfigsServiceAsyncClient

GameServerConfigsServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gaming_v1beta.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.9/site-packages/google/api_core/client_options.py'> = None)

Instantiate the game server configs 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, .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 `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the `api_endpoint` property takes precedence if provided. (2) The `client_cert_source` property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

create_game_server_config

create_game_server_config(request: Optional[google.cloud.gaming_v1beta.types.game_server_configs.CreateGameServerConfigRequest] = None, *, parent: Optional[str] = None, game_server_config: Optional[google.cloud.gaming_v1beta.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.

Parameters
Name	Description
`request`	`.game_server_configs.CreateGameServerConfigRequest` The request object. Request message for GameServerConfigsService.CreateGameServerConfig.
`parent`	`str` Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`game_server_config`	`.game_server_configs.GameServerConfig` Required. The game server config resource to be created. This corresponds to the `game_server_config` field on the `request` instance; if `request` is provided, this should not be set.
`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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .game_server_configs.GameServerConfig : A game server config resource.

delete_game_server_config

delete_game_server_config(request: Optional[google.cloud.gaming_v1beta.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.

Parameters
Name	Description
`request`	`.game_server_configs.DeleteGameServerConfigRequest` The request object. Request message for GameServerConfigsService.DeleteGameServerConfig.
`name`	`str` Required. The name of the game server config to delete. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`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

.operation_async.AsyncOperation

An object representing a long-running operation. The result type for the operation will be

.empty.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
`{@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_config_path

game_server_config_path(project: str, location: str, deployment: str, config: str)

Return a fully-qualified game_server_config string.

get_game_server_config

get_game_server_config(request: Optional[google.cloud.gaming_v1beta.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.

Parameters
Name	Description
`request`	`.game_server_configs.GetGameServerConfigRequest` The request object. Request message for GameServerConfigsService.GetGameServerConfig.
`name`	`str` Required. The name of the game server config to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`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
`.game_server_configs.GameServerConfig`	A game server config resource.

get_transport_class

get_transport_class()

Return an appropriate transport class.

list_game_server_configs

list_game_server_configs(request: Optional[google.cloud.gaming_v1beta.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.

Parameters
Name	Description
`request`	`.game_server_configs.ListGameServerConfigsRequest` The request object. Request message for GameServerConfigsService.ListGameServerConfigs.
`parent`	`str` Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`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
`.pagers.ListGameServerConfigsAsyncPager`	Response message for GameServerConfigsService.ListGameServerConfigs. Iterating over this object will yield results and resolve additional pages automatically.