ApiHubInstance

google.cloud.apihub.v1. ApiHubInstance

Represents an ApiHubInstance.

Constructor

new ApiHubInstance(propertiesopt)

Constructs a new ApiHubInstance.

Parameters:
Name Type Attributes Description
properties google.cloud.apihub.v1.IApiHubInstance <optional>

Properties to set

Implements:
  • IApiHubInstance

Classes

Config

Members

config

ApiHubInstance config.

createTime

ApiHubInstance createTime.

description

ApiHubInstance description.

labels

ApiHubInstance labels.

name

ApiHubInstance name.

state

ApiHubInstance state.

stateMessage

ApiHubInstance stateMessage.

updateTime

ApiHubInstance updateTime.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

INACTIVE number

INACTIVE value

CREATING number

CREATING value

ACTIVE number

ACTIVE value

UPDATING number

UPDATING value

DELETING number

DELETING value

FAILED number

FAILED value

Methods

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

Converts this ApiHubInstance to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.apihub.v1.ApiHubInstance}

Creates a new ApiHubInstance instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.apihub.v1.IApiHubInstance <optional>

Properties to set

Returns:
Type Description
google.cloud.apihub.v1.ApiHubInstance

ApiHubInstance instance

(static) decode(reader, lengthopt) → {google.cloud.apihub.v1.ApiHubInstance}

Decodes an ApiHubInstance 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.apihub.v1.ApiHubInstance

ApiHubInstance

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.apihub.v1.ApiHubInstance}

Decodes an ApiHubInstance 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.apihub.v1.ApiHubInstance

ApiHubInstance

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

Parameters:
Name Type Attributes Description
message google.cloud.apihub.v1.IApiHubInstance

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

Parameters:
Name Type Attributes Description
message google.cloud.apihub.v1.IApiHubInstance

ApiHubInstance 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.apihub.v1.ApiHubInstance}

Creates an ApiHubInstance 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.apihub.v1.ApiHubInstance

ApiHubInstance

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ApiHubInstance

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

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

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

Parameters:
Name Type Attributes Description
message google.cloud.apihub.v1.ApiHubInstance

ApiHubInstance

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an ApiHubInstance 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