Class protos.google.api.serviceusage.v1beta1.Service (1.1.4)

Represents a Service.

Package

@google-cloud/service-usage!

Constructors

(constructor)(properties)

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

Constructs a new Service.

Parameter

Name	Description
properties	`IService` Properties to set

Properties

config

public config?: (google.api.serviceusage.v1beta1.IServiceConfig|null);

Service config.

Property Value

Type	Description
(google.api.serviceusage.v1beta1.IServiceConfig\|null)

name

public name: string;

Service name.

Property Value

Type	Description
string

parent

public parent: string;

Service parent.

Property Value

Type	Description
string

state

public state: (google.api.serviceusage.v1beta1.State|keyof typeof google.api.serviceusage.v1beta1.State);

Service state.

Property Value

Type	Description
(google.api.serviceusage.v1beta1.State\|keyof typeof google.api.serviceusage.v1beta1.State)

Methods

create(properties)

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

Creates a new Service instance using the specified properties.

Parameter

Name	Description
properties	`IService` Properties to set

Returns

Type	Description
google.api.serviceusage.v1beta1.Service	Service instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.serviceusage.v1beta1.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.serviceusage.v1beta1.Service	Service

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.serviceusage.v1beta1.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.serviceusage.v1beta1.Service	Service

encode(message, writer)

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