Console
    Contact Us Start free

    Client for Google Cloud Gaming API

    class google.cloud.gaming_v1.CreateGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerClustersService.CreateGameServerCluster.

    parent()

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

    game_server_cluster_id()

    Required. The ID of the Game Server Cluster resource to be created.

    game_server_cluster()

    Required. The Game Server Cluster resource to be created.

    • Type

      GameServerCluster

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.CreateGameServerConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerConfigsService.CreateGameServerConfig.

    parent()

    Required. The parent resource name. Uses the form:

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

    config_id()

    Required. The ID of the Game Server Config resource to be created.

    game_server_config()

    Required. The Game Server Config resource to be created.

    • Type

      GameServerConfig

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.CreateGameServerDeploymentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerDeploymentsService.CreateGameServerDeployment.

    parent()

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

    deployment_id()

    Required. The ID of the Game Server Deployment resource to be created.

    game_server_deployment()

    Required. The Game Server Deployment resource to be created.

    • Type

      GameServerDeployment

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.CreateRealmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for RealmsService.CreateRealm.

    parent()

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

    realm_id()

    Required. The ID of the Realm resource to be created.

    realm()

    Required. The Realm resource to be created.

    • Type

      Realm

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.DeleteGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerClustersService.DeleteGameServerCluster.

    name()

    Required. The name of the Game Server Cluster to delete. Uses the form: projects/{project}/locations/{location}/gameServerClusters/{cluster} .

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.DeleteGameServerConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerConfigsService.DeleteGameServerConfig.

    name()

    Required. The name of the Game Server Config to delete. Uses the form:

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

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.DeleteGameServerDeploymentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerDeploymentsService.DeleteGameServerDeployment.

    name()

    Required. The name of the Game Server Deployment to delete. Uses the form:

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

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.DeleteRealmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for RealmsService.DeleteRealm.

    name()

    Required. The name of the Realm to delete. Uses the form: projects/{project}/locations/{location}/realms/{realm} .

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.DeployedFleetDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Details of the deployed Agones fleet.

    deployed_fleet()

    Information about the Agones fleet.

    • Type

      DeployedFleet

    deployed_autoscaler()

    Information about the Agones autoscaler for that fleet.

    • Type

      DeployedFleetAutoscaler

    class DeployedFleet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Agones fleet specification and details.

    fleet()

    The name of the Agones fleet.

    fleet_spec()

    The fleet spec retrieved from the Agones fleet.

    spec_source()

    The source spec that is used to create the Agones fleet. The GameServerConfig resource may no longer exist in the system.

    • Type

      SpecSource

    status()

    The current status of the Agones fleet. Includes count of game servers in various states.

    • Type

      DeployedFleetStatus

    class DeployedFleetStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    DeployedFleetStatus has details about the Agones fleets such as how many are running, how many allocated, and so on.

    ready_replicas()

    The number of GameServer replicas in the READY state in this fleet.

    allocated_replicas()

    The number of GameServer replicas in the ALLOCATED state in this fleet.

    reserved_replicas()

    The number of GameServer replicas in the RESERVED state in this fleet. Reserved instances won’t be deleted on scale down, but won’t cause an autoscaler to scale up.

    replicas()

    The total number of current GameServer replicas in this fleet.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class DeployedFleetAutoscaler(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Details about the Agones autoscaler.

    autoscaler()

    The name of the Agones autoscaler.

    spec_source()

    The source spec that is used to create the autoscaler. The GameServerConfig resource may no longer exist in the system.

    • Type

      SpecSource

    fleet_autoscaler_spec()

    The autoscaler spec retrieved from Agones.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.FetchDeploymentStateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerDeploymentsService.FetchDeploymentState.

    name()

    Required. The name of the Game Server Deployment. Uses the form:

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

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.FetchDeploymentStateResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Response message for GameServerDeploymentsService.FetchDeploymentState.

    cluster_state()

    The state of the Game Server Deployment in each Game Server Cluster.

    • Type

      Sequence[DeployedClusterState]

    unavailable()

    List of Locations that could not be reached.

    • Type

      Sequence[ str ]

    class DeployedClusterState(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    The Game Server Cluster changes made by the Game Server Deployment.

    cluster()

    The name of the cluster.

    fleet_details()

    The details about the Agones fleets and autoscalers created in the Game Server Cluster.

    • Type

      Sequence[DeployedFleetDetails]

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.FleetConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Fleet configs for Agones.

    fleet_spec()

    Agones fleet spec. Example spec: https://agones.dev/site/docs/reference/fleet/ .

    name()

    The name of the FleetConfig.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.GameServerCluster(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    A Game Server Cluster resource.

    name()

    Required. The resource name of the Game Server Cluster. Uses the form:

    projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster} . For example,

    projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster .

    create_time()

    Output only. The creation time.

    • Type

      Timestamp

    update_time()

    Output only. The last-modified time.

    • Type

      Timestamp

    labels()

    The labels associated with this Game Server Cluster. Each label is a key-value pair.

    • Type

      Sequence[LabelsEntry]

    connection_info()

    Game Server Cluster connection information. This information is used to manage Game Server Clusters.

    • Type

      GameServerClusterConnectionInfo

    etag()

    ETag of the resource.

    description()

    Human readable description of the cluster.

    class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.GameServerClusterConnectionInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    The Game Server Cluster connection information.

    gke_cluster_reference()

    Reference to the GKE cluster where the game servers are installed.

    • Type

      GkeClusterReference

    namespace()

    Namespace designated on the Game Server Cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.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: <module 'google.api_core.client_options' from '/workspace/python-game-servers/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = ClientOptions: {'api_endpoint': 'gameservices.googleapis.com', 'client_cert_source': None, 'client_encrypted_cert_source': None, 'quota_project_id': None, 'credentials_file': None, 'scopes': None, 'api_key': None, 'api_audience': None})

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

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

    create_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.CreateGameServerClusterRequest] = 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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

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

    • Parameters

      • request( CreateGameServerClusterRequest ) – 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( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.game_server_clusters.GameServerCluster : A Game Server Cluster resource.

    • Return type

      Operation

    delete_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.DeleteGameServerClusterRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Deletes a single game server cluster.

    • Parameters

      • request( DeleteGameServerClusterRequest ) – 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.game_server_clusters.GameServerCluster : A Game Server Cluster resource.

    • Return type

      Operation

    classmethod from_service_account_file(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

      {@api.name }

    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

      {@api.name }

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

    Return a fully-qualified game_server_cluster string.

    get_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.GetGameServerClusterRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Gets details of a single game server cluster.

    • Parameters

      • request( GetGameServerClusterRequest ) – 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

    • Returns

      A Game Server Cluster resource.

    • Return type

      GameServerCluster

    list_game_server_clusters(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.ListGameServerClustersRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Lists Game Server Clusters in a given project and location.

    • Parameters

      • request( ListGameServerClustersRequest ) – 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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

      ListGameServerClustersPager

    preview_create_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.PreviewCreateGameServerClusterRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

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

    preview_delete_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.PreviewDeleteGameServerClusterRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Previews deletion of a single game server cluster.

    preview_update_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.PreviewUpdateGameServerClusterRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Previews updating a GameServerCluster.

    update_game_server_cluster(request: Optional[google.cloud.gaming_v1.types.game_server_clusters.UpdateGameServerClusterRequest] = 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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Patches a single game server cluster.

    • Parameters

      • request( UpdateGameServerClusterRequest ) – The request object. Request message for GameServerClustersService.UpdateGameServerCluster.

      • game_server_cluster( 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( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.game_server_clusters.GameServerCluster : A Game Server Cluster resource.

    • Return type

      Operation

    class google.cloud.gaming_v1.GameServerConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    A Game Server Config resource.

    name()

    The resource name of the Game Server Config. Uses the form:

    projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config} . For example,

    projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config .

    create_time()

    Output only. The creation time.

    • Type

      Timestamp

    update_time()

    Output only. The last-modified time.

    • Type

      Timestamp

    labels()

    The labels associated with this Game Server Config. Each label is a key-value pair.

    • Type

      Sequence[LabelsEntry]

    fleet_configs()

    FleetConfig contains a list of Agones fleet specs. Only one FleetConfig is allowed.

    • Type

      Sequence[FleetConfig]

    scaling_configs()

    The autoscaling settings.

    • Type

      Sequence[ScalingConfig]

    description()

    The description of the Game Server Config.

    class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.GameServerConfigOverride(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    A Game Server Config override.

    realms_selector()

    Selector for choosing applicable realms.

    • Type

      RealmSelector

    config_version()

    The game server config for this override.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.GameServerConfigsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gaming_v1.services.game_server_configs_service.transports.base.GameServerConfigsServiceTransport]] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-game-servers/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = ClientOptions: {'api_endpoint': 'gameservices.googleapis.com', 'client_cert_source': None, 'client_encrypted_cert_source': None, 'quota_project_id': None, 'credentials_file': None, 'scopes': None, 'api_key': None, 'api_audience': None})

    The Game Server Config configures the game servers in an Agones fleet.

    Instantiate the game server configs 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 , **GameServerConfigsServiceTransport ] ) – The transport to use. If set to None, a transport is chosen automatically.

      • client_options( ClientOptions ) – Custom options for the client.

    create_game_server_config(request: Optional[google.cloud.gaming_v1.types.game_server_configs.CreateGameServerConfigRequest] = None, *, parent: Optional[str] = None, game_server_config: Optional[google.cloud.gaming_v1.types.game_server_configs.GameServerConfig] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Creates a new Game Server Config in a given project, Location, and Game Server Deployment. Game Server Configs are immutable, and are not applied until referenced in the Game Server Deployment Rollout resource.

    • Parameters

      • request( CreateGameServerConfigRequest ) – The request object. Request message for GameServerConfigsService.CreateGameServerConfig.

      • parent( str ) – Required. The parent resource name. Uses the form:

        projects/{project}/locations/{location}/gameServerDeployments/{deployment}/ . This corresponds to the parent field on the request instance; if request is provided, this should not be set.

      • game_server_config( GameServerConfig ) – Required. The Game Server Config resource to be created. This corresponds to the game_server_config 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.game_server_configs.GameServerConfig : A Game Server Config resource.

    • Return type

      Operation

    delete_game_server_config(request: Optional[google.cloud.gaming_v1.types.game_server_configs.DeleteGameServerConfigRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Deletes a single Game Server Config. The deletion will fail if the Game Server Config is referenced in a Game Server Deployment Rollout.

    • Parameters

      • request( DeleteGameServerConfigRequest ) – The request object. Request message for GameServerConfigsService.DeleteGameServerConfig.

      • name( str ) – Required. The name of the Game Server Config to delete. Uses the form:

        projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config} . 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.game_server_configs.GameServerConfig : A Game Server Config resource.

    • Return type

      Operation

    classmethod from_service_account_file(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

      {@api.name }

    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

      {@api.name }

    static game_server_config_path(project: str , location: str , deployment: str , config: str )

    Return a fully-qualified game_server_config string.

    get_game_server_config(request: Optional[google.cloud.gaming_v1.types.game_server_configs.GetGameServerConfigRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Gets details of a single Game Server Config.

    • Parameters

      • request( GetGameServerConfigRequest ) – The request object. Request message for GameServerConfigsService.GetGameServerConfig.

      • name( str ) – Required. The name of the Game Server Config to retrieve. Uses the form:

        projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config} . 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

    • Returns

      A Game Server Config resource.

    • Return type

      GameServerConfig

    list_game_server_configs(request: Optional[google.cloud.gaming_v1.types.game_server_configs.ListGameServerConfigsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Lists Game Server Configs in a given project, Location, and Game Server Deployment.

    • Parameters

      • request( ListGameServerConfigsRequest ) – The request object. Request message for GameServerConfigsService.ListGameServerConfigs.

      • parent( str ) – Required. The parent resource name. Uses the form:

        projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/\* . 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

    • Returns

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

    • Return type

      ListGameServerConfigsPager

    class google.cloud.gaming_v1.GameServerDeployment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    A Game Server Deployment resource.

    name()

    The resource name of the Game Server Deployment. Uses the form:

    projects/{project}/locations/{location}/gameServerDeployments/{deployment} . For example,

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

    create_time()

    Output only. The creation time.

    • Type

      Timestamp

    update_time()

    Output only. The last-modified time.

    • Type

      Timestamp

    labels()

    The labels associated with this Game Server Deployment. Each label is a key-value pair.

    • Type

      Sequence[LabelsEntry]

    etag()

    ETag of the resource.

    description()

    Human readable description of the Game Server Deployment.

    class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.GameServerDeploymentRollout(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    The Game Server Deployment Rollout which represents the desired rollout state.

    name()

    The resource name of the Game Server Deployment Rollout. Uses the form:

    projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout . For example,

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

    create_time()

    Output only. The creation time.

    • Type

      Timestamp

    update_time()

    Output only. The last-modified time.

    • Type

      Timestamp

    default_game_server_config()

    The default Game Server Config is applied to all Realms unless overridden in the Rollout. For example,

    projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config .

    game_server_config_overrides()

    Contains the Game Server Config Rollout overrides. Overrides are processed in the order they are listed. Once a match is found for a Realm, the rest of the list is not processed.

    • Type

      Sequence[GameServerConfigOverride]

    etag()

    ETag of the resource.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.GameServerDeploymentsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gaming_v1.services.game_server_deployments_service.transports.base.GameServerDeploymentsServiceTransport]] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-game-servers/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = ClientOptions: {'api_endpoint': 'gameservices.googleapis.com', 'client_cert_source': None, 'client_encrypted_cert_source': None, 'quota_project_id': None, 'credentials_file': None, 'scopes': None, 'api_key': None, 'api_audience': None})

    The Game Server Deployment is used to control the deployment of Agones fleets.

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

    create_game_server_deployment(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.CreateGameServerDeploymentRequest] = None, *, parent: Optional[str] = None, game_server_deployment: Optional[google.cloud.gaming_v1.types.game_server_deployments.GameServerDeployment] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Creates a new Game Server Deployment in a given project and Location.

    • Parameters

      • request( CreateGameServerDeploymentRequest ) – 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( GameServerDeployment ) – Required. The Game Server Deployment 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.game_server_deployments.GameServerDeployment : A Game Server Deployment resource.

    • Return type

      Operation

    delete_game_server_deployment(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.DeleteGameServerDeploymentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Deletes a single Game Server Deployment.

    • Parameters

      • request( DeleteGameServerDeploymentRequest ) – The request object. Request message for GameServerDeploymentsService.DeleteGameServerDeployment.

      • name( str ) – Required. The name of the Game Server Deployment 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.game_server_deployments.GameServerDeployment : A Game Server Deployment resource.

    • Return type

      Operation

    fetch_deployment_state(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.FetchDeploymentStateRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Retrieves information about the current state of the Game Server Ddeployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the Game Server Deployment.

    classmethod from_service_account_file(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

      {@api.name }

    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

      {@api.name }

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

    Return a fully-qualified game_server_deployment string.

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

    Return a fully-qualified game_server_deployment_rollout string.

    get_game_server_deployment(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.GetGameServerDeploymentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Gets details of a single Game Server Deployment.

    • Parameters

      • request( GetGameServerDeploymentRequest ) – The request object. Request message for GameServerDeploymentsService.GetGameServerDeployment.

      • name( str ) – Required. The name of the Game Server Deployment 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

    • Returns

      A Game Server Deployment resource.

    • Return type

      GameServerDeployment

    get_game_server_deployment_rollout(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.GetGameServerDeploymentRolloutRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Gets details a single Game Server Deployment Rollout.

    • Parameters

      • request( GetGameServerDeploymentRolloutRequest ) – The request object. Request message for GameServerDeploymentsService.GetGameServerDeploymentRollout.

      • name( str ) – Required. The name of the Game Server Deployment 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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

      GameServerDeploymentRollout

    list_game_server_deployments(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.ListGameServerDeploymentsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Lists Game Server Deployments in a given project and Location.

    • Parameters

    • Returns

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

    • Return type

      ListGameServerDeploymentsPager

    preview_game_server_deployment_rollout(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.PreviewGameServerDeploymentRolloutRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Previews the Game Server Deployment Rollout. This API does not mutate the Rollout resource.

    update_game_server_deployment(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.UpdateGameServerDeploymentRequest] = None, *, game_server_deployment: Optional[google.cloud.gaming_v1.types.game_server_deployments.GameServerDeployment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Patches a Game Server Deployment.

    • Parameters

      • request( UpdateGameServerDeploymentRequest ) – The request object. Request message for GameServerDeploymentsService.UpdateGameServerDeployment. Only allows updates for labels.

      • game_server_deployment( GameServerDeployment ) – Required. The Game Server Deployment 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( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.game_server_deployments.GameServerDeployment : A Game Server Deployment resource.

    • Return type

      Operation

    update_game_server_deployment_rollout(request: Optional[google.cloud.gaming_v1.types.game_server_deployments.UpdateGameServerDeploymentRolloutRequest] = None, *, rollout: Optional[google.cloud.gaming_v1.types.game_server_deployments.GameServerDeploymentRollout] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    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.

    • Parameters

      • request( UpdateGameServerDeploymentRolloutRequest ) – The request object. Request message for GameServerDeploymentsService.UpdateGameServerRolloutDeployment.

      • rollout( GameServerDeploymentRollout ) – Required. The Game Server Deployment 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( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.game_server_deployments.GameServerDeployment : A Game Server Deployment resource.

    • Return type

      Operation

    class google.cloud.gaming_v1.GetGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerClustersService.GetGameServerCluster.

    name()

    Required. The name of the Game Server Cluster to retrieve. Uses the form:

    projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster} .

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.GetGameServerConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerConfigsService.GetGameServerConfig.

    name()

    Required. The name of the Game Server Config to retrieve. Uses the form:

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

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.GetGameServerDeploymentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerDeploymentsService.GetGameServerDeployment.

    name()

    Required. The name of the Game Server Deployment to retrieve. Uses the form:

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

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.GetGameServerDeploymentRolloutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerDeploymentsService.GetGameServerDeploymentRollout.

    name()

    Required. The name of the Game Server Deployment to retrieve. Uses the form:

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

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.GetRealmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for RealmsService.GetRealm.

    name()

    Required. The name of the Realm to retrieve. Uses the form: projects/{project}/locations/{location}/realms/{realm} .

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.GkeClusterReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    A reference to a GKE cluster.

    cluster()

    The full or partial name of a GKE cluster, using one of the following forms:

    • projects/{project}/locations/{location}/clusters/{cluster}

    • locations/{location}/clusters/{cluster}

    • {cluster} If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.

    • Type

      str

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.LabelSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    The label selector, used to group labels on the resources.

    labels()

    Resource labels for this selector.

    • Type

      Sequence[LabelsEntry]

    class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.ListGameServerClustersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerClustersService.ListGameServerClusters.

    parent()

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

    page_size()

    Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response’s [next_page_token][google.cloud.gaming.v1beta.ListGameServerClustersResponse.next_page_token] to determine if there are more GameServerClusters left to be queried.

    page_token()

    Optional. The next_page_token value returned from a previous List request, if any.

    filter()

    Optional. The filter to apply to list results.

    order_by()

    Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order .

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.ListGameServerClustersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Response message for GameServerClustersService.ListGameServerClusters.

    game_server_clusters()

    The list of Game Server Clusters.

    • Type

      Sequence[GameServerCluster]

    next_page_token()

    Token to retrieve the next page of results, or empty if there are no more results in the list.

    unreachable()

    List of Locations that could not be reached.

    • Type

      Sequence[ str ]

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.ListGameServerConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerConfigsService.ListGameServerConfigs.

    parent()

    Required. The parent resource name. Uses the form:

    projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/\* .

    page_size()

    Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response’s [next_page_token][google.cloud.gaming.v1beta.ListGameServerConfigsResponse.next_page_token] to determine if there are more GameServerConfigs left to be queried.

    page_token()

    Optional. The next_page_token value returned from a previous List request, if any.

    filter()

    Optional. The filter to apply to list results.

    order_by()

    Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order .

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.ListGameServerConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Response message for GameServerConfigsService.ListGameServerConfigs.

    game_server_configs()

    The list of Game Server Configs.

    • Type

      Sequence[GameServerConfig]

    next_page_token()

    Token to retrieve the next page of results, or empty if there are no more results in the list.

    unreachable()

    List of Locations that could not be reached.

    • Type

      Sequence[ str ]

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.ListGameServerDeploymentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerDeploymentsService.ListGameServerDeployments.

    parent()

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

    page_size()

    Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response’s [next_page_token][google.cloud.gaming.v1beta.ListGameServerDeploymentsResponse.next_page_token] to determine if there are more GameServerDeployments left to be queried.

    page_token()

    Optional. The next_page_token value returned from a previous List request, if any.

    filter()

    Optional. The filter to apply to list results.

    order_by()

    Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order .

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.ListGameServerDeploymentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Response message for GameServerDeploymentsService.ListGameServerDeployments.

    game_server_deployments()

    The list of Game Server Delpoyments.

    • Type

      Sequence[GameServerDeployment]

    next_page_token()

    Token to retrieve the next page of results, or empty if there are no more results in the list.

    unreachable()

    List of Locations that could not be reached.

    • Type

      Sequence[ str ]

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.ListRealmsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for RealmsService.ListRealms.

    parent()

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

    page_size()

    Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response’s [next_page_token][google.cloud.gaming.v1beta.ListRealmsResponse.next_page_token] to determine if there are more Realms left to be queried.

    page_token()

    Optional. The next_page_token value returned from a previous List request, if any.

    filter()

    Optional. The filter to apply to list results.

    order_by()

    Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order .

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.ListRealmsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Response message for RealmsService.ListRealms.

    realms()

    The list of Realms.

    • Type

      Sequence[Realm]

    next_page_token()

    Token to retrieve the next page of results, or empty if there are no more results in the list.

    unreachable()

    List of Locations that could not be reached.

    • Type

      Sequence[ str ]

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Represents the metadata of the long-running operation.

    create_time()

    Output only. The time the operation was created.

    • Type

      Timestamp

    end_time()

    Output only. The time the operation finished running.

    • Type

      Timestamp

    target()

    Output only. Server-defined resource path for the target of the operation.

    verb()

    Output only. Name of the verb executed by the operation.

    status_message()

    Output only. Human-readable status of the operation, if any.

    requested_cancellation()

    Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED .

    api_version()

    Output only. API version used to start the operation.

    unreachable()

    Output only. List of Locations that could not be reached.

    • Type

      Sequence[ str ]

    operation_status()

    Output only. Operation status for gameservices API operations. Operation status is in the form of key-value pairs where keys are resource IDs and the values show the status of the operation. In case of failures, the value includes an error code and error message.

    • Type

      Sequence[OperationStatusEntry]

    class OperationStatusEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.OperationStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    done()

    Output only. Whether the operation is done or still in progress.

    error_code()

    The error code in case of failures.

    • Type

      ErrorCode

    error_message()

    The human-readable error message.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.PreviewCreateGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerClustersService.PreviewCreateGameServerCluster.

    parent()

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

    game_server_cluster_id()

    Required. The ID of the Game Server Cluster resource to be created.

    game_server_cluster()

    Required. The Game Server Cluster resource to be created.

    • Type

      GameServerCluster

    preview_time()

    Optional. The target timestamp to compute the preview.

    • Type

      Timestamp

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.PreviewCreateGameServerClusterResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Response message for GameServerClustersService.PreviewCreateGameServerCluster.

    etag()

    The ETag of the game server cluster.

    target_state()

    The target state.

    • Type

      TargetState

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.PreviewDeleteGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerClustersService.PreviewDeleteGameServerCluster.

    name()

    Required. The name of the Game Server Cluster to delete. Uses the form: projects/{project}/locations/{location}/gameServerClusters/{cluster} .

    preview_time()

    Optional. The target timestamp to compute the preview.

    • Type

      Timestamp

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.PreviewDeleteGameServerClusterResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Response message for GameServerClustersService.PreviewDeleteGameServerCluster.

    etag()

    The ETag of the game server cluster.

    target_state()

    The target state.

    • Type

      TargetState

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.PreviewGameServerDeploymentRolloutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for PreviewGameServerDeploymentRollout.

    rollout()

    Required. The Game Server Deployment Rollout to be updated. Only fields specified in update_mask are updated.

    • Type

      GameServerDeploymentRollout

    update_mask()

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

    • Type

      FieldMask

    preview_time()

    Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed Rollout completes.

    • Type

      Timestamp

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.PreviewGameServerDeploymentRolloutResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

    unavailable()

    Locations that could not be reached on this request.

    • Type

      Sequence[ str ]

    etag()

    ETag of the Game Server Deployment.

    target_state()

    The target state.

    • Type

      TargetState

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.PreviewRealmUpdateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for RealmsService.PreviewRealmUpdate.

    realm()

    Required. The Realm to be updated. Only fields specified in update_mask are updated.

    • Type

      Realm

    update_mask()

    Required. The update mask applies to the resource. For the FieldMask definition, see

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

    • Type

      FieldMask

    preview_time()

    Optional. The target timestamp to compute the preview.

    • Type

      Timestamp

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.PreviewRealmUpdateResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Response message for RealmsService.PreviewRealmUpdate.

    etag()

    ETag of the realm.

    target_state()

    The target state.

    • Type

      TargetState

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.PreviewUpdateGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerClustersService.UpdateGameServerCluster.

    game_server_cluster()

    Required. The Game Server Cluster to be updated. Only fields specified in update_mask are updated.

    • Type

      GameServerCluster

    update_mask()

    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

    • Type

      FieldMask

    preview_time()

    Optional. The target timestamp to compute the preview.

    • Type

      Timestamp

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.PreviewUpdateGameServerClusterResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Response message for GameServerClustersService.PreviewUpdateGameServerCluster

    etag()

    The ETag of the game server cluster.

    target_state()

    The target state.

    • Type

      TargetState

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.Realm(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    A Realm resource.

    name()

    The resource name of the Realm. Uses the form: projects/{project}/locations/{location}/realms/{realm} . For example, projects/my-project/locations/{location}/realms/my-realm .

    create_time()

    Output only. The creation time.

    • Type

      Timestamp

    update_time()

    Output only. The last-modified time.

    • Type

      Timestamp

    labels()

    The labels associated with this Realm. Each label is a key-value pair.

    • Type

      Sequence[LabelsEntry]

    time_zone()

    Required. Time zone where all policies targeting this Realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones .

    etag()

    ETag of the resource.

    description()

    Human readable description of the Realm.

    class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.RealmSelector(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    The Realm selector, used to match Realm resources.

    realms()

    List of Realms to match.

    • Type

      Sequence[ str ]

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.RealmsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gaming_v1.services.realms_service.transports.base.RealmsServiceTransport]] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-game-servers/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = ClientOptions: {'api_endpoint': 'gameservices.googleapis.com', 'client_cert_source': None, 'client_encrypted_cert_source': None, 'quota_project_id': None, 'credentials_file': None, 'scopes': None, 'api_key': None, 'api_audience': None})

    A Realm is a grouping of Game Server Clusters that are considered interchangeable.

    Instantiate the realms 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 , **RealmsServiceTransport ] ) – The transport to use. If set to None, a transport is chosen automatically.

      • client_options( ClientOptions ) – Custom options for the client.

    create_realm(request: Optional[google.cloud.gaming_v1.types.realms.CreateRealmRequest] = None, *, parent: Optional[str] = None, realm: Optional[google.cloud.gaming_v1.types.realms.Realm] = None, realm_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Creates a new Realm in a given project and Location.

    • Parameters

      • request( CreateRealmRequest ) – The request object. Request message for RealmsService.CreateRealm.

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

      • realm( Realm ) – Required. The Realm resource to be created. This corresponds to the realm field on the request instance; if request is provided, this should not be set.

      • realm_id( str ) – Required. The ID of the Realm resource to be created. This corresponds to the realm_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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.realms.Realm : A Realm resource.

    • Return type

      Operation

    delete_realm(request: Optional[google.cloud.gaming_v1.types.realms.DeleteRealmRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Deletes a single Realm.

    • Parameters

      • request( DeleteRealmRequest ) – The request object. Request message for RealmsService.DeleteRealm.

      • name( str ) – Required. The name of the Realm to delete. Uses the form: projects/{project}/locations/{location}/realms/{realm} . 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.realms.Realm : A Realm resource.

    • Return type

      Operation

    classmethod from_service_account_file(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

      {@api.name }

    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

      {@api.name }

    get_realm(request: Optional[google.cloud.gaming_v1.types.realms.GetRealmRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Gets details of a single Realm.

    • Parameters

      • request( GetRealmRequest ) – The request object. Request message for RealmsService.GetRealm.

      • name( str ) – Required. The name of the Realm to retrieve. Uses the form: projects/{project}/locations/{location}/realms/{realm} . 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

    • Returns

      A Realm resource.

    • Return type

      Realm

    list_realms(request: Optional[google.cloud.gaming_v1.types.realms.ListRealmsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Lists Realms in a given project and Location.

    • Parameters

      • request( ListRealmsRequest ) – The request object. Request message for RealmsService.ListRealms.

      • 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

    • Returns

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

    • Return type

      ListRealmsPager

    preview_realm_update(request: Optional[google.cloud.gaming_v1.types.realms.PreviewRealmUpdateRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Previews patches to a single Realm.

    static realm_path(project: str , location: str , realm: str )

    Return a fully-qualified realm string.

    update_realm(request: Optional[google.cloud.gaming_v1.types.realms.UpdateRealmRequest] = None, *, realm: Optional[google.cloud.gaming_v1.types.realms.Realm] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

    Patches a single Realm.

    • Parameters

      • request( UpdateRealmRequest ) – The request object. Request message for RealmsService.UpdateRealm.

      • realm( Realm ) – Required. The Realm to be updated. Only fields specified in update_mask are updated. This corresponds to the realm field on the request instance; if request is provided, this should not be set.

      • update_mask( FieldMask ) – Required. The update mask applies to the resource. 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#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 :class: ~.realms.Realm : A Realm resource.

    • Return type

      Operation

    class google.cloud.gaming_v1.ScalingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Autoscaling config for an Agones fleet.

    name()

    Required. The name of the Scaling Config

    fleet_autoscaler_spec()

    Required. Agones fleet autoscaler spec. Example spec: https://agones.dev/site/docs/reference/fleetautoscaler/

    selectors()

    Labels used to identify the Game Server Clusters to which this Agones scaling config applies. A Game Server Cluster is subject to this Agones scaling config if its labels match any of the selector entries.

    • Type

      Sequence[LabelSelector]

    schedules()

    The schedules to which this Scaling Config applies.

    • Type

      Sequence[Schedule]

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    The schedule of a recurring or one time event. The event’s time span is specified by start_time and end_time. If the scheduled event’s timespan is larger than the cron_spec + cron_job_duration, the event will be recurring. If only cron_spec + cron_job_duration are specified, the event is effective starting at the local time specified by cron_spec, and is recurring.

     start_time|-------[cron job]-------[cron job]-------[cron job]---|end_time
cron job: cron spec start time + duration

    start_time()

    The start time of the event.

    • Type

      Timestamp

    end_time()

    The end time of the event.

    • Type

      Timestamp

    cron_job_duration()

    The duration for the cron job event. The duration of the event is effective after the cron job’s start time.

    • Type

      Duration

    cron_spec()

    The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron . Cron spec specifies the local time as defined by the Realm.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.SpecSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Encapsulates Agones fleet spec and Agones autoscaler spec sources.

    game_server_config_name()

    The Game Server Config resource. Uses the form:

    projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id} .

    name()

    The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.TargetDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Details about the Agones resources.

    game_server_cluster_name()

    The Game Server Cluster name. Uses the form:

    projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster} .

    game_server_deployment_name()

    The Game Server Deployment name. Uses the form:

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

    fleet_details()

    Agones fleet details for Game Server Clusters and Game Server Deployments.

    • Type

      Sequence[TargetFleetDetails]

    class TargetFleetDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Details of the target Agones fleet.

    fleet()

    Reference to target Agones fleet.

    • Type

      TargetFleet

    autoscaler()

    Reference to target Agones fleet autoscaling policy.

    • Type

      TargetFleetAutoscaler

    class TargetFleet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Target Agones fleet specification.

    name()

    The name of the Agones fleet.

    spec_source()

    Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.

    • Type

      SpecSource

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class TargetFleetAutoscaler(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Target Agones autoscaler policy reference.

    name()

    The name of the Agones autoscaler.

    spec_source()

    Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.

    • Type

      SpecSource

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.TargetState(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Encapsulates the Target state.

    details()

    Details about Agones fleets.

    • Type

      Sequence[TargetDetails]

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.UpdateGameServerClusterRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerClustersService.UpdateGameServerCluster.

    game_server_cluster()

    Required. The Game Server Cluster to be updated. Only fields specified in update_mask are updated.

    • Type

      GameServerCluster

    update_mask()

    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

    • Type

      FieldMask

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.UpdateGameServerDeploymentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerDeploymentsService.UpdateGameServerDeployment. Only allows updates for labels.

    game_server_deployment()

    Required. The Game Server Deployment to be updated. Only fields specified in update_mask are updated.

    • Type

      GameServerDeployment

    update_mask()

    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

    • Type

      FieldMask

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.UpdateGameServerDeploymentRolloutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for GameServerDeploymentsService.UpdateGameServerRolloutDeployment.

    rollout()

    Required. The Game Server Deployment Rollout to be updated. Only fields specified in update_mask are updated.

    • Type

      GameServerDeploymentRollout

    update_mask()

    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

    • Type

      FieldMask

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

    class google.cloud.gaming_v1.UpdateRealmRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

    Request message for RealmsService.UpdateRealm.

    realm()

    Required. The Realm to be updated. Only fields specified in update_mask are updated.

    • Type

      Realm

    update_mask()

    Required. The update mask applies to the resource. For the FieldMask definition, see

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

    • Type

      FieldMask

    _ delattr_ (key)

    Delete the value on the given field.

    This is generally equivalent to setting a falsy value.

    _ eq_ (other)

    Return True if the messages are equal, False otherwise.

    _ ne_ (other)

    Return True if the messages are unequal, False otherwise.

    _ setattr_ (key, value)

    Set the value on the given field.

    For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: