Google Cloud for Games v1beta API - Class RealmsService.RealmsServiceClient (2.0.0-beta03)

public class RealmsService.RealmsServiceClient : ClientBase<RealmsService.RealmsServiceClient>

Reference documentation and code samples for the Google Cloud for Games v1beta API class RealmsService.RealmsServiceClient.

Client for RealmsService

Inheritance

object > ClientBase > ClientBaseRealmsServiceRealmsServiceClient > RealmsService.RealmsServiceClient

Namespace

Google.Cloud.Gaming.V1Beta

Assembly

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

protected RealmsServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

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
OperationsOperationsClient

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, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallOperation

The call object.

CreateRealmAsync(CreateRealmRequest, Metadata, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallOperation

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, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallOperation

The call object.

DeleteRealmAsync(DeleteRealmRequest, Metadata, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallOperation

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, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallRealm

The call object.

GetRealmAsync(GetRealmRequest, Metadata, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallRealm

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, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallListRealmsResponse

The call object.

ListRealmsAsync(ListRealmsRequest, Metadata, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallListRealmsResponse

The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
RealmsServiceRealmsServiceClient
Overrides

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, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallPreviewRealmUpdateResponse

The call object.

PreviewRealmUpdateAsync(PreviewRealmUpdateRequest, Metadata, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallPreviewRealmUpdateResponse

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, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallOperation

The call object.

UpdateRealmAsync(UpdateRealmRequest, Metadata, DateTime?, CancellationToken)

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

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 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
AsyncUnaryCallOperation

The call object.