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.

GameServerClustersService

class google.cloud.gaming_v1.services.game_server_clusters_service.GameServerClustersServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.gaming_v1.services.game_server_clusters_service.transports.base.GameServerClustersServiceTransport] = '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 cluster maps to Kubernetes clusters running Agones and is used to manage fleets within clusters.

Instantiates the game server clusters 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, GameServerClustersServiceTransport]) – 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_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.CreateGameServerClusterRequest, dict]] = None, *, parent: Optional[str] = None, game_server_cluster: Optional[google.cloud.gaming_v1.types.game_server_clusters.GameServerCluster] = None, game_server_cluster_id: 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]

Creates a new game server cluster 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

async def sample_create_game_server_cluster():
    # Create a client
    client = gaming_v1.GameServerClustersServiceAsyncClient()

    # Initialize request argument(s)
    game_server_cluster = gaming_v1.GameServerCluster()
    game_server_cluster.name = "name_value"

    request = gaming_v1.CreateGameServerClusterRequest(
        parent="parent_value",
        game_server_cluster_id="game_server_cluster_id_value",
        game_server_cluster=game_server_cluster,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gaming_v1.types.CreateGameServerClusterRequest, dict]]) – The request object. Request message for GameServerClustersService.CreateGameServerCluster.

  • parent (str) –

    Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm-id}.

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

  • game_server_cluster (google.cloud.gaming_v1.types.GameServerCluster) –

    Required. The game server cluster resource to be created.

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

  • game_server_cluster_id (str) –

    Required. The ID of the game server cluster resource to be created.

    This corresponds to the game_server_cluster_id 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_v1.types.GameServerCluster A game server cluster resource.

Return type

google.api_core.operation_async.AsyncOperation

async delete_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.DeleteGameServerClusterRequest, 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 cluster.

# 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

async def sample_delete_game_server_cluster():
    # Create a client
    client = gaming_v1.GameServerClustersServiceAsyncClient()

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

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gaming_v1.types.DeleteGameServerClusterRequest, dict]]) – The request object. Request message for GameServerClustersService.DeleteGameServerCluster.

  • name (str) –

    Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.

    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

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

GameServerClustersServiceAsyncClient

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

GameServerClustersServiceAsyncClient

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

GameServerClustersServiceAsyncClient

static game_server_cluster_path(project: str, location: str, realm: str, cluster: str) → str

Returns a fully-qualified game_server_cluster string.

async get_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.GetGameServerClusterRequest, 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_v1.types.game_server_clusters.GameServerCluster[source]

Gets details of a single game server cluster.

# 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

async def sample_get_game_server_cluster():
    # Create a client
    client = gaming_v1.GameServerClustersServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.gaming_v1.types.GetGameServerClusterRequest, dict]]) – The request object. Request message for GameServerClustersService.GetGameServerCluster.

  • name (str) –

    Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.

    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 cluster resource.

Return type

google.cloud.gaming_v1.types.GameServerCluster

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_v1.services.game_server_clusters_service.transports.base.GameServerClustersServiceTransport]

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_clusters(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.ListGameServerClustersRequest, 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_v1.services.game_server_clusters_service.pagers.ListGameServerClustersAsyncPager[source]

Lists game server clusters 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

async def sample_list_game_server_clusters():
    # Create a client
    client = gaming_v1.GameServerClustersServiceAsyncClient()

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

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

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

  • request (Optional[Union[google.cloud.gaming_v1.types.ListGameServerClustersRequest, dict]]) – The request object. Request message for GameServerClustersService.ListGameServerClusters.

  • parent (str) –

    Required. The parent resource name, in the following form: “projects/{project}/locations/{location}/realms/{realm}”.

    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 GameServerClustersService.ListGameServerClusters. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.gaming_v1.services.game_server_clusters_service.pagers.ListGameServerClustersAsyncPager

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_cluster_path(path: str) → Dict[str, str]

Parses a game_server_cluster path into its component segments.

async preview_create_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.PreviewCreateGameServerClusterRequest, 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_v1.types.game_server_clusters.PreviewCreateGameServerClusterResponse[source]

Previews creation of a new game server cluster 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

async def sample_preview_create_game_server_cluster():
    # Create a client
    client = gaming_v1.GameServerClustersServiceAsyncClient()

    # Initialize request argument(s)
    game_server_cluster = gaming_v1.GameServerCluster()
    game_server_cluster.name = "name_value"

    request = gaming_v1.PreviewCreateGameServerClusterRequest(
        parent="parent_value",
        game_server_cluster_id="game_server_cluster_id_value",
        game_server_cluster=game_server_cluster,
    )

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

    # Handle the response
    print(response)
Parameters
Returns

Response message for GameServerClustersService.PreviewCreateGameServerCluster.

Return type

google.cloud.gaming_v1.types.PreviewCreateGameServerClusterResponse

async preview_delete_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.PreviewDeleteGameServerClusterRequest, 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_v1.types.game_server_clusters.PreviewDeleteGameServerClusterResponse[source]

Previews deletion of a single game server cluster.

# 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

async def sample_preview_delete_game_server_cluster():
    # Create a client
    client = gaming_v1.GameServerClustersServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters
Returns

Response message for GameServerClustersService.PreviewDeleteGameServerCluster.

Return type

google.cloud.gaming_v1.types.PreviewDeleteGameServerClusterResponse

async preview_update_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.PreviewUpdateGameServerClusterRequest, 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_v1.types.game_server_clusters.PreviewUpdateGameServerClusterResponse[source]

Previews updating a GameServerCluster.

# 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

async def sample_preview_update_game_server_cluster():
    # Create a client
    client = gaming_v1.GameServerClustersServiceAsyncClient()

    # Initialize request argument(s)
    game_server_cluster = gaming_v1.GameServerCluster()
    game_server_cluster.name = "name_value"

    request = gaming_v1.PreviewUpdateGameServerClusterRequest(
        game_server_cluster=game_server_cluster,
    )

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

    # Handle the response
    print(response)
Parameters
Returns

Response message for GameServerClustersService.PreviewUpdateGameServerCluster

Return type

google.cloud.gaming_v1.types.PreviewUpdateGameServerClusterResponse

property transport: google.cloud.gaming_v1.services.game_server_clusters_service.transports.base.GameServerClustersServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

GameServerClustersServiceTransport

async update_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.UpdateGameServerClusterRequest, dict]] = None, *, game_server_cluster: Optional[google.cloud.gaming_v1.types.game_server_clusters.GameServerCluster] = 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 cluster.

