ApiConfig

google.cloud.apigateway.v1. ApiConfig

Represents an ApiConfig.

Constructor

new ApiConfig(propertiesopt)

Constructs a new ApiConfig.

Parameters:
Name Type Attributes Description
properties google.cloud.apigateway.v1.IApiConfig <optional>

Properties to set
Implements:
  • IApiConfig

Classes

File
GrpcServiceDefinition
OpenApiDocument

Members

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value
CREATING number

CREATING value
ACTIVE number

ACTIVE value
FAILED number

FAILED value
DELETING number

DELETING value
UPDATING number

UPDATING value
ACTIVATING number

ACTIVATING value

createTime

ApiConfig createTime.

displayName

ApiConfig displayName.

gatewayServiceAccount

ApiConfig gatewayServiceAccount.

grpcServices

ApiConfig grpcServices.

labels

ApiConfig labels.

managedServiceConfigs

ApiConfig managedServiceConfigs.

name

ApiConfig name.

openapiDocuments

ApiConfig openapiDocuments.

serviceConfigId

ApiConfig serviceConfigId.

state

ApiConfig state.

updateTime

ApiConfig updateTime.

Methods

(static) create(propertiesopt) → {google.cloud.apigateway.v1.ApiConfig}

Creates a new ApiConfig instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.apigateway.v1.IApiConfig <optional>

Properties to set
Returns:
Type Description
google.cloud.apigateway.v1.ApiConfig

ApiConfig instance

(static) decode(reader, lengthopt) → {google.cloud.apigateway.v1.ApiConfig}

Decodes an ApiConfig message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.cloud.apigateway.v1.ApiConfig

ApiConfig
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.apigateway.v1.ApiConfig}

Decodes an ApiConfig message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.cloud.apigateway.v1.ApiConfig

ApiConfig
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified ApiConfig message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.apigateway.v1.IApiConfig

ApiConfig message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.apigateway.v1.IApiConfig

ApiConfig message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.apigateway.v1.ApiConfig}

Creates an ApiConfig message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.cloud.apigateway.v1.ApiConfig

ApiConfig

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.apigateway.v1.ApiConfig

ApiConfig
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an ApiConfig message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this ApiConfig to JSON.

Returns:
Type Description
Object.<string, *>

JSON object