firestore.projects.databases.collection Groups.indexes.create

POST {{baseUrl}}/v1/:parent/indexes?$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.

Request Params

KeyDatatypeRequiredDescription
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").

Request Body

{"fields"=>[{"arrayConfig"=>"<string>", "fieldPath"=>"<string>", "order"=>"<string>"}, {"arrayConfig"=>"<string>", "fieldPath"=>"<string>", "order"=>"<string>"}], "name"=>"<string>", "queryScope"=>"<string>", "state"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;done&quot;:false,&quot;error&quot;:{&quot;code&quot;:-44581362,&quot;message&quot;:&quot;Excep&quot;},&quot;metadata&quot;:{},&quot;name&quot;:&quot;ea mollit aute qui id&quot;,&quot;response&quot;:{}}