Class RealmsServiceAsyncClient

A realm is a grouping of game server clusters that are considered interchangeable.

Inheritance

builtins.object > RealmsServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
RealmsServiceTransportThe transport used by the client instance.

Methods

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account str

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder str

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project str
location str

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization str

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project str

create_realm

create_realm(request: Optional[Union[google.cloud.gaming_v1beta.types.realms.CreateRealmRequest, dict]] = None, *, parent: Optional[str] = None, realm: Optional[google.cloud.gaming_v1beta.types.realms.Realm] = None, realm_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_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
NameDescription
request Union[google.cloud.gaming_v1beta.types.CreateRealmRequest, dict]

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]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Realm A realm resource.

delete_realm

delete_realm(request: Optional[Union[google.cloud.gaming_v1beta.types.realms.DeleteRealmRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single realm.

Parameters
NameDescription
request Union[google.cloud.gaming_v1beta.types.DeleteRealmRequest, dict]

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

from_service_account_file

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

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

Parameters
NameDescription
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
TypeDescription
RealmsServiceAsyncClientThe constructed client.

from_service_account_info

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

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

Parameters
NameDescription
info dict

The service account private key info.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
RealmsServiceAsyncClientThe 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.

Parameters
NameDescription
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
TypeDescription
RealmsServiceAsyncClientThe constructed client.

get_realm

get_realm(request: Optional[Union[google.cloud.gaming_v1beta.types.realms.GetRealmRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single realm.

Parameters
NameDescription
request Union[google.cloud.gaming_v1beta.types.GetRealmRequest, dict]

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
TypeDescription
google.cloud.gaming_v1beta.types.RealmA realm resource.

get_transport_class

get_transport_class()

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameter
NameDescription
label str

list_realms

list_realms(request: Optional[Union[google.cloud.gaming_v1beta.types.realms.ListRealmsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists realms in a given project and location.

Parameters
NameDescription
request Union[google.cloud.gaming_v1beta.types.ListRealmsRequest, dict]

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
TypeDescription
google.cloud.gaming_v1beta.services.realms_service.pagers.ListRealmsAsyncPagerResponse message for RealmsService.ListRealms. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter
NameDescription
path str

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path str

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path str

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path str

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path str

parse_realm_path

parse_realm_path(path: str)

Parses a realm path into its component segments.

Parameter
NameDescription
path str

preview_realm_update

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

Previews patches to a single realm.

Parameters
NameDescription
request Union[google.cloud.gaming_v1beta.types.PreviewRealmUpdateRequest, dict]

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
TypeDescription
google.cloud.gaming_v1beta.types.PreviewRealmUpdateResponseResponse message for RealmsService.PreviewRealmUpdate.

realm_path

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

Returns a fully-qualified realm string.

Parameters
NameDescription
project str
location str
realm str

update_realm

update_realm(request: Optional[Union[google.cloud.gaming_v1beta.types.realms.UpdateRealmRequest, dict]] = None, *, realm: Optional[google.cloud.gaming_v1beta.types.realms.Realm] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Patches a single realm.

Parameters
NameDescription
request Union[google.cloud.gaming_v1beta.types.UpdateRealmRequest, dict]

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 `google.protobuf.field_mask_pb2.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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Realm A realm resource.