RealmsService

google.cloud.gaming.v1. RealmsService

Represents a RealmsService

Constructor

new RealmsService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new RealmsService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {RealmsService}

Creates new RealmsService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

createRealm(request, callback) → {undefined}

Calls CreateRealm.

Parameters:
Name Type Description
request google.cloud.gaming.v1.ICreateRealmRequest

CreateRealmRequest message or plain object

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

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

createRealm(request) → {Promise.<google.longrunning.Operation>}

Calls CreateRealm.

Parameters:
Name Type Description
request google.cloud.gaming.v1.ICreateRealmRequest

CreateRealmRequest message or plain object

deleteRealm(request, callback) → {undefined}

Calls DeleteRealm.

Parameters:
Name Type Description
request google.cloud.gaming.v1.IDeleteRealmRequest

DeleteRealmRequest message or plain object

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

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

deleteRealm(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteRealm.

Parameters:
Name Type Description
request google.cloud.gaming.v1.IDeleteRealmRequest

DeleteRealmRequest message or plain object

getRealm(request, callback) → {undefined}

Calls GetRealm.

Parameters:
Name Type Description
request google.cloud.gaming.v1.IGetRealmRequest

GetRealmRequest message or plain object

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

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

getRealm(request) → {Promise.<google.cloud.gaming.v1.Realm>}

Calls GetRealm.

Parameters:
Name Type Description
request google.cloud.gaming.v1.IGetRealmRequest

GetRealmRequest message or plain object

listRealms(request, callback) → {undefined}

Calls ListRealms.

Parameters:
Name Type Description
request google.cloud.gaming.v1.IListRealmsRequest

ListRealmsRequest message or plain object

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

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

listRealms(request) → {Promise.<google.cloud.gaming.v1.ListRealmsResponse>}

Calls ListRealms.

Parameters:
Name Type Description
request google.cloud.gaming.v1.IListRealmsRequest

ListRealmsRequest message or plain object

previewRealmUpdate(request, callback) → {undefined}

Calls PreviewRealmUpdate.

Parameters:
Name Type Description
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

previewRealmUpdate(request) → {Promise.<google.cloud.gaming.v1.PreviewRealmUpdateResponse>}

Calls PreviewRealmUpdate.

Parameters:
Name Type Description
request google.cloud.gaming.v1.IPreviewRealmUpdateRequest

PreviewRealmUpdateRequest message or plain object

updateRealm(request, callback) → {undefined}

Calls UpdateRealm.

Parameters:
Name Type 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

updateRealm(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateRealm.

Parameters:
Name Type Description
request google.cloud.gaming.v1.IUpdateRealmRequest

UpdateRealmRequest message or plain object

Type Definitions

CreateRealmCallback(error, responseopt)

Callback as used by google.cloud.gaming.v1.RealmsService#createRealm.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

DeleteRealmCallback(error, responseopt)

Callback as used by google.cloud.gaming.v1.RealmsService#deleteRealm.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

GetRealmCallback(error, responseopt)

Callback as used by google.cloud.gaming.v1.RealmsService#getRealm.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.gaming.v1.Realm <optional>

Realm

ListRealmsCallback(error, responseopt)

Callback as used by google.cloud.gaming.v1.RealmsService#listRealms.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.gaming.v1.ListRealmsResponse <optional>

ListRealmsResponse

PreviewRealmUpdateCallback(error, responseopt)

Callback as used by google.cloud.gaming.v1.RealmsService#previewRealmUpdate.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.gaming.v1.PreviewRealmUpdateResponse <optional>

PreviewRealmUpdateResponse

UpdateRealmCallback(error, responseopt)

Callback as used by google.cloud.gaming.v1.RealmsService#updateRealm.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation