Game Services v1 API - Class RealmsServiceClientImpl (2.1.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

Inherited Members

RealmsServiceClient.DefaultEndpoint

RealmsServiceClient.DefaultScopes

RealmsServiceClient.ServiceMetadata

RealmsServiceClient.CreateAsync(CancellationToken)

RealmsServiceClient.Create()

RealmsServiceClient.ShutdownDefaultChannelsAsync()

RealmsServiceClient.ListRealms(String, String, Nullable<Int32>, CallSettings)

RealmsServiceClient.ListRealmsAsync(String, String, Nullable<Int32>, CallSettings)

RealmsServiceClient.ListRealms(LocationName, String, Nullable<Int32>, CallSettings)

RealmsServiceClient.ListRealmsAsync(LocationName, String, Nullable<Int32>, CallSettings)

RealmsServiceClient.GetRealmAsync(GetRealmRequest, CancellationToken)

RealmsServiceClient.GetRealm(String, CallSettings)

RealmsServiceClient.GetRealmAsync(String, CallSettings)

RealmsServiceClient.GetRealmAsync(String, CancellationToken)

RealmsServiceClient.GetRealm(RealmName, CallSettings)

RealmsServiceClient.GetRealmAsync(RealmName, CallSettings)

RealmsServiceClient.GetRealmAsync(RealmName, CancellationToken)

RealmsServiceClient.CreateRealmAsync(CreateRealmRequest, CancellationToken)

RealmsServiceClient.PollOnceCreateRealm(String, CallSettings)

RealmsServiceClient.PollOnceCreateRealmAsync(String, CallSettings)

RealmsServiceClient.CreateRealm(String, Realm, String, CallSettings)

RealmsServiceClient.CreateRealmAsync(String, Realm, String, CallSettings)

RealmsServiceClient.CreateRealmAsync(String, Realm, String, CancellationToken)

RealmsServiceClient.CreateRealm(LocationName, Realm, String, CallSettings)

RealmsServiceClient.CreateRealmAsync(LocationName, Realm, String, CallSettings)

RealmsServiceClient.CreateRealmAsync(LocationName, Realm, String, CancellationToken)

RealmsServiceClient.DeleteRealmAsync(DeleteRealmRequest, CancellationToken)

RealmsServiceClient.PollOnceDeleteRealm(String, CallSettings)

RealmsServiceClient.PollOnceDeleteRealmAsync(String, CallSettings)

RealmsServiceClient.DeleteRealm(String, CallSettings)

RealmsServiceClient.DeleteRealmAsync(String, CallSettings)

RealmsServiceClient.DeleteRealmAsync(String, CancellationToken)

RealmsServiceClient.DeleteRealm(RealmName, CallSettings)

RealmsServiceClient.DeleteRealmAsync(RealmName, CallSettings)

RealmsServiceClient.DeleteRealmAsync(RealmName, CancellationToken)

RealmsServiceClient.UpdateRealmAsync(UpdateRealmRequest, CancellationToken)

RealmsServiceClient.PollOnceUpdateRealm(String, CallSettings)

RealmsServiceClient.PollOnceUpdateRealmAsync(String, CallSettings)

RealmsServiceClient.UpdateRealm(Realm, FieldMask, CallSettings)

RealmsServiceClient.UpdateRealmAsync(Realm, FieldMask, CallSettings)

RealmsServiceClient.UpdateRealmAsync(Realm, FieldMask, CancellationToken)

RealmsServiceClient.PreviewRealmUpdateAsync(PreviewRealmUpdateRequest, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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(RealmsService.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`	`RealmsService.RealmsServiceClient` 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

RealmsServiceClient.CreateRealmOperationsClient

DeleteRealmOperationsClient

public override OperationsClient DeleteRealmOperationsClient { get; }

The long-running operations client for DeleteRealm.

Property Value
Type	Description
`OperationsClient`

Overrides

RealmsServiceClient.DeleteRealmOperationsClient

GrpcClient

public override RealmsService.RealmsServiceClient GrpcClient { get; }

The underlying gRPC RealmsService client

Property Value
Type	Description
`RealmsService.RealmsServiceClient`

Overrides

RealmsServiceClient.GrpcClient

UpdateRealmOperationsClient

public override OperationsClient UpdateRealmOperationsClient { get; }

The long-running operations client for UpdateRealm.

Property Value
Type	Description
`OperationsClient`

Overrides

RealmsServiceClient.UpdateRealmOperationsClient

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
`Operation<Realm, OperationMetadata>`	The RPC response.

Overrides

RealmsServiceClient.CreateRealm(CreateRealmRequest, CallSettings)

CreateRealmAsync(CreateRealmRequest, CallSettings)

public override async 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
`Task<Operation<Realm, OperationMetadata>>`	A Task containing the RPC response.

Overrides

RealmsServiceClient.CreateRealmAsync(CreateRealmRequest, CallSettings)

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
`Operation<Empty, OperationMetadata>`	The RPC response.

Overrides

RealmsServiceClient.DeleteRealm(DeleteRealmRequest, CallSettings)

DeleteRealmAsync(DeleteRealmRequest, CallSettings)

public override async 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
`Task<Operation<Empty, OperationMetadata>>`	A Task containing the RPC response.

Overrides

RealmsServiceClient.DeleteRealmAsync(DeleteRealmRequest, CallSettings)

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

RealmsServiceClient.GetRealm(GetRealmRequest, CallSettings)

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
`Task<Realm>`	A Task containing the RPC response.

Overrides

RealmsServiceClient.GetRealmAsync(GetRealmRequest, CallSettings)

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
`PagedEnumerable<ListRealmsResponse, Realm>`	A pageable sequence of Realm resources.

Overrides

RealmsServiceClient.ListRealms(ListRealmsRequest, CallSettings)

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
`PagedAsyncEnumerable<ListRealmsResponse, Realm>`	A pageable asynchronous sequence of Realm resources.

Overrides

RealmsServiceClient.ListRealmsAsync(ListRealmsRequest, CallSettings)

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

RealmsServiceClient.PreviewRealmUpdate(PreviewRealmUpdateRequest, CallSettings)

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
`Task<PreviewRealmUpdateResponse>`	A Task containing the RPC response.

Overrides

RealmsServiceClient.PreviewRealmUpdateAsync(PreviewRealmUpdateRequest, CallSettings)

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
`Operation<Realm, OperationMetadata>`	The RPC response.

Overrides

RealmsServiceClient.UpdateRealm(UpdateRealmRequest, CallSettings)

UpdateRealmAsync(UpdateRealmRequest, CallSettings)

public override async 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
`Task<Operation<Realm, OperationMetadata>>`	A Task containing the RPC response.

Overrides

RealmsServiceClient.UpdateRealmAsync(UpdateRealmRequest, CallSettings)