Class protos.google.cloud.gaming.v1.RealmsService

Represents a RealmsService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.gaming.v1.RealmsService

Package

@google-cloud/game-servers

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new RealmsService service.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): RealmsService;

Creates new RealmsService service using the specified rpc implementation.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
RealmsService

RPC service. Useful where requests and/or responses are streamed.

createRealm(request, callback)

public createRealm(request: google.cloud.gaming.v1.ICreateRealmRequest, callback: google.cloud.gaming.v1.RealmsService.CreateRealmCallback): void;

Calls CreateRealm.

Parameters
NameDescription
request ICreateRealmRequest

CreateRealmRequest message or plain object

callback google.cloud.gaming.v1.RealmsService.CreateRealmCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

createRealm(request)

public createRealm(request: google.cloud.gaming.v1.ICreateRealmRequest): Promise<google.longrunning.Operation>;

Calls CreateRealm.

Parameter
NameDescription
request ICreateRealmRequest

CreateRealmRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

deleteRealm(request, callback)

public deleteRealm(request: google.cloud.gaming.v1.IDeleteRealmRequest, callback: google.cloud.gaming.v1.RealmsService.DeleteRealmCallback): void;

Calls DeleteRealm.

Parameters
NameDescription
request IDeleteRealmRequest

DeleteRealmRequest message or plain object

callback google.cloud.gaming.v1.RealmsService.DeleteRealmCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

deleteRealm(request)

public deleteRealm(request: google.cloud.gaming.v1.IDeleteRealmRequest): Promise<google.longrunning.Operation>;

Calls DeleteRealm.

Parameter
NameDescription
request IDeleteRealmRequest

DeleteRealmRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

getRealm(request, callback)

public getRealm(request: google.cloud.gaming.v1.IGetRealmRequest, callback: google.cloud.gaming.v1.RealmsService.GetRealmCallback): void;

Calls GetRealm.

Parameters
NameDescription
request IGetRealmRequest

GetRealmRequest message or plain object

callback google.cloud.gaming.v1.RealmsService.GetRealmCallback

Node-style callback called with the error, if any, and Realm

Returns
TypeDescription
void

getRealm(request)

public getRealm(request: google.cloud.gaming.v1.IGetRealmRequest): Promise<google.cloud.gaming.v1.Realm>;

Calls GetRealm.

Parameter
NameDescription
request IGetRealmRequest

GetRealmRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.gaming.v1.Realm>

Promise

listRealms(request, callback)

public listRealms(request: google.cloud.gaming.v1.IListRealmsRequest, callback: google.cloud.gaming.v1.RealmsService.ListRealmsCallback): void;

Calls ListRealms.

Parameters
NameDescription
request IListRealmsRequest

ListRealmsRequest message or plain object

callback google.cloud.gaming.v1.RealmsService.ListRealmsCallback

Node-style callback called with the error, if any, and ListRealmsResponse

Returns
TypeDescription
void

listRealms(request)

public listRealms(request: google.cloud.gaming.v1.IListRealmsRequest): Promise<google.cloud.gaming.v1.ListRealmsResponse>;

Calls ListRealms.

Parameter
NameDescription
request IListRealmsRequest

ListRealmsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.gaming.v1.ListRealmsResponse>

Promise

previewRealmUpdate(request, callback)

public previewRealmUpdate(request: google.cloud.gaming.v1.IPreviewRealmUpdateRequest, callback: google.cloud.gaming.v1.RealmsService.PreviewRealmUpdateCallback): void;

Calls PreviewRealmUpdate.

Parameters
NameDescription
request google.cloud.gaming.v1.IPreviewRealmUpdateRequest

PreviewRealmUpdateRequest message or plain object

callback google.cloud.gaming.v1.RealmsService.PreviewRealmUpdateCallback

Node-style callback called with the error, if any, and PreviewRealmUpdateResponse

Returns
TypeDescription
void

previewRealmUpdate(request)

public previewRealmUpdate(request: google.cloud.gaming.v1.IPreviewRealmUpdateRequest): Promise<google.cloud.gaming.v1.PreviewRealmUpdateResponse>;

Calls PreviewRealmUpdate.

Parameter
NameDescription
request google.cloud.gaming.v1.IPreviewRealmUpdateRequest

PreviewRealmUpdateRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.gaming.v1.PreviewRealmUpdateResponse>

Promise

updateRealm(request, callback)

public updateRealm(request: google.cloud.gaming.v1.IUpdateRealmRequest, callback: google.cloud.gaming.v1.RealmsService.UpdateRealmCallback): void;

Calls UpdateRealm.

Parameters
NameDescription
request google.cloud.gaming.v1.IUpdateRealmRequest

UpdateRealmRequest message or plain object

callback google.cloud.gaming.v1.RealmsService.UpdateRealmCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

updateRealm(request)

public updateRealm(request: google.cloud.gaming.v1.IUpdateRealmRequest): Promise<google.longrunning.Operation>;

Calls UpdateRealm.

Parameter
NameDescription
request google.cloud.gaming.v1.IUpdateRealmRequest

UpdateRealmRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise