CreateIndexRequest

google.firestore.admin.v1. CreateIndexRequest

Represents a CreateIndexRequest.

Constructor

new CreateIndexRequest(propertiesopt)

Constructs a new CreateIndexRequest.

Parameters:
Name Type Attributes Description
properties google.firestore.admin.v1.ICreateIndexRequest <optional>

Properties to set

Implements:
  • ICreateIndexRequest

Members

index

CreateIndexRequest index.

parent

CreateIndexRequest parent.

Methods

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

Converts this CreateIndexRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) fromObject(object) → {google.firestore.admin.v1.CreateIndexRequest}

Creates a CreateIndexRequest 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.firestore.admin.v1.CreateIndexRequest

CreateIndexRequest

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for CreateIndexRequest

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

Parameters:
Name Type Attributes Description
message google.firestore.admin.v1.CreateIndexRequest

CreateIndexRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object