Creates the specified index. A newly created index's initial state is
CREATING
. On completion of the returned google.longrunning.Operation,
the state will be READY
. If the index already exists, the call will
return an ALREADY_EXISTS
status. During creation, the process could
result in an error, in which case the index will move to the ERROR
state. The process can be recovered by fixing the data that caused the
error, removing the index with delete, then re-creating the index with
create. Indexes with a single field cannot be created.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800
seconds (30
minutes) and can be changed to a maximum value of 31536000
seconds (one year)
for long-running operations using the connector_params
field. See the
Connectors reference.
The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters (connector_params
), refer to
Invoke a connector call.
Arguments
Parameters | |
---|---|
parent |
Required. The name of the database this index will apply to. For example:
|
body |
Required.
|
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
OperationError |
If the long-running operation finished unsuccessfully. |
ResponseTypeError |
If the long-running operation returned a response of the wrong type. |
Response
If successful, the response contains an instance of GoogleLongrunningOperation
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- create: call: googleapis.firestore.v1beta1.projects.databases.indexes.create args: parent: ... body: collectionId: ... fields: ... result: createResult
JSON
[ { "create": { "call": "googleapis.firestore.v1beta1.projects.databases.indexes.create", "args": { "parent": "...", "body": { "collectionId": "...", "fields": "..." } }, "result": "createResult" } } ]