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

public class 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 > ClientBase<RealmsService.RealmsServiceClient> > 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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

RealmsServiceClient(ChannelBase)

public RealmsServiceClient(ChannelBase channel)

Creates a new client for RealmsService

Parameter
NameDescription
channelChannelBase

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
NameDescription
configurationClientBase.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
TypeDescription
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
NameDescription
requestCreateRealmRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestCreateRealmRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCreateRealmRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestCreateRealmRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteRealm(DeleteRealmRequest, CallOptions)

public virtual Operation DeleteRealm(DeleteRealmRequest request, CallOptions options)

Deletes a single realm.

Parameters
NameDescription
requestDeleteRealmRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestDeleteRealmRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteRealmAsync(DeleteRealmRequest, CallOptions)

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

Deletes a single realm.

Parameters
NameDescription
requestDeleteRealmRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestDeleteRealmRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetRealm(GetRealmRequest, CallOptions)

public virtual Realm GetRealm(GetRealmRequest request, CallOptions options)

Gets details of a single realm.

Parameters
NameDescription
requestGetRealmRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestGetRealmRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetRealmRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestGetRealmRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListRealmsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestListRealmsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListRealmsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestListRealmsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
RealmsService.RealmsServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Gaming.V1Beta.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
NameDescription
requestPreviewRealmUpdateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestPreviewRealmUpdateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestPreviewRealmUpdateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestPreviewRealmUpdateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<PreviewRealmUpdateResponse>

The call object.

UpdateRealm(UpdateRealmRequest, CallOptions)

public virtual Operation UpdateRealm(UpdateRealmRequest request, CallOptions options)

Patches a single realm.

Parameters
NameDescription
requestUpdateRealmRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestUpdateRealmRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateRealmAsync(UpdateRealmRequest, CallOptions)

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

Patches a single realm.

Parameters
NameDescription
requestUpdateRealmRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestUpdateRealmRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.