MetricService

google.monitoring.v3. MetricService

Represents a MetricService

Constructor

new MetricService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

createMetricDescriptor(request, callback) → {undefined}

Calls CreateMetricDescriptor.

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

CreateMetricDescriptorRequest message or plain object
callback google.monitoring.v3.MetricService.CreateMetricDescriptorCallback

Node-style callback called with the error, if any, and MetricDescriptor
Returns:
Type Description
undefined

createMetricDescriptor(request) → {Promise.<google.api.MetricDescriptor>}

Calls CreateMetricDescriptor.

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

CreateMetricDescriptorRequest message or plain object
Returns:
Type Description
Promise.<google.api.MetricDescriptor>

Promise

createTimeSeries(request, callback) → {undefined}

Calls CreateTimeSeries.

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

CreateTimeSeriesRequest message or plain object
callback google.monitoring.v3.MetricService.CreateTimeSeriesCallback

Node-style callback called with the error, if any, and Empty
Returns:
Type Description
undefined

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

Calls CreateTimeSeries.

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

CreateTimeSeriesRequest message or plain object
Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteMetricDescriptor(request, callback) → {undefined}

Calls DeleteMetricDescriptor.

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

DeleteMetricDescriptorRequest message or plain object
callback google.monitoring.v3.MetricService.DeleteMetricDescriptorCallback

Node-style callback called with the error, if any, and Empty
Returns:
Type Description
undefined

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

Calls DeleteMetricDescriptor.

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

DeleteMetricDescriptorRequest message or plain object
Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

getMetricDescriptor(request, callback) → {undefined}

Calls GetMetricDescriptor.

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

GetMetricDescriptorRequest message or plain object
callback google.monitoring.v3.MetricService.GetMetricDescriptorCallback

Node-style callback called with the error, if any, and MetricDescriptor
Returns:
Type Description
undefined

getMetricDescriptor(request) → {Promise.<google.api.MetricDescriptor>}

Calls GetMetricDescriptor.

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

GetMetricDescriptorRequest message or plain object
Returns:
Type Description
Promise.<google.api.MetricDescriptor>

Promise

getMonitoredResourceDescriptor(request, callback) → {undefined}

Calls GetMonitoredResourceDescriptor.

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

GetMonitoredResourceDescriptorRequest message or plain object
callback google.monitoring.v3.MetricService.GetMonitoredResourceDescriptorCallback

Node-style callback called with the error, if any, and MonitoredResourceDescriptor
Returns:
Type Description
undefined

getMonitoredResourceDescriptor(request) → {Promise.<google.api.MonitoredResourceDescriptor>}

Calls GetMonitoredResourceDescriptor.

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

GetMonitoredResourceDescriptorRequest message or plain object
Returns:
Type Description
Promise.<google.api.MonitoredResourceDescriptor>

Promise

listMetricDescriptors(request, callback) → {undefined}

Calls ListMetricDescriptors.

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

ListMetricDescriptorsRequest message or plain object
callback google.monitoring.v3.MetricService.ListMetricDescriptorsCallback

Node-style callback called with the error, if any, and ListMetricDescriptorsResponse
Returns:
Type Description
undefined

listMetricDescriptors(request) → {Promise.<google.monitoring.v3.ListMetricDescriptorsResponse>}

Calls ListMetricDescriptors.

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

ListMetricDescriptorsRequest message or plain object
Returns:
Type Description
Promise.<google.monitoring.v3.ListMetricDescriptorsResponse>

Promise

listMonitoredResourceDescriptors(request, callback) → {undefined}

Calls ListMonitoredResourceDescriptors.

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

ListMonitoredResourceDescriptorsRequest message or plain object
callback google.monitoring.v3.MetricService.ListMonitoredResourceDescriptorsCallback

Node-style callback called with the error, if any, and ListMonitoredResourceDescriptorsResponse
Returns:
Type Description
undefined

listMonitoredResourceDescriptors(request) → {Promise.<google.monitoring.v3.ListMonitoredResourceDescriptorsResponse>}

Calls ListMonitoredResourceDescriptors.

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

ListMonitoredResourceDescriptorsRequest message or plain object
Returns:
Type Description
Promise.<google.monitoring.v3.ListMonitoredResourceDescriptorsResponse>

Promise

listTimeSeries(request, callback) → {undefined}

Calls ListTimeSeries.

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

ListTimeSeriesRequest message or plain object
callback google.monitoring.v3.MetricService.ListTimeSeriesCallback

Node-style callback called with the error, if any, and ListTimeSeriesResponse
Returns:
Type Description
undefined

listTimeSeries(request) → {Promise.<google.monitoring.v3.ListTimeSeriesResponse>}

Calls ListTimeSeries.

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

ListTimeSeriesRequest message or plain object
Returns:
Type Description
Promise.<google.monitoring.v3.ListTimeSeriesResponse>

Promise

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

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

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

Type Definitions

CreateMetricDescriptorCallback(error, responseopt)

Callback as used by createMetricDescriptor.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.api.MetricDescriptor <optional>

MetricDescriptor

CreateTimeSeriesCallback(error, responseopt)

Callback as used by createTimeSeries.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.protobuf.Empty <optional>

Empty

DeleteMetricDescriptorCallback(error, responseopt)

Callback as used by deleteMetricDescriptor.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.protobuf.Empty <optional>

Empty

GetMetricDescriptorCallback(error, responseopt)

Callback as used by getMetricDescriptor.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.api.MetricDescriptor <optional>

MetricDescriptor

GetMonitoredResourceDescriptorCallback(error, responseopt)

Callback as used by getMonitoredResourceDescriptor.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.api.MonitoredResourceDescriptor <optional>

MonitoredResourceDescriptor

ListMetricDescriptorsCallback(error, responseopt)

Callback as used by listMetricDescriptors.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.monitoring.v3.ListMetricDescriptorsResponse <optional>

ListMetricDescriptorsResponse

ListMonitoredResourceDescriptorsCallback(error, responseopt)

Callback as used by listMonitoredResourceDescriptors.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.monitoring.v3.ListMonitoredResourceDescriptorsResponse <optional>

ListMonitoredResourceDescriptorsResponse

ListTimeSeriesCallback(error, responseopt)

Callback as used by listTimeSeries.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.monitoring.v3.ListTimeSeriesResponse <optional>

ListTimeSeriesResponse