GameServerConfigsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gaming_v1.services.game_server_configs_service.transports.base.GameServerConfigsServiceTransport]] = 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 config configures the game servers in an Agones fleet.
Inheritance
builtins.object > GameServerConfigsServiceClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
GameServerConfigsServiceTransport | The transport used by the client instance. |
Methods
GameServerConfigsServiceClient
GameServerConfigsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gaming_v1.services.game_server_configs_service.transports.base.GameServerConfigsServiceTransport]] = 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 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 |
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 |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
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[Union[google.cloud.gaming_v1.types.game_server_configs.CreateGameServerConfigRequest, dict]] = None, *, parent: Optional[str] = None, game_server_config: Optional[google.cloud.gaming_v1.types.game_server_configs.GameServerConfig] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gaming_v1
def sample_create_game_server_config():
# Create a client
client = gaming_v1.GameServerConfigsServiceClient()
# Initialize request argument(s)
request = gaming_v1.CreateGameServerConfigRequest(
parent="parent_value",
config_id="config_id_value",
)
# Make the request
operation = client.create_game_server_config(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.gaming_v1.types.CreateGameServerConfigRequest, dict]
The request object. Request message for GameServerConfigsService.CreateGameServerConfig. |
parent |
str
Required. The parent resource name, in the following form: |
game_server_config |
google.cloud.gaming_v1.types.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.Operation | 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[Union[google.cloud.gaming_v1.types.game_server_configs.DeleteGameServerConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gaming_v1
def sample_delete_game_server_config():
# Create a client
client = gaming_v1.GameServerConfigsServiceClient()
# Initialize request argument(s)
request = gaming_v1.DeleteGameServerConfigRequest(
name="name_value",
)
# Make the request
operation = client.delete_game_server_config(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.gaming_v1.types.DeleteGameServerConfigRequest, dict]
The request object. Request message for GameServerConfigsService.DeleteGameServerConfig. |
name |
str
Required. The name of the game server config 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. |
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); } |
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 |
GameServerConfigsServiceClient | 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 |
GameServerConfigsServiceClient | 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 |
GameServerConfigsServiceClient | 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[Union[google.cloud.gaming_v1.types.game_server_configs.GetGameServerConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets details of a single game server config.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gaming_v1
def sample_get_game_server_config():
# Create a client
client = gaming_v1.GameServerConfigsServiceClient()
# Initialize request argument(s)
request = gaming_v1.GetGameServerConfigRequest(
name="name_value",
)
# Make the request
response = client.get_game_server_config(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.gaming_v1.types.GetGameServerConfigRequest, dict]
The request object. Request message for GameServerConfigsService.GetGameServerConfig. |
name |
str
Required. The name of the game server config 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. |
Type | Description |
google.cloud.gaming_v1.types.GameServerConfig | A game server config resource. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
list_game_server_configs
list_game_server_configs(request: Optional[Union[google.cloud.gaming_v1.types.game_server_configs.ListGameServerConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gaming_v1
def sample_list_game_server_configs():
# Create a client
client = gaming_v1.GameServerConfigsServiceClient()
# Initialize request argument(s)
request = gaming_v1.ListGameServerConfigsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_game_server_configs(request=request)
# Handle the response
for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.gaming_v1.types.ListGameServerConfigsRequest, dict]
The request object. Request message for GameServerConfigsService.ListGameServerConfigs. |
parent |
str
Required. The parent resource name, 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. |
Type | Description |
google.cloud.gaming_v1.services.game_server_configs_service.pagers.ListGameServerConfigsPager | 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.