Represents a Metric.
Package
@google-cloud/monitoringConstructors
(constructor)(properties)
constructor
(
properties
?:
google
.
api
.
IMetric
);
Constructs a new Metric.
Name | Description |
properties | IMetric
Properties to set |
Properties
labels
public
labels
:
{
[
k
:
string
]
:
string
};
Metric labels.
type
public
type
:
string
;
Metric type.
Methods
create(properties)
public
static
create
(
properties
?:
google
.
api
.
IMetric
)
:
google
.
api
.
Metric
;
Creates a new Metric instance using the specified properties.
Name | Description |
properties | IMetric
Properties to set |
Type | Description |
---|---|
google.api.Metric | Metric instance |
decode(reader, length)
public
static
decode
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
),
length
?:
number
)
:
google
.
api
.
Metric
;
Decodes a Metric message from the specified reader or buffer.
Name | Description |
reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
length | number
Message length if known beforehand |
Type | Description |
---|---|
google.api.Metric | Metric |
decodeDelimited(reader)
public
static
decodeDelimited
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
))
:
google
.
api
.
Metric
;
Decodes a Metric message from the specified reader or buffer, length delimited.
Name | Description |
reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
Type | Description |
---|---|
google.api.Metric | Metric |
encode(message, writer)
public
static
encode
(
message
:
google
.
api
.
IMetric
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified Metric message. Does not implicitly messages.
Name | Description |
message | IMetric
Metric message or plain object to encode |
writer | $protobuf. Writer
Writer to encode to |
Type | Description |
---|---|
$protobuf. Writer | Writer |
encodeDelimited(message, writer)
public
static
encodeDelimited
(
message
:
google
.
api
.
IMetric
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified Metric message, length delimited. Does not implicitly messages.
Name | Description |
message | IMetric
Metric message or plain object to encode |
writer | $protobuf. Writer
Writer to encode to |
Type | Description |
---|---|
$protobuf. Writer | Writer |
fromObject(object)
public
static
fromObject
(
object
:
{
[
k
:
string
]
:
any
})
:
google
.
api
.
Metric
;
Creates a Metric message from a plain object. Also converts values to their respective internal types.
Name | Description |
object | { [k: string]: any }
Plain object |
Type | Description |
---|---|
google.api.Metric | Metric |
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this Metric to JSON.
Type | Description |
---|---|
{ [k: string]: any } | JSON object |
toObject(message, options)
public
static
toObject
(
message
:
google
.
api
.
Metric
,
options
?:
$protobuf
.
IConversionOptions
)
:
{
[
k
:
string
]
:
any
};
Creates a plain object from a Metric message. Also converts values to other types if specified.
Name | Description |
message | google.api.Metric
Metric |
options | $protobuf. IConversionOptions
Conversion options |
Type | Description |
---|---|
{ [k: string]: any } | Plain object |
verify(message)
public
static
verify
(
message
:
{
[
k
:
string
]
:
any
})
:
(
string
|
null
);
Verifies a Metric message.
Name | Description |
message | { [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) | |