# 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

async def sample_update_game_server_cluster():
    # Create a client
    client = gaming_v1.GameServerClustersServiceAsyncClient()

    # Initialize request argument(s)
    game_server_cluster = gaming_v1.GameServerCluster()
    game_server_cluster.name = "name_value"

    request = gaming_v1.UpdateGameServerClusterRequest(
        game_server_cluster=game_server_cluster,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.gaming_v1.types.GameServerCluster A game server cluster resource.

Return type

google.api_core.operation_async.AsyncOperation

class google.cloud.gaming_v1.services.game_server_clusters_service.GameServerClustersServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gaming_v1.services.game_server_clusters_service.transports.base.GameServerClustersServiceTransport]] = 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 cluster maps to Kubernetes clusters running Agones and is used to manage fleets within clusters.

Instantiates the game server clusters 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, GameServerClustersServiceTransport]) – 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_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.CreateGameServerClusterRequest, dict]] = None, *, parent: Optional[str] = None, game_server_cluster: Optional[google.cloud.gaming_v1.types.game_server_clusters.GameServerCluster] = None, game_server_cluster_id: 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]

Creates a new game server cluster 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_cluster():
    # Create a client
    client = gaming_v1.GameServerClustersServiceClient()

    # Initialize request argument(s)
    game_server_cluster = gaming_v1.GameServerCluster()
    game_server_cluster.name = "name_value"

    request = gaming_v1.CreateGameServerClusterRequest(
        parent="parent_value",
        game_server_cluster_id="game_server_cluster_id_value",
        game_server_cluster=game_server_cluster,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gaming_v1.types.CreateGameServerClusterRequest, dict]) – The request object. Request message for GameServerClustersService.CreateGameServerCluster.

  • parent (str) –

    Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm-id}.

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

  • game_server_cluster (google.cloud.gaming_v1.types.GameServerCluster) –

    Required. The game server cluster resource to be created.

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

  • game_server_cluster_id (str) –

    Required. The ID of the game server cluster resource to be created.

    This corresponds to the game_server_cluster_id 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_v1.types.GameServerCluster A game server cluster resource.

Return type

google.api_core.operation.Operation

delete_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.DeleteGameServerClusterRequest, 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 cluster.

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

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

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gaming_v1.types.DeleteGameServerClusterRequest, dict]) – The request object. Request message for GameServerClustersService.DeleteGameServerCluster.

  • name (str) –

    Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.

    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

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

GameServerClustersServiceClient

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

GameServerClustersServiceClient

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

GameServerClustersServiceClient

static game_server_cluster_path(project: str, location: str, realm: str, cluster: str) → str[source]

Returns a fully-qualified game_server_cluster string.

get_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.GetGameServerClusterRequest, 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_v1.types.game_server_clusters.GameServerCluster[source]

Gets details of a single game server cluster.

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

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

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.gaming_v1.types.GetGameServerClusterRequest, dict]) – The request object. Request message for GameServerClustersService.GetGameServerCluster.

  • name (str) –

    Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.

    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 cluster resource.

Return type

