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

Version 1.1.6

• 2.2.2 (latest)
• 2.2.1
• 2.1.2
• 1.2.1
• 1.1.6

Represents an ApiConfig.

Package

@google-cloud/api-gateway!

Constructors

(constructor)(properties)

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

Constructs a new ApiConfig.

Parameter

Name	Description
properties	IApiConfig Properties to set

Properties

createTime

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

ApiConfig createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

displayName

public displayName: string;

ApiConfig displayName.

Property Value

Type	Description
string

gatewayServiceAccount

public gatewayServiceAccount: string;

ApiConfig gatewayServiceAccount.

Property Value

Type	Description
string

grpcServices

public grpcServices: google.cloud.apigateway.v1.ApiConfig.IGrpcServiceDefinition[];

ApiConfig grpcServices.

Property Value

Type	Description
google.cloud.apigateway.v1.ApiConfig.IGrpcServiceDefinition[]

labels

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

ApiConfig labels.

Property Value

Type	Description
{ [k: string]: string }

managedServiceConfigs

public managedServiceConfigs: google.cloud.apigateway.v1.ApiConfig.IFile[];

ApiConfig managedServiceConfigs.

Property Value

Type	Description
google.cloud.apigateway.v1.ApiConfig.IFile[]

name

public name: string;

ApiConfig name.

Property Value

Type	Description
string

openapiDocuments

public openapiDocuments: google.cloud.apigateway.v1.ApiConfig.IOpenApiDocument[];

ApiConfig openapiDocuments.

Property Value

Type	Description
google.cloud.apigateway.v1.ApiConfig.IOpenApiDocument[]

serviceConfigId

public serviceConfigId: string;

ApiConfig serviceConfigId.

Property Value

Type	Description
string

state

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

ApiConfig state.

Property Value

Type	Description
(google.cloud.apigateway.v1.ApiConfig.State|keyof typeof google.cloud.apigateway.v1.ApiConfig.State)

updateTime

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

ApiConfig updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

Methods

create(properties)

public static create(properties?: google.cloud.apigateway.v1.IApiConfig): google.cloud.apigateway.v1.ApiConfig;

Creates a new ApiConfig instance using the specified properties.

Parameter

Name	Description
properties	IApiConfig Properties to set

Returns

Type	Description
google.cloud.apigateway.v1.ApiConfig	ApiConfig instance

decode(reader, length)

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

Decodes an ApiConfig 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.ApiConfig	ApiConfig

decodeDelimited(reader)

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

Decodes an ApiConfig 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.ApiConfig	ApiConfig

encode(message, writer)

public static encode(message: google.cloud.apigateway.v1.IApiConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ApiConfig message. Does not implicitly messages.

Parameters

Name	Description
message	IApiConfig ApiConfig 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.IApiConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ApiConfig message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	IApiConfig ApiConfig 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.ApiConfig;

Creates an ApiConfig 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.ApiConfig	ApiConfig

toJSON()

public toJSON(): { [k: string]: any };

Converts this ApiConfig to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.apigateway.v1.ApiConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an ApiConfig message. Also converts values to other types if specified.

Parameters

Name	Description
message	google.cloud.apigateway.v1.ApiConfig ApiConfig
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 ApiConfig 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