Class: MetricsSpec
Represents a MetricsSpec.
Implements
Constructors
constructor
• new MetricsSpec(properties?): MetricsSpec
Constructs a new MetricsSpec.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IMetricsSpec | Properties to set |
Returns
Properties
acceptedClientCa
• acceptedClientCa: Uint8Array
The ca cert(s) in PEM format that clients connecting to the metrics endpoint can use for authentication. This must only be one value, but the CA can have a chain.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this MetricsSpec to JSON.
Returns
Object
JSON object
create
▸ create(properties?): MetricsSpec
Creates a new MetricsSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IMetricsSpec | Properties to set |
Returns
MetricsSpec instance
decode
▸ decode(reader, length?): MetricsSpec
Decodes a MetricsSpec message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
MetricsSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): MetricsSpec
Decodes a MetricsSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
MetricsSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified MetricsSpec message. Does not implicitly temporal.api.cloud.account.v1.MetricsSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IMetricsSpec | MetricsSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified MetricsSpec message, length delimited. Does not implicitly temporal.api.cloud.account.v1.MetricsSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IMetricsSpec | MetricsSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): MetricsSpec
Creates a MetricsSpec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
MetricsSpec
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for MetricsSpec
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a MetricsSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | MetricsSpec | MetricsSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object