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

(static) AncestorMode :number

AncestorMode enum.

Properties:
Name Type Description
ANCESTOR_MODE_UNSPECIFIED number

ANCESTOR_MODE_UNSPECIFIED value

NONE number

NONE value

ALL_ANCESTORS number

ALL_ANCESTORS value

(static) Direction :number

Direction enum.

Properties:
Name Type Description
DIRECTION_UNSPECIFIED number

DIRECTION_UNSPECIFIED value

ASCENDING number

ASCENDING value

DESCENDING number

DESCENDING value

(static) State :number

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 :google.datastore.admin.v1.Index.AncestorMode

Index ancestor.

indexId :string

Index indexId.

kind :string

Index kind.

projectId :string

Index projectId.

properties :Array.<google.datastore.admin.v1.Index.IIndexedProperty>

Index properties.

state :google.datastore.admin.v1.Index.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

(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

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

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

(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

(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

(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

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

Verifies an Index message.

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

Plain object to verify

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

Converts this Index to JSON.