Google Cloud for Games v1beta API - Class RealmsServiceClientImpl (2.0.0-beta03)

Version latest

• 2.0.0-beta03 (latest)
• 2.0.0-beta02
• 1.0.0-beta09

public sealed class RealmsServiceClientImpl : RealmsServiceClient

Reference documentation and code samples for the Google Cloud for Games v1beta 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, int?, CallSettings)

RealmsServiceClient.ListRealmsAsync(string, string, int?, CallSettings)

RealmsServiceClient.ListRealms(LocationName, string, int?, CallSettings)

RealmsServiceClient.ListRealmsAsync(LocationName, string, int?, 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.ToString()

Namespace

Google.Cloud.Gaming.V1Beta

Assembly

Google.Cloud.Gaming.V1Beta.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

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
RealmsServiceRealmsServiceClient

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
OperationRealmOperationMetadata	The RPC response.

Overrides

RealmsServiceClient.CreateRealm(CreateRealmRequest, CallSettings)

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

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
OperationEmptyOperationMetadata	The RPC response.

Overrides

RealmsServiceClient.DeleteRealm(DeleteRealmRequest, CallSettings)

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

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
TaskRealm	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
PagedEnumerableListRealmsResponseRealm	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
PagedAsyncEnumerableListRealmsResponseRealm	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
TaskPreviewRealmUpdateResponse	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
OperationRealmOperationMetadata	The RPC response.

Overrides

RealmsServiceClient.UpdateRealm(UpdateRealmRequest, CallSettings)

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

RealmsServiceClient.UpdateRealmAsync(UpdateRealmRequest, CallSettings)