Class GameServerClustersServiceClient (1.4.2)

GameServerClustersServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gaming_v1beta.services.game_server_clusters_service.transports.base.GameServerClustersServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The game server cluster maps to Kubernetes clusters running Agones and is used to manage fleets within clusters.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`GameServerClustersServiceTransport`	The transport used by the client instance.

Methods

GameServerClustersServiceClient

GameServerClustersServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gaming_v1beta.services.game_server_clusters_service.transports.base.GameServerClustersServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the game server clusters service client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, GameServerClustersServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `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.

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

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_game_server_cluster

create_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_clusters.CreateGameServerClusterRequest, dict]] = None, *, parent: Optional[str] = None, game_server_cluster: Optional[google.cloud.gaming_v1beta.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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

from google.cloud import gaming_v1beta

def sample_create_game_server_cluster():
    # Create a client
    client = gaming_v1beta.GameServerClustersServiceClient()

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

    request = gaming_v1beta.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
Name	Description
`request`	`Union[google.cloud.gaming_v1beta.types.CreateGameServerClusterRequest, dict]` The request object. Request message for GameServerClustersService.CreateGameServerCluster.
`parent`	`str` Required. The parent resource name. Uses the 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_v1beta.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
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be GameServerCluster A game server cluster resource.

delete_game_server_cluster

delete_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1beta.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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single game server cluster.

from google.cloud import gaming_v1beta

def sample_delete_game_server_cluster():
    # Create a client
    client = gaming_v1beta.GameServerClustersServiceClient()

    # Initialize request argument(s)
    request = gaming_v1beta.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
Name	Description
`request`	`Union[google.cloud.gaming_v1beta.types.DeleteGameServerClusterRequest, dict]` The request object. Request message for GameServerClustersService.DeleteGameServerCluster.
`name`	`str` Required. The name of the game server cluster to delete. Uses the 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

Type Description

google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`GameServerClustersServiceClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`GameServerClustersServiceClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

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

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`GameServerClustersServiceClient`	The constructed client.

game_server_cluster_path

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

Returns a fully-qualified game_server_cluster string.

get_game_server_cluster

get_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1beta.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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single game server cluster.

from google.cloud import gaming_v1beta

def sample_get_game_server_cluster():
    # Create a client
    client = gaming_v1beta.GameServerClustersServiceClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.gaming_v1beta.types.GetGameServerClusterRequest, dict]` The request object. Request message for GameServerClustersService.GetGameServerCluster.
`name`	`str` Required. The name of the game server cluster to retrieve. Uses the 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
Type	Description
`google.cloud.gaming_v1beta.types.GameServerCluster`	A game server cluster resource.

get_mtls_endpoint_and_cert_source

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

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

list_game_server_clusters

list_game_server_clusters(request: Optional[Union[google.cloud.gaming_v1beta.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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists game server clusters in a given project and location.

from google.cloud import gaming_v1beta

def sample_list_game_server_clusters():
    # Create a client
    client = gaming_v1beta.GameServerClustersServiceClient()

    # Initialize request argument(s)
    request = gaming_v1beta.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
Name	Description
`request`	`Union[google.cloud.gaming_v1beta.types.ListGameServerClustersRequest, dict]` The request object. Request message for GameServerClustersService.ListGameServerClusters.
`parent`	`str` Required. The parent resource name. Uses the 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
Type	Description
`google.cloud.gaming_v1beta.services.game_server_clusters_service.pagers.ListGameServerClustersPager`	Response message for GameServerClustersService.ListGameServerClusters. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_game_server_cluster_path

parse_game_server_cluster_path(path: str)

Parses a game_server_cluster path into its component segments.

preview_create_game_server_cluster

preview_create_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1beta.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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Previews creation of a new game server cluster in a given project and location.

from google.cloud import gaming_v1beta

def sample_preview_create_game_server_cluster():
    # Create a client
    client = gaming_v1beta.GameServerClustersServiceClient()

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

    request = gaming_v1beta.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
Name	Description
`request`	`Union[google.cloud.gaming_v1beta.types.PreviewCreateGameServerClusterRequest, dict]` The request object. Request message for GameServerClustersService.PreviewCreateGameServerCluster.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.gaming_v1beta.types.PreviewCreateGameServerClusterResponse`	Response message for GameServerClustersService.PreviewCreateGameServerCluster.

preview_delete_game_server_cluster

preview_delete_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1beta.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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Previews deletion of a single game server cluster.

from google.cloud import gaming_v1beta

def sample_preview_delete_game_server_cluster():
    # Create a client
    client = gaming_v1beta.GameServerClustersServiceClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.gaming_v1beta.types.PreviewDeleteGameServerClusterRequest, dict]` The request object. Request message for GameServerClustersService.PreviewDeleteGameServerCluster.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.gaming_v1beta.types.PreviewDeleteGameServerClusterResponse`	Response message for GameServerClustersService.PreviewDeleteGameServerCluster.

preview_update_game_server_cluster

preview_update_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1beta.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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Previews updating a GameServerCluster.

from google.cloud import gaming_v1beta

def sample_preview_update_game_server_cluster():
    # Create a client
    client = gaming_v1beta.GameServerClustersServiceClient()

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

    request = gaming_v1beta.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
Name	Description
`request`	`Union[google.cloud.gaming_v1beta.types.PreviewUpdateGameServerClusterRequest, dict]` The request object. Request message for GameServerClustersService.UpdateGameServerCluster.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.gaming_v1beta.types.PreviewUpdateGameServerClusterResponse`	Response message for GameServerClustersService.PreviewUpdateGameServerCluster

update_game_server_cluster

update_game_server_cluster(request: Optional[Union[google.cloud.gaming_v1beta.types.game_server_clusters.UpdateGameServerClusterRequest, dict]] = None, *, game_server_cluster: Optional[google.cloud.gaming_v1beta.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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Patches a single game server cluster.

from google.cloud import gaming_v1beta

def sample_update_game_server_cluster():
    # Create a client
    client = gaming_v1beta.GameServerClustersServiceClient()

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

    request = gaming_v1beta.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
Name	Description
`request`	`Union[google.cloud.gaming_v1beta.types.UpdateGameServerClusterRequest, dict]` The request object. Request message for GameServerClustersService.UpdateGameServerCluster.
`game_server_cluster`	`google.cloud.gaming_v1beta.types.GameServerCluster` Required. The game server cluster to be updated. Only fields specified in update_mask are updated. This corresponds to the `game_server_cluster` 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
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be GameServerCluster A game server cluster resource.