Index

google.datastore.admin.v1. Index

Represents an Index.

Constructor

new Index(propertiesopt)

Constructs a new Index.

Parameters:
Name Type Attributes Description
properties google.datastore.admin.v1.IIndex <optional>

Properties to set
Implements:
  • IIndex

Classes

IndexedProperty

Members

AncestorMode

AncestorMode enum.

Properties:
Name Type Description
ANCESTOR_MODE_UNSPECIFIED number

ANCESTOR_MODE_UNSPECIFIED value
NONE number

NONE value
ALL_ANCESTORS number

ALL_ANCESTORS value

Direction

Direction enum.

Properties:
Name Type Description
DIRECTION_UNSPECIFIED number

DIRECTION_UNSPECIFIED value
ASCENDING number

ASCENDING value
DESCENDING number

DESCENDING value

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value
CREATING number

CREATING value
READY number

READY value
DELETING number

DELETING value
ERROR number

ERROR value

ancestor

Index ancestor.

indexId

Index indexId.

kind

Index kind.

projectId

Index projectId.

properties

Index properties.

state

Index state.

Methods

(static) create(propertiesopt) → {google.datastore.admin.v1.Index}

Creates a new Index instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.datastore.admin.v1.IIndex <optional>

Properties to set
Returns:
Type Description
google.datastore.admin.v1.Index

Index instance

(static) decode(reader, lengthopt) → {google.datastore.admin.v1.Index}

Decodes an Index 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.datastore.admin.v1.Index

Index
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.datastore.admin.v1.Index}

Decodes an Index 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.datastore.admin.v1.Index

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

Parameters:
Name Type Attributes Description
message google.datastore.admin.v1.IIndex

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

Parameters:
Name Type Attributes Description
message google.datastore.admin.v1.IIndex

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

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

Writer

(static) fromObject(object) → {google.datastore.admin.v1.Index}

Creates an Index 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.datastore.admin.v1.Index

Index

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

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

Parameters:
Name Type Attributes Description
message google.datastore.admin.v1.Index

Index
options $protobuf.IConversionOptions <optional>

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

Plain object

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

Verifies an Index 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 Index to JSON.

Returns:
Type Description
Object.<string, *>

JSON object