Class protos.google.api.Service (0.2.6)

Version 0.2.6

• 2.2.0 (latest)
• 1.2.2
• 1.1.3
• 0.4.0
• 0.3.1
• 0.2.6

Represents a Service.

Package

@google-cloud/service-management!

Constructors

(constructor)(properties)

constructor(properties?: google.api.IService);

Constructs a new Service.

Parameter

Name	Description
properties	IService Properties to set

Properties

apis

public apis: google.protobuf.IApi[];

Service apis.

Property Value

Type	Description
google.protobuf.IApi[]

authentication

public authentication?: (google.api.IAuthentication|null);

Service authentication.

Property Value

Type	Description
(google.api.IAuthentication|null)

backend

public backend?: (google.api.IBackend|null);

Service backend.

Property Value

Type	Description
(google.api.IBackend|null)

billing

public billing?: (google.api.IBilling|null);

Service billing.

Property Value

Type	Description
(google.api.IBilling|null)

configVersion

public configVersion?: (google.protobuf.IUInt32Value|null);

Service configVersion.

Property Value

Type	Description
(google.protobuf.IUInt32Value|null)

context

public context?: (google.api.IContext|null);

Service context.

Property Value

Type	Description
(google.api.IContext|null)

control

public control?: (google.api.IControl|null);

Service control.

Property Value

Type	Description
(google.api.IControl|null)

documentation

public documentation?: (google.api.IDocumentation|null);

Service documentation.

Property Value

Type	Description
(google.api.IDocumentation|null)

endpoints

public endpoints: google.api.IEndpoint[];

Service endpoints.

Property Value

Type	Description
google.api.IEndpoint[]

enums

public enums: google.protobuf.IEnum[];

Service enums.

Property Value

Type	Description
google.protobuf.IEnum[]

http

public http?: (google.api.IHttp|null);

Service http.

Property Value

Type	Description
(google.api.IHttp|null)

id

public id: string;

Service id.

Property Value

Type	Description
string

logging

public logging?: (google.api.ILogging|null);

Service logging.

Property Value

Type	Description
(google.api.ILogging|null)

logs

public logs: google.api.ILogDescriptor[];

Service logs.

Property Value

Type	Description
google.api.ILogDescriptor[]

metrics

public metrics: google.api.IMetricDescriptor[];

Service metrics.

Property Value

Type	Description
google.api.IMetricDescriptor[]

monitoredResources

public monitoredResources: google.api.IMonitoredResourceDescriptor[];

Service monitoredResources.

Property Value

Type	Description
google.api.IMonitoredResourceDescriptor[]

monitoring

public monitoring?: (google.api.IMonitoring|null);

Service monitoring.

Property Value

Type	Description
(google.api.IMonitoring|null)

name

public name: string;

Service name.

Property Value

Type	Description
string

producerProjectId

public producerProjectId: string;

Service producerProjectId.

Property Value

Type	Description
string

quota

public quota?: (google.api.IQuota|null);

Service quota.

Property Value

Type	Description
(google.api.IQuota|null)

sourceInfo

public sourceInfo?: (google.api.ISourceInfo|null);

Service sourceInfo.

Property Value

Type	Description
(google.api.ISourceInfo|null)

systemParameters

public systemParameters?: (google.api.ISystemParameters|null);

Service systemParameters.

Property Value

Type	Description
(google.api.ISystemParameters|null)

title

public title: string;

Service title.

Property Value

Type	Description
string

types

public types: google.protobuf.IType[];

Service types.

Property Value

Type	Description
google.protobuf.IType[]

usage

public usage?: (google.api.IUsage|null);

Service usage.

Property Value

Type	Description
(google.api.IUsage|null)

Methods

create(properties)

public static create(properties?: google.api.IService): google.api.Service;

Creates a new Service instance using the specified properties.

Parameter

Name	Description
properties	IService Properties to set

Returns

Type	Description
google.api.Service	Service instance

decode(reader, length)

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

Decodes a Service 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.api.Service	Service

decodeDelimited(reader)

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

Decodes a Service 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.api.Service	Service

encode(message, writer)

public static encode(message: google.api.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.api.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.api.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
google.api.Service	Service

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.api.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	google.api.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)	null if valid, otherwise the reason why it is not