Represents a Metric.
Package
@google-cloud/containerConstructors
(constructor)(properties)
constructor(properties?: google.container.v1.OperationProgress.IMetric);Constructs a new Metric.
| Parameter | |
|---|---|
| Name | Description |
properties |
IMetric
Properties to set |
Properties
doubleValue
public doubleValue?: (number|null);Metric doubleValue.
intValue
public intValue?: (number|Long|string|null);Metric intValue.
name
public name: string;Metric name.
stringValue
public stringValue?: (string|null);Metric stringValue.
value
public value?: ("intValue"|"doubleValue"|"stringValue");Metric value.
Methods
create(properties)
public static create(properties?: google.container.v1.OperationProgress.IMetric): google.container.v1.OperationProgress.Metric;Creates a new Metric instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IMetric
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.container.v1.OperationProgress.Metric | Metric instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.container.v1.OperationProgress.Metric;Decodes a Metric message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.container.v1.OperationProgress.Metric | Metric |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.container.v1.OperationProgress.Metric;Decodes a Metric message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.container.v1.OperationProgress.Metric | Metric |
encode(message, writer)
public static encode(message: google.container.v1.OperationProgress.IMetric, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Metric message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IMetric
Metric message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.container.v1.OperationProgress.IMetric, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Metric message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IMetric
Metric message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.container.v1.OperationProgress.Metric;Creates a Metric message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
google.container.v1.OperationProgress.Metric | Metric |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Metric
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Metric to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.container.v1.OperationProgress.Metric, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Metric message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.container.v1.OperationProgress.Metric
Metric |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Metric message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|