Class RealmsServiceClient (0.1.1) 

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.

Methods

RealmsServiceClient

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

Instantiate the realms service client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Union[str, .RealmsServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.
client_options ClientOptions

Custom options for the client.

create_realm

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: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Realm in a given project and Location.

Parameters
Name Description
request .realms.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 .realms.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]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.operation.Operation An object representing a long-running operation. The result type for the operation will be 
.realms.Realm
: A Realm resource.

delete_realm

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: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single Realm.

Parameters
Name Description
request .realms.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]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.operation.Operation An object representing a long-running operation. The result type for the operation will be 
.realms.Realm
: A Realm resource.

from_service_account_file

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
{@api.name} The constructed client.

from_service_account_json

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
{@api.name} The constructed client.

get_realm

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: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Realm.

Parameters
Name Description
request .realms.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]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.realms.Realm A Realm resource.

list_realms

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: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Realms in a given project and Location.

Parameters
Name Description
request .realms.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]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.pagers.ListRealmsPager Response message for RealmsService.ListRealms. Iterating over this object will yield results and resolve additional pages automatically.

preview_realm_update

preview_realm_update(request: Optional[google.cloud.gaming_v1.types.realms.PreviewRealmUpdateRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Previews patches to a single Realm.

Parameters
Name Description
request .realms.PreviewRealmUpdateRequest

The request object. Request message for RealmsService.PreviewRealmUpdate.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.realms.PreviewRealmUpdateResponse Response message for RealmsService.PreviewRealmUpdate.

realm_path

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

Return a fully-qualified realm string.

update_realm

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: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Patches a single Realm.

Parameters
Name Description
request .realms.UpdateRealmRequest

The request object. Request message for RealmsService.UpdateRealm.
realm .realms.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 .field_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]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.operation.Operation An object representing a long-running operation. The result type for the operation will be 
.realms.Realm
: A Realm resource.