GroupService

google.monitoring.v3. GroupService

Represents a GroupService

Constructor

new GroupService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new GroupService 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

createGroup(request, callback) → {undefined}

Calls CreateGroup.

Parameters:
Name Type Description
request google.monitoring.v3.ICreateGroupRequest

CreateGroupRequest message or plain object

callback google.monitoring.v3.GroupService.CreateGroupCallback

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

Returns:
Type Description
undefined

createGroup(request) → {Promise.<google.monitoring.v3.Group>}

Calls CreateGroup.

Parameters:
Name Type Description
request google.monitoring.v3.ICreateGroupRequest

CreateGroupRequest message or plain object

Returns:
Type Description
Promise.<google.monitoring.v3.Group>

Promise

deleteGroup(request, callback) → {undefined}

Calls DeleteGroup.

Parameters:
Name Type Description
request google.monitoring.v3.IDeleteGroupRequest

DeleteGroupRequest message or plain object

callback google.monitoring.v3.GroupService.DeleteGroupCallback

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

Returns:
Type Description
undefined

deleteGroup(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteGroup.

Parameters:
Name Type Description
request google.monitoring.v3.IDeleteGroupRequest

DeleteGroupRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

getGroup(request, callback) → {undefined}

Calls GetGroup.

Parameters:
Name Type Description
request google.monitoring.v3.IGetGroupRequest

GetGroupRequest message or plain object

callback google.monitoring.v3.GroupService.GetGroupCallback

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

Returns:
Type Description
undefined

getGroup(request) → {Promise.<google.monitoring.v3.Group>}

Calls GetGroup.

Parameters:
Name Type Description
request google.monitoring.v3.IGetGroupRequest

GetGroupRequest message or plain object

Returns:
Type Description
Promise.<google.monitoring.v3.Group>

Promise

listGroupMembers(request, callback) → {undefined}

Calls ListGroupMembers.

Parameters:
Name Type Description
request google.monitoring.v3.IListGroupMembersRequest

ListGroupMembersRequest message or plain object

callback google.monitoring.v3.GroupService.ListGroupMembersCallback

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

Returns:
Type Description
undefined

listGroupMembers(request) → {Promise.<google.monitoring.v3.ListGroupMembersResponse>}

Calls ListGroupMembers.

Parameters:
Name Type Description
request google.monitoring.v3.IListGroupMembersRequest

ListGroupMembersRequest message or plain object

Returns:
Type Description
Promise.<google.monitoring.v3.ListGroupMembersResponse>

Promise

listGroups(request, callback) → {undefined}

Calls ListGroups.

Parameters:
Name Type Description
request google.monitoring.v3.IListGroupsRequest

ListGroupsRequest message or plain object

callback google.monitoring.v3.GroupService.ListGroupsCallback

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

Returns:
Type Description
undefined

listGroups(request) → {Promise.<google.monitoring.v3.ListGroupsResponse>}

Calls ListGroups.

Parameters:
Name Type Description
request google.monitoring.v3.IListGroupsRequest

ListGroupsRequest message or plain object

Returns:
Type Description
Promise.<google.monitoring.v3.ListGroupsResponse>

Promise

updateGroup(request, callback) → {undefined}

Calls UpdateGroup.

Parameters:
Name Type Description
request google.monitoring.v3.IUpdateGroupRequest

UpdateGroupRequest message or plain object

callback google.monitoring.v3.GroupService.UpdateGroupCallback

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

Returns:
Type Description
undefined

updateGroup(request) → {Promise.<google.monitoring.v3.Group>}

Calls UpdateGroup.

Parameters:
Name Type Description
request google.monitoring.v3.IUpdateGroupRequest

UpdateGroupRequest message or plain object

Returns:
Type Description
Promise.<google.monitoring.v3.Group>

Promise

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

Creates new GroupService 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
GroupService

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

Type Definitions

CreateGroupCallback(error, responseopt)

Callback as used by createGroup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.monitoring.v3.Group <optional>

Group

DeleteGroupCallback(error, responseopt)

Callback as used by deleteGroup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

GetGroupCallback(error, responseopt)

Callback as used by getGroup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.monitoring.v3.Group <optional>

Group

ListGroupMembersCallback(error, responseopt)

Callback as used by listGroupMembers.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.monitoring.v3.ListGroupMembersResponse <optional>

ListGroupMembersResponse

ListGroupsCallback(error, responseopt)

Callback as used by listGroups.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.monitoring.v3.ListGroupsResponse <optional>

ListGroupsResponse

UpdateGroupCallback(error, responseopt)

Callback as used by updateGroup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.monitoring.v3.Group <optional>

Group