You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -118,7 +118,7 @@ <h3>Method Details</h3>
118
118
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
119
119
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
120
120
"fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
121
-
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
121
+
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
122
122
},
123
123
],
124
124
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
@@ -129,7 +129,7 @@ <h3>Method Details</h3>
129
129
"reverting": True or False, # Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`.
130
130
"usesAncestorConfig": True or False, # Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly.
131
131
},
132
-
"name": "A String", # A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.
132
+
"name": "A String", # Required. A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.
133
133
}</pre>
134
134
</div>
135
135
@@ -161,7 +161,7 @@ <h3>Method Details</h3>
161
161
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
162
162
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
163
163
"fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
164
-
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
164
+
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
165
165
},
166
166
],
167
167
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
@@ -172,7 +172,7 @@ <h3>Method Details</h3>
172
172
"reverting": True or False, # Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`.
173
173
"usesAncestorConfig": True or False, # Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly.
174
174
},
175
-
"name": "A String", # A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.
175
+
"name": "A String", # Required. A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.
176
176
},
177
177
],
178
178
"nextPageToken": "A String", # A page token that may be used to request another page of results. If blank, this is the last page.
@@ -198,7 +198,7 @@ <h3>Method Details</h3>
198
198
<pre>Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
199
199
200
200
Args:
201
-
name: string, A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. (required)
201
+
name: string, Required. A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. (required)
202
202
body: object, The request body.
203
203
The object takes the form of:
204
204
@@ -211,7 +211,7 @@ <h3>Method Details</h3>
211
211
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
212
212
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
213
213
"fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
214
-
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
214
+
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
215
215
},
216
216
],
217
217
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
@@ -222,7 +222,7 @@ <h3>Method Details</h3>
222
222
"reverting": True or False, # Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`.
223
223
"usesAncestorConfig": True or False, # Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly.
224
224
},
225
-
"name": "A String", # A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.
225
+
"name": "A String", # Required. A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.
226
226
}
227
227
228
228
updateMask: string, A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.
Copy file name to clipboardExpand all lines: docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -112,7 +112,7 @@ <h3>Method Details</h3>
112
112
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
113
113
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
114
114
"fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
115
-
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
115
+
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
116
116
},
117
117
],
118
118
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
@@ -186,7 +186,7 @@ <h3>Method Details</h3>
186
186
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
187
187
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
188
188
"fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
189
-
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
189
+
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
190
190
},
191
191
],
192
192
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
@@ -219,7 +219,7 @@ <h3>Method Details</h3>
219
219
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
220
220
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
221
221
"fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
222
-
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
222
+
"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
223
223
},
224
224
],
225
225
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
0 commit comments