Represents a ServiceConfig.
Package
@google-cloud/service-usageConstructors
(constructor)(properties)
constructor(properties?: google.api.serviceusage.v1beta1.IServiceConfig);
Constructs a new ServiceConfig.
Parameter | |
---|---|
Name | Description |
properties |
IServiceConfig
Properties to set |
Properties
apis
public apis: google.protobuf.IApi[];
ServiceConfig apis.
authentication
public authentication?: (google.api.IAuthentication|null);
ServiceConfig authentication.
documentation
public documentation?: (google.api.IDocumentation|null);
ServiceConfig documentation.
endpoints
public endpoints: google.api.IEndpoint[];
ServiceConfig endpoints.
monitoredResources
public monitoredResources: google.api.IMonitoredResourceDescriptor[];
ServiceConfig monitoredResources.
monitoring
public monitoring?: (google.api.IMonitoring|null);
ServiceConfig monitoring.
name
public name: string;
ServiceConfig name.
quota
public quota?: (google.api.IQuota|null);
ServiceConfig quota.
title
public title: string;
ServiceConfig title.
usage
public usage?: (google.api.IUsage|null);
ServiceConfig usage.
Methods
create(properties)
public static create(properties?: google.api.serviceusage.v1beta1.IServiceConfig): google.api.serviceusage.v1beta1.ServiceConfig;
Creates a new ServiceConfig instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IServiceConfig
Properties to set |
Returns | |
---|---|
Type | Description |
ServiceConfig | ServiceConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.serviceusage.v1beta1.ServiceConfig;
Decodes a ServiceConfig 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 |
ServiceConfig | ServiceConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.serviceusage.v1beta1.ServiceConfig;
Decodes a ServiceConfig message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
ServiceConfig | ServiceConfig |
encode(message, writer)
public static encode(message: google.api.serviceusage.v1beta1.IServiceConfig, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified ServiceConfig message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IServiceConfig
ServiceConfig 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.serviceusage.v1beta1.IServiceConfig, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified ServiceConfig message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IServiceConfig
ServiceConfig 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.serviceusage.v1beta1.ServiceConfig;
Creates a ServiceConfig 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 |
ServiceConfig | ServiceConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for ServiceConfig
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 ServiceConfig to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.api.serviceusage.v1beta1.ServiceConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a ServiceConfig message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
ServiceConfig
ServiceConfig |
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 ServiceConfig message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|