Represents a Service.
Package
@google-cloud/service-managementConstructors
(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.
authentication
public authentication?: (google.api.IAuthentication|null);Service authentication.
backend
public backend?: (google.api.IBackend|null);Service backend.
billing
public billing?: (google.api.IBilling|null);Service billing.
configVersion
public configVersion?: (google.protobuf.IUInt32Value|null);Service configVersion.
context
public context?: (google.api.IContext|null);Service context.
control
public control?: (google.api.IControl|null);Service control.
documentation
public documentation?: (google.api.IDocumentation|null);Service documentation.
endpoints
public endpoints: google.api.IEndpoint[];Service endpoints.
enums
public enums: google.protobuf.IEnum[];Service enums.
http
public http?: (google.api.IHttp|null);Service http.
id
public id: string;Service id.
logging
public logging?: (google.api.ILogging|null);Service logging.
logs
public logs: google.api.ILogDescriptor[];Service logs.
metrics
public metrics: google.api.IMetricDescriptor[];Service metrics.
monitoredResources
public monitoredResources: google.api.IMonitoredResourceDescriptor[];Service monitoredResources.
monitoring
public monitoring?: (google.api.IMonitoring|null);Service monitoring.
name
public name: string;Service name.
producerProjectId
public producerProjectId: string;Service producerProjectId.
publishing
public publishing?: (google.api.IPublishing|null);Service publishing.
quota
public quota?: (google.api.IQuota|null);Service quota.
sourceInfo
public sourceInfo?: (google.api.ISourceInfo|null);Service sourceInfo.
systemParameters
public systemParameters?: (google.api.ISystemParameters|null);Service systemParameters.
title
public title: string;Service title.
types
public types: google.protobuf.IType[];Service types.
usage
public usage?: (google.api.IUsage|null);Service usage.
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 |
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 |
(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.api.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.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 |
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.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 |
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) |
|