google.cloud.gaming_v1.types.GameServerCluster

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_clusters(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.ListGameServerClustersRequest, 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_v1.services.game_server_clusters_service.pagers.ListGameServerClustersPager[source]

Lists game server clusters 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_clusters():
    # Create a client
    client = gaming_v1.GameServerClustersServiceClient()

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

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

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

  • request (Union[google.cloud.gaming_v1.types.ListGameServerClustersRequest, dict]) – The request object. Request message for GameServerClustersService.ListGameServerClusters.

  • parent (str) –

    Required. The parent resource name, in the following form: “projects/{project}/locations/{location}/realms/{realm}”.

    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 GameServerClustersService.ListGameServerClusters. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.gaming_v1.services.game_server_clusters_service.pagers.ListGameServerClustersPager

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_cluster_path(path: str) → Dict[str, str][source]

Parses a game_server_cluster path into its component segments.

preview_create_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.PreviewCreateGameServerClusterRequest, 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_v1.types.game_server_clusters.PreviewCreateGameServerClusterResponse[source]

Previews creation of a new game server cluster 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_preview_create_game_server_cluster():
    # Create a client
    client = gaming_v1.GameServerClustersServiceClient()

    # Initialize request argument(s)
    game_server_cluster = gaming_v1.GameServerCluster()
    game_server_cluster.name = "name_value"

    request = gaming_v1.PreviewCreateGameServerClusterRequest(
        parent="parent_value",
        game_server_cluster_id="game_server_cluster_id_value",
        game_server_cluster=game_server_cluster,
    )

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

    # Handle the response
    print(response)
Parameters
Returns

Response message for GameServerClustersService.PreviewCreateGameServerCluster.

Return type

google.cloud.gaming_v1.types.PreviewCreateGameServerClusterResponse

preview_delete_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.PreviewDeleteGameServerClusterRequest, 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_v1.types.game_server_clusters.PreviewDeleteGameServerClusterResponse[source]

Previews deletion of a single game server cluster.

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

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

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

    # Handle the response
    print(response)
Parameters
Returns

Response message for GameServerClustersService.PreviewDeleteGameServerCluster.

Return type

google.cloud.gaming_v1.types.PreviewDeleteGameServerClusterResponse

preview_update_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.PreviewUpdateGameServerClusterRequest, 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_v1.types.game_server_clusters.PreviewUpdateGameServerClusterResponse[source]

Previews updating a GameServerCluster.

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

    # Initialize request argument(s)
    game_server_cluster = gaming_v1.GameServerCluster()
    game_server_cluster.name = "name_value"

    request = gaming_v1.PreviewUpdateGameServerClusterRequest(
        game_server_cluster=game_server_cluster,
    )

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

    # Handle the response
    print(response)
Parameters
Returns

Response message for GameServerClustersService.PreviewUpdateGameServerCluster

Return type

google.cloud.gaming_v1.types.PreviewUpdateGameServerClusterResponse

property transport: google.cloud.gaming_v1.services.game_server_clusters_service.transports.base.GameServerClustersServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

GameServerClustersServiceTransport

update_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1.types.game_server_clusters.UpdateGameServerClusterRequest, dict]] = None, *, game_server_cluster: Optional[google.cloud.gaming_v1.types.game_server_clusters.GameServerCluster] = 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 cluster.

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

    # Initialize request argument(s)
    game_server_cluster = gaming_v1.GameServerCluster()
    game_server_cluster.name = "name_value"

    request = gaming_v1.UpdateGameServerClusterRequest(
        game_server_cluster=game_server_cluster,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.gaming_v1.types.GameServerCluster A game server cluster resource.

Return type

google.api_core.operation.Operation

class google.cloud.gaming_v1.services.game_server_clusters_service.pagers.ListGameServerClustersAsyncPager(method: Callable[[...], Awaitable[google.cloud.gaming_v1.types.game_server_clusters.ListGameServerClustersResponse]], request: google.cloud.gaming_v1.types.game_server_clusters.ListGameServerClustersRequest, response: google.cloud.gaming_v1.types.game_server_clusters.ListGameServerClustersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_game_server_clusters requests.

This class thinly wraps an initial google.cloud.gaming_v1.types.ListGameServerClustersResponse object, and provides an __aiter__ method to iterate through its game_server_clusters field.

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

All the usual google.cloud.gaming_v1.types.ListGameServerClustersResponse 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_v1.services.game_server_clusters_service.pagers.ListGameServerClustersPager(method: Callable[[...], google.cloud.gaming_v1.types.game_server_clusters.ListGameServerClustersResponse], request: google.cloud.gaming_v1.types.game_server_clusters.ListGameServerClustersRequest, response: google.cloud.gaming_v1.types.game_server_clusters.ListGameServerClustersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_game_server_clusters requests.

This class thinly wraps an initial google.cloud.gaming_v1.types.ListGameServerClustersResponse object, and provides an __iter__ method to iterate through its game_server_clusters field.

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

All the usual google.cloud.gaming_v1.types.ListGameServerClustersResponse 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