Represents an Api.
Package
@google-cloud/service-managementConstructors
(constructor)(properties)
constructor(properties?: google.protobuf.IApi);
Constructs a new Api.
Parameter | |
---|---|
Name | Description |
properties |
IApi
Properties to set |
Properties
methods
public methods: google.protobuf.IMethod[];
Api methods.
mixins
public mixins: google.protobuf.IMixin[];
Api mixins.
name
public name: string;
Api name.
options
public options: google.protobuf.IOption[];
Api options.
sourceContext
public sourceContext?: (google.protobuf.ISourceContext|null);
Api sourceContext.
syntax
public syntax: (google.protobuf.Syntax|keyof typeof google.protobuf.Syntax);
Api syntax.
version
public version: string;
Api version.
Methods
create(properties)
public static create(properties?: google.protobuf.IApi): google.protobuf.Api;
Creates a new Api instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IApi
Properties to set |
Returns | |
---|---|
Type | Description |
Api | Api instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.protobuf.Api;
Decodes an Api 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 |
Api | Api |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.protobuf.Api;
Decodes an Api message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Api | Api |
encode(message, writer)
public static encode(message: google.protobuf.IApi, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Api message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IApi
Api 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.protobuf.IApi, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Api message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IApi
Api 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.protobuf.Api;
Creates an Api 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 |
Api | Api |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Api
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 Api to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.protobuf.Api, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an Api message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Api
Api |
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 an Api message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|