Represents a Service.
Package
@google-cloud/monitoringConstructors
(constructor)(properties)
constructor(properties?: google.monitoring.v3.IService);
Constructs a new Service.
Parameter | |
---|---|
Name | Description |
properties |
IService
Properties to set |
Properties
appEngine
public appEngine?: (google.monitoring.v3.Service.IAppEngine|null);
Service appEngine.
cloudEndpoints
public cloudEndpoints?: (google.monitoring.v3.Service.ICloudEndpoints|null);
Service cloudEndpoints.
clusterIstio
public clusterIstio?: (google.monitoring.v3.Service.IClusterIstio|null);
Service clusterIstio.
custom
public custom?: (google.monitoring.v3.Service.ICustom|null);
Service custom.
displayName
public displayName: string;
Service displayName.
identifier
public identifier?: ("custom"|"appEngine"|"cloudEndpoints"|"clusterIstio"|"meshIstio"|"istioCanonicalService");
Service identifier.
istioCanonicalService
public istioCanonicalService?: (google.monitoring.v3.Service.IIstioCanonicalService|null);
Service istioCanonicalService.
meshIstio
public meshIstio?: (google.monitoring.v3.Service.IMeshIstio|null);
Service meshIstio.
name
public name: string;
Service name.
telemetry
public telemetry?: (google.monitoring.v3.Service.ITelemetry|null);
Service telemetry.
Methods
create(properties)
public static create(properties?: google.monitoring.v3.IService): google.monitoring.v3.Service;
Creates a new Service instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IService
Properties to set |
Returns | |
---|---|
Type | Description |
Service | Service instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.v3.Service;
Decodes a Service message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
Service | Service |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.v3.Service;
Decodes a Service message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Service | Service |
encode(message, writer)
public static encode(message: google.monitoring.v3.IService, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Service message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IService
Service 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.monitoring.v3.IService, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Service message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IService
Service 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.monitoring.v3.Service;
Creates a Service 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 |
Service | Service |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Service
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 Service to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.monitoring.v3.Service, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Service message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Service
Service |
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 Service message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|