Class protos.google.api.MetricDescriptor.MetricDescriptorMetadata (0.2.6)

Represents a MetricDescriptorMetadata.

Package

@google-cloud/service-management!

Constructors

(constructor)(properties)

constructor(properties?: google.api.MetricDescriptor.IMetricDescriptorMetadata);

Constructs a new MetricDescriptorMetadata.

Parameter
NameDescription
properties IMetricDescriptorMetadata

Properties to set

Properties

ingestDelay

public ingestDelay?: (google.protobuf.IDuration|null);

MetricDescriptorMetadata ingestDelay.

Property Value
TypeDescription
(google.protobuf.IDuration|null)

launchStage

public launchStage: (google.api.LaunchStage|keyof typeof google.api.LaunchStage);

MetricDescriptorMetadata launchStage.

Property Value
TypeDescription
(google.api.LaunchStage|keyof typeof google.api.LaunchStage)

samplePeriod

public samplePeriod?: (google.protobuf.IDuration|null);

MetricDescriptorMetadata samplePeriod.

Property Value
TypeDescription
(google.protobuf.IDuration|null)

Methods

create(properties)

public static create(properties?: google.api.MetricDescriptor.IMetricDescriptorMetadata): google.api.MetricDescriptor.MetricDescriptorMetadata;

Creates a new MetricDescriptorMetadata instance using the specified properties.

Parameter
NameDescription
properties IMetricDescriptorMetadata

Properties to set

Returns
TypeDescription
google.api.MetricDescriptor.MetricDescriptorMetadata

MetricDescriptorMetadata instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.MetricDescriptor.MetricDescriptorMetadata;

Decodes a MetricDescriptorMetadata message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.api.MetricDescriptor.MetricDescriptorMetadata

MetricDescriptorMetadata

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.MetricDescriptor.MetricDescriptorMetadata;

Decodes a MetricDescriptorMetadata message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.api.MetricDescriptor.MetricDescriptorMetadata

MetricDescriptorMetadata

encode(message, writer)

public static encode(message: google.api.MetricDescriptor.IMetricDescriptorMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MetricDescriptorMetadata message. Does not implicitly messages.

Parameters
NameDescription
message IMetricDescriptorMetadata

MetricDescriptorMetadata message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.api.MetricDescriptor.IMetricDescriptorMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MetricDescriptorMetadata message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IMetricDescriptorMetadata

MetricDescriptorMetadata message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.api.MetricDescriptor.MetricDescriptorMetadata;

Creates a MetricDescriptorMetadata message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.api.MetricDescriptor.MetricDescriptorMetadata

MetricDescriptorMetadata

toJSON()

public toJSON(): { [k: string]: any };

Converts this MetricDescriptorMetadata to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.api.MetricDescriptor.MetricDescriptorMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a MetricDescriptorMetadata message. Also converts values to other types if specified.

Parameters
NameDescription
message google.api.MetricDescriptor.MetricDescriptorMetadata

MetricDescriptorMetadata

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a MetricDescriptorMetadata message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not