Gateway

google.cloud.apigateway.v1. Gateway

Represents a Gateway.

Constructor

new Gateway(propertiesopt)

Constructs a new Gateway.

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

Properties to set
Implements:
  • IGateway

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

apiConfig

Gateway apiConfig.

createTime

Gateway createTime.

defaultHostname

Gateway defaultHostname.

displayName

Gateway displayName.

labels

Gateway labels.

name

Gateway name.

state

Gateway state.

updateTime

Gateway updateTime.

Methods

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

Creates a new Gateway instance using the specified properties.

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

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

Gateway instance

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

Decodes a Gateway 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.Gateway

Gateway
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.Gateway}

Decodes a Gateway 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.Gateway

Gateway
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 Gateway message. Does not implicitly verify messages.

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

Gateway 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 Gateway message, length delimited. Does not implicitly verify messages.

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

Gateway 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.Gateway}

Creates a Gateway 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.Gateway

Gateway

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

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

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

Gateway
options $protobuf.IConversionOptions <optional>

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

Plain object

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

Verifies a Gateway 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 Gateway to JSON.

Returns:
Type Description
Object.<string, *>

JSON object