Attribute

google.cloud.apihub.v1. Attribute

Represents an Attribute.

Constructor

new Attribute(propertiesopt)

Constructs a new Attribute.

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

Properties to set
Implements:
  • IAttribute

Classes

AllowedValue

Members

allowedValues

Attribute allowedValues.

cardinality

Attribute cardinality.

createTime

Attribute createTime.

dataType

Attribute dataType.

definitionType

Attribute definitionType.

description

Attribute description.

displayName

Attribute displayName.

mandatory

Attribute mandatory.

name

Attribute name.

scope

Attribute scope.

updateTime

Attribute updateTime.

DataType

DataType enum.

Properties:
Name Type Description
DATA_TYPE_UNSPECIFIED number

DATA_TYPE_UNSPECIFIED value
ENUM number

ENUM value
JSON number

JSON value
STRING number

STRING value

DefinitionType

DefinitionType enum.

Properties:
Name Type Description
DEFINITION_TYPE_UNSPECIFIED number

DEFINITION_TYPE_UNSPECIFIED value
SYSTEM_DEFINED number

SYSTEM_DEFINED value
USER_DEFINED number

USER_DEFINED value

Scope

Scope enum.

Properties:
Name Type Description
SCOPE_UNSPECIFIED number

SCOPE_UNSPECIFIED value
API number

API value
VERSION number

VERSION value
SPEC number

SPEC value
API_OPERATION number

API_OPERATION value
DEPLOYMENT number

DEPLOYMENT value
DEPENDENCY number

DEPENDENCY value
DEFINITION number

DEFINITION value
EXTERNAL_API number

EXTERNAL_API value
PLUGIN number

PLUGIN value

Methods

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

Converts this Attribute to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Attribute instance using the specified properties.

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

Properties to set
Returns:
Type Description
google.cloud.apihub.v1.Attribute

Attribute instance

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

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

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

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

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

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

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

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

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

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

Attribute

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Attribute

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 Attribute message. Also converts values to other types if specified.

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

Attribute
options $protobuf.IConversionOptions <optional>

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

Plain object

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

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