Game Services v1 API - Class RealmsServiceClientImpl (2.2.0) 

public sealed class RealmsServiceClientImpl : RealmsServiceClient

Reference documentation and code samples for the Game Services v1 API class RealmsServiceClientImpl.

RealmsService client wrapper implementation, for convenient use.

Inheritance

object > RealmsServiceClient > RealmsServiceClientImpl

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Remarks

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

Constructors

RealmsServiceClientImpl(RealmsServiceClient, RealmsServiceSettings, ILogger)

public RealmsServiceClientImpl(RealmsService.RealmsServiceClient grpcClient, RealmsServiceSettings settings, ILogger logger)

Constructs a client wrapper for the RealmsService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient RealmsServiceRealmsServiceClient

The underlying gRPC client.
settings RealmsServiceSettings

The base RealmsServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateRealmOperationsClient

public override OperationsClient CreateRealmOperationsClient { get; }

The long-running operations client for CreateRealm.

Property Value
Type Description
OperationsClient
Overrides

DeleteRealmOperationsClient

public override OperationsClient DeleteRealmOperationsClient { get; }

The long-running operations client for DeleteRealm.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override RealmsService.RealmsServiceClient GrpcClient { get; }

The underlying gRPC RealmsService client

Property Value
Type Description
RealmsServiceRealmsServiceClient
Overrides

UpdateRealmOperationsClient

public override OperationsClient UpdateRealmOperationsClient { get; }

The long-running operations client for UpdateRealm.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateRealm(CreateRealmRequest, CallSettings)

public override Operation<Realm, OperationMetadata> CreateRealm(CreateRealmRequest request, CallSettings callSettings = null)

Creates a new realm in a given project and location.

Parameters
Name Description
request CreateRealmRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationRealmOperationMetadata

The RPC response.
Overrides

CreateRealmAsync(CreateRealmRequest, CallSettings)

public override Task<Operation<Realm, OperationMetadata>> CreateRealmAsync(CreateRealmRequest request, CallSettings callSettings = null)

Creates a new realm in a given project and location.

Parameters
Name Description
request CreateRealmRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationRealmOperationMetadata

A Task containing the RPC response.
Overrides

DeleteRealm(DeleteRealmRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteRealm(DeleteRealmRequest request, CallSettings callSettings = null)

Deletes a single realm.

Parameters
Name Description
request DeleteRealmRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteRealmAsync(DeleteRealmRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteRealmAsync(DeleteRealmRequest request, CallSettings callSettings = null)

Deletes a single realm.

Parameters
Name Description
request DeleteRealmRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GetRealm(GetRealmRequest, CallSettings)

public override Realm GetRealm(GetRealmRequest request, CallSettings callSettings = null)

Gets details of a single realm.

Parameters
Name Description
request GetRealmRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Realm

The RPC response.
Overrides

GetRealmAsync(GetRealmRequest, CallSettings)

public override Task<Realm> GetRealmAsync(GetRealmRequest request, CallSettings callSettings = null)

Gets details of a single realm.

Parameters
Name Description
request GetRealmRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRealm

A Task containing the RPC response.
Overrides

ListRealms(ListRealmsRequest, CallSettings)

public override PagedEnumerable<ListRealmsResponse, Realm> ListRealms(ListRealmsRequest request, CallSettings callSettings = null)

Lists realms in a given project and location.

Parameters
Name Description
request ListRealmsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListRealmsResponseRealm

A pageable sequence of Realm resources.
Overrides

ListRealmsAsync(ListRealmsRequest, CallSettings)

public override PagedAsyncEnumerable<ListRealmsResponse, Realm> ListRealmsAsync(ListRealmsRequest request, CallSettings callSettings = null)

Lists realms in a given project and location.

Parameters
Name Description
request ListRealmsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListRealmsResponseRealm

A pageable asynchronous sequence of Realm resources.
Overrides

PreviewRealmUpdate(PreviewRealmUpdateRequest, CallSettings)

public override PreviewRealmUpdateResponse PreviewRealmUpdate(PreviewRealmUpdateRequest request, CallSettings callSettings = null)

Previews patches to a single realm.

Parameters
Name Description
request PreviewRealmUpdateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PreviewRealmUpdateResponse

The RPC response.
Overrides

PreviewRealmUpdateAsync(PreviewRealmUpdateRequest, CallSettings)

public override Task<PreviewRealmUpdateResponse> PreviewRealmUpdateAsync(PreviewRealmUpdateRequest request, CallSettings callSettings = null)

Previews patches to a single realm.

Parameters
Name Description
request PreviewRealmUpdateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPreviewRealmUpdateResponse

A Task containing the RPC response.
Overrides

UpdateRealm(UpdateRealmRequest, CallSettings)

public override Operation<Realm, OperationMetadata> UpdateRealm(UpdateRealmRequest request, CallSettings callSettings = null)

Patches a single realm.

Parameters
Name Description
request UpdateRealmRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationRealmOperationMetadata

The RPC response.
Overrides

UpdateRealmAsync(UpdateRealmRequest, CallSettings)

public override Task<Operation<Realm, OperationMetadata>> UpdateRealmAsync(UpdateRealmRequest request, CallSettings callSettings = null)

Patches a single realm.

Parameters
Name Description
request UpdateRealmRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationRealmOperationMetadata

A Task containing the RPC response.
Overrides