RealmsService

google.cloud.gaming.v1beta. 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

createRealm(request, callback) → {undefined}

Calls CreateRealm.

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

CreateRealmRequest message or plain object

callback google.cloud.gaming.v1beta.RealmsService.CreateRealmCallback

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

Returns:
Type Description
undefined

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

Calls CreateRealm.

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

CreateRealmRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

deleteRealm(request, callback) → {undefined}

Calls DeleteRealm.

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

DeleteRealmRequest message or plain object

callback google.cloud.gaming.v1beta.RealmsService.DeleteRealmCallback

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

Returns:
Type Description
undefined

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

Calls DeleteRealm.

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

DeleteRealmRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

getRealm(request, callback) → {undefined}

Calls GetRealm.

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

GetRealmRequest message or plain object

callback google.cloud.gaming.v1beta.RealmsService.GetRealmCallback

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

Returns:
Type Description
undefined

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

Calls GetRealm.

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

GetRealmRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.gaming.v1beta.Realm>

Promise

listRealms(request, callback) → {undefined}

Calls ListRealms.

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

ListRealmsRequest message or plain object

callback google.cloud.gaming.v1beta.RealmsService.ListRealmsCallback

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

Returns:
Type Description
undefined

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

Calls ListRealms.

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

ListRealmsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.gaming.v1beta.ListRealmsResponse>

Promise

previewRealmUpdate(request, callback) → {undefined}

Calls PreviewRealmUpdate.

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

PreviewRealmUpdateRequest message or plain object

callback google.cloud.gaming.v1beta.RealmsService.PreviewRealmUpdateCallback

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

Returns:
Type Description
undefined

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

Calls PreviewRealmUpdate.

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

PreviewRealmUpdateRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.gaming.v1beta.PreviewRealmUpdateResponse>

Promise

updateRealm(request, callback) → {undefined}

Calls UpdateRealm.

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

UpdateRealmRequest message or plain object

callback google.cloud.gaming.v1beta.RealmsService.UpdateRealmCallback

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

Returns:
Type Description
undefined

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

Calls UpdateRealm.

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

UpdateRealmRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

(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

Returns:
Type Description
RealmsService

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

Type Definitions

CreateRealmCallback(error, responseopt)

Callback as used by 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 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 getRealm.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Realm

ListRealmsCallback(error, responseopt)

Callback as used by listRealms.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

ListRealmsResponse

PreviewRealmUpdateCallback(error, responseopt)

Callback as used by previewRealmUpdate.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

PreviewRealmUpdateResponse

UpdateRealmCallback(error, responseopt)

Callback as used by updateRealm.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation