As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

GameServerDeploymentsService

class google.cloud.gaming_v1beta.services.game_server_deployments_service.GameServerDeploymentsServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.gaming_v1beta.services.game_server_deployments_service.transports.base.GameServerDeploymentsServiceTransport] = 'grpc_asyncio', 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>)[source]

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

Instantiates the game server deployments service client.

Parameters

  • 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, GameServerDeploymentsServiceTransport]) – 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_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static common_billing_account_path(billing_account: str) → str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str

Returns a fully-qualified organization string.

static common_project_path(project: str) → str

Returns a fully-qualified project string.

async create_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.CreateGameServerDeploymentRequest, dict]] = None, *, parent: Optional[str] = None, game_server_deployment: Optional[google.cloud.gaming_v1beta.types.game_server_deployments.GameServerDeployment] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

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_v1beta

async def sample_create_game_server_deployment():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceAsyncClient()

    # Initialize request argument(s)
    request = gaming_v1beta.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 = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gaming_v1beta.types.CreateGameServerDeploymentRequest, dict]]) – The request object. Request message for GameServerDeploymentsService.CreateGameServerDeployment.

  • parent (str) –

    Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • game_server_deployment (google.cloud.gaming_v1beta.types.GameServerDeployment) –

    Required. The game server delpoyment resource to be created.

    This corresponds to the game_server_deployment 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gaming_v1beta.types.GameServerDeployment A game server deployment resource.

Return type

google.api_core.operation_async.AsyncOperation

async delete_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.DeleteGameServerDeploymentRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

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_v1beta

async def sample_delete_game_server_deployment():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceAsyncClient()

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

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gaming_v1beta.types.DeleteGameServerDeploymentRequest, dict]]) – The request object. Request message for GameServerDeploymentsService.DeleteGameServerDeployment.

  • name (str) –

    Required. The name of the game server delpoyment to delete. Uses the form:

    projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

    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

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);

}

Return type

google.api_core.operation_async.AsyncOperation

async fetch_deployment_state(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.FetchDeploymentStateRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gaming_v1beta.types.game_server_deployments.FetchDeploymentStateResponse[source]

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_v1beta

async def sample_fetch_deployment_state():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters
Returns

Response message for GameServerDeploymentsService.FetchDeploymentState.

Return type

google.cloud.gaming_v1beta.types.FetchDeploymentStateResponse

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GameServerDeploymentsServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GameServerDeploymentsServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GameServerDeploymentsServiceAsyncClient

static game_server_deployment_path(project: str, location: str, deployment: str) → str

Returns a fully-qualified game_server_deployment string.

static game_server_deployment_rollout_path(project: str, location: str, deployment: str) → str

Returns a fully-qualified game_server_deployment_rollout string.

async get_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.GetGameServerDeploymentRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gaming_v1beta.types.game_server_deployments.GameServerDeployment[source]

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_v1beta

async def sample_get_game_server_deployment():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gaming_v1beta.types.GetGameServerDeploymentRequest, dict]]) – The request object. Request message for GameServerDeploymentsService.GetGameServerDeployment.

  • name (str) –

    Required. The name of the game server delpoyment to retrieve. Uses the form:

    projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

    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

A game server deployment resource.

Return type

google.cloud.gaming_v1beta.types.GameServerDeployment

async get_game_server_deployment_rollout(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.GetGameServerDeploymentRolloutRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gaming_v1beta.types.game_server_deployments.GameServerDeploymentRollout[source]

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_v1beta

async def sample_get_game_server_deployment_rollout():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gaming_v1beta.types.GetGameServerDeploymentRolloutRequest, dict]]) – The request object. Request message for GameServerDeploymentsService.GetGameServerDeploymentRollout.

  • name (str) –

    Required. The name of the game server delpoyment to retrieve. Uses the form:

    projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout.

    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

The game server deployment rollout which represents the desired rollout state.

Return type

google.cloud.gaming_v1beta.types.GameServerDeploymentRollout

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_transport_class() → Type[google.cloud.gaming_v1beta.services.game_server_deployments_service.transports.base.GameServerDeploymentsServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async list_game_server_deployments(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.ListGameServerDeploymentsRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gaming_v1beta.services.game_server_deployments_service.pagers.ListGameServerDeploymentsAsyncPager[source]

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_v1beta

async def sample_list_game_server_deployments():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceAsyncClient()

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

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

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

  • request (Optional[Union[google.cloud.gaming_v1beta.types.ListGameServerDeploymentsRequest, dict]]) – The request object. Request message for GameServerDeploymentsService.ListGameServerDeployments.

  • parent (str) –

    Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

    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

Response message for GameServerDeploymentsService.ListGameServerDeployments. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.gaming_v1beta.services.game_server_deployments_service.pagers.ListGameServerDeploymentsAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]

Parse a project path into its component segments.

static parse_game_server_deployment_path(path: str) → Dict[str, str]

Parses a game_server_deployment path into its component segments.

static parse_game_server_deployment_rollout_path(path: str) → Dict[str, str]

Parses a game_server_deployment_rollout path into its component segments.

async preview_game_server_deployment_rollout(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.PreviewGameServerDeploymentRolloutRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gaming_v1beta.types.game_server_deployments.PreviewGameServerDeploymentRolloutResponse[source]

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_v1beta

async def sample_preview_game_server_deployment_rollout():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters
Returns

Response message for PreviewGameServerDeploymentRollout. This has details about the Agones fleet and autoscaler to be actuated.

Return type

google.cloud.gaming_v1beta.types.PreviewGameServerDeploymentRolloutResponse

property transport: google.cloud.gaming_v1beta.services.game_server_deployments_service.transports.base.GameServerDeploymentsServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

GameServerDeploymentsServiceTransport

async update_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.UpdateGameServerDeploymentRequest, dict]] = None, *, game_server_deployment: Optional[google.cloud.gaming_v1beta.types.game_server_deployments.GameServerDeployment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

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_v1beta

async def sample_update_game_server_deployment():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceAsyncClient()

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

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gaming_v1beta.types.UpdateGameServerDeploymentRequest, dict]]) – The request object. Request message for GameServerDeploymentsService.UpdateGameServerDeployment. Only allows updates for labels.

  • game_server_deployment (google.cloud.gaming_v1beta.types.GameServerDeployment) –

    Required. The game server delpoyment to be updated. Only fields specified in update_mask are updated.

    This corresponds to the game_server_deployment field on the request instance; if request is provided, this should not be set.

  • 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 FieldMask definition, see

    https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

    This corresponds to the update_mask 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gaming_v1beta.types.GameServerDeployment A game server deployment resource.

Return type

google.api_core.operation_async.AsyncOperation

async update_game_server_deployment_rollout(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.UpdateGameServerDeploymentRolloutRequest, dict]] = None, *, rollout: Optional[google.cloud.gaming_v1beta.types.game_server_deployments.GameServerDeploymentRollout] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

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_v1beta

async def sample_update_game_server_deployment_rollout():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceAsyncClient()

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

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gaming_v1beta.types.UpdateGameServerDeploymentRolloutRequest, dict]]) – The request object. Request message for GameServerDeploymentsService.UpdateGameServerRolloutDeployment.

  • rollout (google.cloud.gaming_v1beta.types.GameServerDeploymentRollout) –

    Required. The game server delpoyment rollout to be updated. Only fields specified in update_mask are updated.

    This corresponds to the rollout field on the request instance; if request is provided, this should not be set.

  • 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 FieldMask definition, see

    https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

    This corresponds to the update_mask 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gaming_v1beta.types.GameServerDeployment A game server deployment resource.

Return type

google.api_core.operation_async.AsyncOperation

class google.cloud.gaming_v1beta.services.game_server_deployments_service.GameServerDeploymentsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gaming_v1beta.services.game_server_deployments_service.transports.base.GameServerDeploymentsServiceTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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

Instantiates the game server deployments service client.

Parameters

  • 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, GameServerDeploymentsServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) – 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_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • 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 None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static common_billing_account_path(billing_account: str) → str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]

Returns a fully-qualified project string.

create_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.CreateGameServerDeploymentRequest, dict]] = None, *, parent: Optional[str] = None, game_server_deployment: Optional[google.cloud.gaming_v1beta.types.game_server_deployments.GameServerDeployment] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

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_v1beta

def sample_create_game_server_deployment():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1beta.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)
Parameters

  • request (Union[google.cloud.gaming_v1beta.types.CreateGameServerDeploymentRequest, dict]) – The request object. Request message for GameServerDeploymentsService.CreateGameServerDeployment.

  • parent (str) –

    Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • game_server_deployment (google.cloud.gaming_v1beta.types.GameServerDeployment) –

    Required. The game server delpoyment resource to be created.

    This corresponds to the game_server_deployment 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gaming_v1beta.types.GameServerDeployment A game server deployment resource.

Return type

google.api_core.operation.Operation

delete_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.DeleteGameServerDeploymentRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

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_v1beta

def sample_delete_game_server_deployment():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1beta.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)
Parameters

  • request (Union[google.cloud.gaming_v1beta.types.DeleteGameServerDeploymentRequest, dict]) – The request object. Request message for GameServerDeploymentsService.DeleteGameServerDeployment.

  • name (str) –

    Required. The name of the game server delpoyment to delete. Uses the form:

    projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

    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

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);

}

Return type

google.api_core.operation.Operation

fetch_deployment_state(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.FetchDeploymentStateRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gaming_v1beta.types.game_server_deployments.FetchDeploymentStateResponse[source]

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_v1beta

def sample_fetch_deployment_state():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceClient()

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

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

    # Handle the response
    print(response)
Parameters
Returns

Response message for GameServerDeploymentsService.FetchDeploymentState.

Return type

google.cloud.gaming_v1beta.types.FetchDeploymentStateResponse

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GameServerDeploymentsServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GameServerDeploymentsServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

GameServerDeploymentsServiceClient

static game_server_deployment_path(project: str, location: str, deployment: str) → str[source]

Returns a fully-qualified game_server_deployment string.

static game_server_deployment_rollout_path(project: str, location: str, deployment: str) → str[source]

Returns a fully-qualified game_server_deployment_rollout string.

get_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.GetGameServerDeploymentRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gaming_v1beta.types.game_server_deployments.GameServerDeployment[source]

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_v1beta

def sample_get_game_server_deployment():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceClient()

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

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gaming_v1beta.types.GetGameServerDeploymentRequest, dict]) – The request object. Request message for GameServerDeploymentsService.GetGameServerDeployment.

  • name (str) –

    Required. The name of the game server delpoyment to retrieve. Uses the form:

    projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

    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

A game server deployment resource.

Return type

google.cloud.gaming_v1beta.types.GameServerDeployment

get_game_server_deployment_rollout(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.GetGameServerDeploymentRolloutRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gaming_v1beta.types.game_server_deployments.GameServerDeploymentRollout[source]

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_v1beta

def sample_get_game_server_deployment_rollout():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceClient()

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

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gaming_v1beta.types.GetGameServerDeploymentRolloutRequest, dict]) – The request object. Request message for GameServerDeploymentsService.GetGameServerDeploymentRollout.

  • name (str) –

    Required. The name of the game server delpoyment to retrieve. Uses the form:

    projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout.

    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

The game server deployment rollout which represents the desired rollout state.

Return type

google.cloud.gaming_v1beta.types.GameServerDeploymentRollout

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

list_game_server_deployments(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.ListGameServerDeploymentsRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gaming_v1beta.services.game_server_deployments_service.pagers.ListGameServerDeploymentsPager[source]

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_v1beta

def sample_list_game_server_deployments():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1beta.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)
Parameters

  • request (Union[google.cloud.gaming_v1beta.types.ListGameServerDeploymentsRequest, dict]) – The request object. Request message for GameServerDeploymentsService.ListGameServerDeployments.

  • parent (str) –

    Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

    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

Response message for GameServerDeploymentsService.ListGameServerDeployments. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.gaming_v1beta.services.game_server_deployments_service.pagers.ListGameServerDeploymentsPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]

Parse a project path into its component segments.

static parse_game_server_deployment_path(path: str) → Dict[str, str][source]

Parses a game_server_deployment path into its component segments.

static parse_game_server_deployment_rollout_path(path: str) → Dict[str, str][source]

Parses a game_server_deployment_rollout path into its component segments.

