Class RealmsServiceAsyncClient (0.3.0)

RealmsServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gaming_v1.services.realms_service.transports.base.RealmsServiceTransport] = 'grpc_asyncio', 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'> = None)

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

Methods

RealmsServiceAsyncClient

RealmsServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.gaming_v1.services.realms_service.transports.base.RealmsServiceTransport] = 'grpc_asyncio', 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'> = 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. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the `api_endpoint` property takes precedence if provided. (2) The `client_cert_source` property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

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

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_async.AsyncOperation`	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_async.AsyncOperation

An object representing a long-running operation. The result type for the operation will be

.empty.Empty

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

from_service_account_file

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

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

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

Returns
Type	Description
`{@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.

get_transport_class

get_transport_class()

Return an appropriate transport class.

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.ListRealmsAsyncPager`	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_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .realms.Realm : A realm resource.