Class protos.google.cloud.gaming.v1.RealmsService (2.3.8)

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

Name	Description
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

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Returns

Type	Description
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

Name	Description
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

Type	Description
void

createRealm(request)

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

Calls CreateRealm.

Parameter

Name	Description
request	`ICreateRealmRequest` CreateRealmRequest message or plain object

Returns

Type	Description
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

Name	Description
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

Type	Description
void

deleteRealm(request)

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

Calls DeleteRealm.

Parameter

Name	Description
request	`IDeleteRealmRequest` DeleteRealmRequest message or plain object

Returns

Type	Description
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

Name	Description
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

Type	Description
void

getRealm(request)

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

Calls GetRealm.

Parameter

Name	Description
request	`IGetRealmRequest` GetRealmRequest message or plain object

Returns

Type	Description
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

Name	Description
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

Type	Description
void

listRealms(request)

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

Calls ListRealms.

Parameter

Name	Description
request	`IListRealmsRequest` ListRealmsRequest message or plain object

Returns

Type	Description
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

Name	Description
request	`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

Type	Description
void

previewRealmUpdate(request)

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

Calls PreviewRealmUpdate.

Parameter

Name	Description
request	`IPreviewRealmUpdateRequest` PreviewRealmUpdateRequest message or plain object

Returns

Type	Description
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

Name	Description
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

Type	Description
void

updateRealm(request)

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

Calls UpdateRealm.

Parameter

Name	Description
request	`google.cloud.gaming.v1.IUpdateRealmRequest` UpdateRealmRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise