Class protos.google.cloud.apigateway.v1.Api (1.1.6)

Represents an Api.

Package

@google-cloud/api-gateway!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.apigateway.v1.IApi);

Constructs a new Api.

Parameter
Name Description
properties IApi

Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Api createTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

displayName

public displayName: string;

Api displayName.

Property Value
Type Description
string

labels

public labels: { [k: string]: string };

Api labels.

Property Value
Type Description
{ [k: string]: string }

managedService

public managedService: string;

Api managedService.

Property Value
Type Description
string

name

public name: string;

Api name.

Property Value
Type Description
string

state

public state: (google.cloud.apigateway.v1.Api.State|keyof typeof google.cloud.apigateway.v1.Api.State);

Api state.

Property Value
Type Description
(google.cloud.apigateway.v1.Api.State|keyof typeof google.cloud.apigateway.v1.Api.State)

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Api updateTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

Methods

create(properties)

public static create(properties?: google.cloud.apigateway.v1.IApi): google.cloud.apigateway.v1.Api;

Creates a new Api instance using the specified properties.

Parameter
Name Description
properties IApi

Properties to set
Returns
Type Description
google.cloud.apigateway.v1.Api

Api instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.apigateway.v1.Api;

Decodes an Api 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.cloud.apigateway.v1.Api

Api

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.apigateway.v1.Api;

Decodes an Api 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.cloud.apigateway.v1.Api

Api

encode(message, writer)

public static encode(message: google.cloud.apigateway.v1.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.cloud.apigateway.v1.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.cloud.apigateway.v1.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
google.cloud.apigateway.v1.Api

Api

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.cloud.apigateway.v1.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 google.cloud.apigateway.v1.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)

null if valid, otherwise the reason why it is not