preview_game_server_deployment_rollout(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.PreviewGameServerDeploymentRolloutRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.gaming_v1beta.types.game_server_deployments.PreviewGameServerDeploymentRolloutResponse[source]

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_v1beta

def sample_preview_game_server_deployment_rollout():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceClient()

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

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

    # Handle the response
    print(response)
Parameters
Returns

Response message for PreviewGameServerDeploymentRollout. This has details about the Agones fleet and autoscaler to be actuated.

Return type

google.cloud.gaming_v1beta.types.PreviewGameServerDeploymentRolloutResponse

property transport: google.cloud.gaming_v1beta.services.game_server_deployments_service.transports.base.GameServerDeploymentsServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

GameServerDeploymentsServiceTransport

update_game_server_deployment(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.UpdateGameServerDeploymentRequest, dict]] = None, *, game_server_deployment: Optional[google.cloud.gaming_v1beta.types.game_server_deployments.GameServerDeployment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

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_v1beta

def sample_update_game_server_deployment():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1beta.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)
Parameters

  • request (Union[google.cloud.gaming_v1beta.types.UpdateGameServerDeploymentRequest, dict]) – The request object. Request message for GameServerDeploymentsService.UpdateGameServerDeployment. Only allows updates for labels.

  • game_server_deployment (google.cloud.gaming_v1beta.types.GameServerDeployment) –

    Required. The game server delpoyment to be updated. Only fields specified in update_mask are updated.

    This corresponds to the game_server_deployment field on the request instance; if request is provided, this should not be set.

  • 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 FieldMask definition, see

    https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

    This corresponds to the update_mask 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gaming_v1beta.types.GameServerDeployment A game server deployment resource.

Return type

google.api_core.operation.Operation

update_game_server_deployment_rollout(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_deployments.UpdateGameServerDeploymentRolloutRequest, dict]] = None, *, rollout: Optional[google.cloud.gaming_v1beta.types.game_server_deployments.GameServerDeploymentRollout] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

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_v1beta

def sample_update_game_server_deployment_rollout():
    # Create a client
    client = gaming_v1beta.GameServerDeploymentsServiceClient()

    # Initialize request argument(s)
    request = gaming_v1beta.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)
Parameters

  • request (Union[google.cloud.gaming_v1beta.types.UpdateGameServerDeploymentRolloutRequest, dict]) – The request object. Request message for GameServerDeploymentsService.UpdateGameServerRolloutDeployment.

  • rollout (google.cloud.gaming_v1beta.types.GameServerDeploymentRollout) –

    Required. The game server delpoyment rollout to be updated. Only fields specified in update_mask are updated.

    This corresponds to the rollout field on the request instance; if request is provided, this should not be set.

  • 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 FieldMask definition, see

    https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

    This corresponds to the update_mask 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.gaming_v1beta.types.GameServerDeployment A game server deployment resource.

Return type

google.api_core.operation.Operation

class google.cloud.gaming_v1beta.services.game_server_deployments_service.pagers.ListGameServerDeploymentsAsyncPager(method: Callable[[...], Awaitable[google.cloud.gaming_v1beta.types.game_server_deployments.ListGameServerDeploymentsResponse]], request: google.cloud.gaming_v1beta.types.game_server_deployments.ListGameServerDeploymentsRequest, response: google.cloud.gaming_v1beta.types.game_server_deployments.ListGameServerDeploymentsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_game_server_deployments requests.

This class thinly wraps an initial google.cloud.gaming_v1beta.types.ListGameServerDeploymentsResponse object, and provides an __aiter__ method to iterate through its game_server_deployments field.

If there are more pages, the __aiter__ method will make additional ListGameServerDeployments requests and continue to iterate through the game_server_deployments field on the corresponding responses.

All the usual google.cloud.gaming_v1beta.types.ListGameServerDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.gaming_v1beta.services.game_server_deployments_service.pagers.ListGameServerDeploymentsPager(method: Callable[[...], google.cloud.gaming_v1beta.types.game_server_deployments.ListGameServerDeploymentsResponse], request: google.cloud.gaming_v1beta.types.game_server_deployments.ListGameServerDeploymentsRequest, response: google.cloud.gaming_v1beta.types.game_server_deployments.ListGameServerDeploymentsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_game_server_deployments requests.

This class thinly wraps an initial google.cloud.gaming_v1beta.types.ListGameServerDeploymentsResponse object, and provides an __iter__ method to iterate through its game_server_deployments field.

If there are more pages, the __iter__ method will make additional ListGameServerDeployments requests and continue to iterate through the game_server_deployments field on the corresponding responses.

All the usual google.cloud.gaming_v1beta.types.ListGameServerDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters