Game Services v1 API - Class RealmsService.RealmsServiceClient (2.1.0)

public class RealmsServiceClient : ClientBase<RealmsService.RealmsServiceClient>

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

Client for RealmsService

Inheritance

Object > ClientBase > ClientBase<RealmsService.RealmsServiceClient> > RealmsService.RealmsServiceClient

Inherited Members

ClientBase<RealmsService.RealmsServiceClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Constructors

RealmsServiceClient()

protected RealmsServiceClient()

Protected parameterless constructor to allow creation of test doubles.

RealmsServiceClient(CallInvoker)

public RealmsServiceClient(CallInvoker callInvoker)

Creates a new client for RealmsService that uses a custom CallInvoker.

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

RealmsServiceClient(ChannelBase)

public RealmsServiceClient(ChannelBase channel)

Creates a new client for RealmsService

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

RealmsServiceClient(ClientBase.ClientBaseConfiguration)

protected RealmsServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
`Operations.OperationsClient`	A new Operations client for the same target as this client.

CreateRealm(CreateRealmRequest, CallOptions)

public virtual Operation CreateRealm(CreateRealmRequest request, CallOptions options)

Creates a new realm in a given project and location.

Parameters
Name	Description
`request`	`CreateRealmRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateRealm(CreateRealmRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateRealm(CreateRealmRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new realm in a given project and location.

Parameters
Name	Description
`request`	`CreateRealmRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateRealmAsync(CreateRealmRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateRealmAsync(CreateRealmRequest request, CallOptions options)

Creates a new realm in a given project and location.

Parameters
Name	Description
`request`	`CreateRealmRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

CreateRealmAsync(CreateRealmRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateRealmAsync(CreateRealmRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new realm in a given project and location.

Parameters
Name	Description
`request`	`CreateRealmRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

DeleteRealm(DeleteRealmRequest, CallOptions)

public virtual Operation DeleteRealm(DeleteRealmRequest request, CallOptions options)

Deletes a single realm.

Parameters
Name	Description
`request`	`DeleteRealmRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteRealm(DeleteRealmRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteRealm(DeleteRealmRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single realm.

Parameters
Name	Description
`request`	`DeleteRealmRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteRealmAsync(DeleteRealmRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteRealmAsync(DeleteRealmRequest request, CallOptions options)

Deletes a single realm.

Parameters
Name	Description
`request`	`DeleteRealmRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

DeleteRealmAsync(DeleteRealmRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteRealmAsync(DeleteRealmRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single realm.

Parameters
Name	Description
`request`	`DeleteRealmRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

GetRealm(GetRealmRequest, CallOptions)

public virtual Realm GetRealm(GetRealmRequest request, CallOptions options)

Gets details of a single realm.

Parameters
Name	Description
`request`	`GetRealmRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Realm`	The response received from the server.

GetRealm(GetRealmRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Realm GetRealm(GetRealmRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single realm.

Parameters
Name	Description
`request`	`GetRealmRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Realm`	The response received from the server.

GetRealmAsync(GetRealmRequest, CallOptions)

public virtual AsyncUnaryCall<Realm> GetRealmAsync(GetRealmRequest request, CallOptions options)

Gets details of a single realm.

Parameters
Name	Description
`request`	`GetRealmRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Realm>`	The call object.

GetRealmAsync(GetRealmRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Realm> GetRealmAsync(GetRealmRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single realm.

Parameters
Name	Description
`request`	`GetRealmRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Realm>`	The call object.

ListRealms(ListRealmsRequest, CallOptions)

public virtual ListRealmsResponse ListRealms(ListRealmsRequest request, CallOptions options)

Lists realms in a given project and location.

Parameters
Name	Description
`request`	`ListRealmsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListRealmsResponse`	The response received from the server.

ListRealms(ListRealmsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListRealmsResponse ListRealms(ListRealmsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists realms in a given project and location.

Parameters
Name	Description
`request`	`ListRealmsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListRealmsResponse`	The response received from the server.

ListRealmsAsync(ListRealmsRequest, CallOptions)

public virtual AsyncUnaryCall<ListRealmsResponse> ListRealmsAsync(ListRealmsRequest request, CallOptions options)

Lists realms in a given project and location.

Parameters
Name	Description
`request`	`ListRealmsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ListRealmsResponse>`	The call object.

ListRealmsAsync(ListRealmsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListRealmsResponse> ListRealmsAsync(ListRealmsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists realms in a given project and location.

Parameters
Name	Description
`request`	`ListRealmsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<ListRealmsResponse>`	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override RealmsService.RealmsServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`RealmsService.RealmsServiceClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Gaming.V1.RealmsService.RealmsServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

PreviewRealmUpdate(PreviewRealmUpdateRequest, CallOptions)

public virtual PreviewRealmUpdateResponse PreviewRealmUpdate(PreviewRealmUpdateRequest request, CallOptions options)

Previews patches to a single realm.

Parameters
Name	Description
`request`	`PreviewRealmUpdateRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`PreviewRealmUpdateResponse`	The response received from the server.

PreviewRealmUpdate(PreviewRealmUpdateRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual PreviewRealmUpdateResponse PreviewRealmUpdate(PreviewRealmUpdateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Previews patches to a single realm.

Parameters
Name	Description
`request`	`PreviewRealmUpdateRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`PreviewRealmUpdateResponse`	The response received from the server.

PreviewRealmUpdateAsync(PreviewRealmUpdateRequest, CallOptions)

public virtual AsyncUnaryCall<PreviewRealmUpdateResponse> PreviewRealmUpdateAsync(PreviewRealmUpdateRequest request, CallOptions options)

Previews patches to a single realm.

Parameters
Name	Description
`request`	`PreviewRealmUpdateRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<PreviewRealmUpdateResponse>`	The call object.

PreviewRealmUpdateAsync(PreviewRealmUpdateRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<PreviewRealmUpdateResponse> PreviewRealmUpdateAsync(PreviewRealmUpdateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Previews patches to a single realm.

Parameters
Name	Description
`request`	`PreviewRealmUpdateRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<PreviewRealmUpdateResponse>`	The call object.

UpdateRealm(UpdateRealmRequest, CallOptions)

public virtual Operation UpdateRealm(UpdateRealmRequest request, CallOptions options)

Patches a single realm.

Parameters
Name	Description
`request`	`UpdateRealmRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

UpdateRealm(UpdateRealmRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateRealm(UpdateRealmRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Patches a single realm.

Parameters
Name	Description
`request`	`UpdateRealmRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

UpdateRealmAsync(UpdateRealmRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateRealmAsync(UpdateRealmRequest request, CallOptions options)

Patches a single realm.

Parameters
Name	Description
`request`	`UpdateRealmRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

UpdateRealmAsync(UpdateRealmRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateRealmAsync(UpdateRealmRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Patches a single realm.

Parameters
Name	Description
`request`	`UpdateRealmRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.