Class GameServerDeploymentsServiceClient (1.7.1)

The game server deployment is used to control the deployment of Agones fleets.

Returns the transport used by the client instance.

Instantiates the game server deployments service client.

Releases underlying transport's resources.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates a new game server deployment in a given project and location.

# 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_deployment():
    # Create a client
    client = gaming_v1.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1.CreateGameServerDeploymentRequest(
        parent="parent_value",
        deployment_id="deployment_id_value",
    )

    # Make the request
    operation = client.create_game_server_deployment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Deletes a single 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_delete_game_server_deployment():
    # Create a client
    client = gaming_v1.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1.DeleteGameServerDeploymentRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_game_server_deployment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the 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_fetch_deployment_state():
    # Create a client
    client = gaming_v1.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1.FetchDeploymentStateRequest(
        name="name_value",
    )

    # Make the request
    response = client.fetch_deployment_state(request=request)

    # Handle the response
    print(response)

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

Returns a fully-qualified game_server_deployment string.

Returns a fully-qualified game_server_deployment_rollout string.

Gets details of a single 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_get_game_server_deployment():
    # Create a client
    client = gaming_v1.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1.GetGameServerDeploymentRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_game_server_deployment(request=request)

    # Handle the response
    print(response)

Gets details a single 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_get_game_server_deployment_rollout():
    # Create a client
    client = gaming_v1.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1.GetGameServerDeploymentRolloutRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_game_server_deployment_rollout(request=request)

    # Handle the response
    print(response)

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 variable 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.

Lists game server deployments in a given project and location.

# 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_deployments():
    # Create a client
    client = gaming_v1.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1.ListGameServerDeploymentsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_game_server_deployments(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a game_server_deployment path into its component segments.

Parses a game_server_deployment_rollout path into its component segments.

Previews the game server deployment rollout. This API does not mutate the 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_preview_game_server_deployment_rollout():
    # Create a client
    client = gaming_v1.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1.PreviewGameServerDeploymentRolloutRequest(
    )

    # Make the request
    response = client.preview_game_server_deployment_rollout(request=request)

    # Handle the response
    print(response)

Patches a 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_update_game_server_deployment():
    # Create a client
    client = gaming_v1.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1.UpdateGameServerDeploymentRequest(
    )

    # Make the request
    operation = client.update_game_server_deployment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

# 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_update_game_server_deployment_rollout():
    # Create a client
    client = gaming_v1.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1.UpdateGameServerDeploymentRolloutRequest(
    )

    # Make the request
    operation = client.update_game_server_deployment_rollout(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)