Class: Google::Firestore::Admin::V1::Field

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/field.rb

Overview

Represents a single field in the database.

Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.

Defined Under Namespace

Classes: IndexConfig

Instance Attribute Summary collapse

Instance Attribute Details

#index_config ⇒ Google::Firestore::Admin::V1::Field::IndexConfig

Returns The index configuration for this field. If unset, field indexing will revert to the configuration defined by the ancestor_field. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.

Returns:

  • (Google::Firestore::Admin::V1::Field::IndexConfig) —

    The index configuration for this field. If unset, field indexing will revert to the configuration defined by the ancestor_field. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/field.rb', line 58

class Field
  # The index configuration for this field.
  # @!attribute [rw] indexes
  #   @return [Array<Google::Firestore::Admin::V1::Index>]
  #     The indexes supported for this field.
  # @!attribute [rw] uses_ancestor_config
  #   @return [true, 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.
  # @!attribute [rw] ancestor_field
  #   @return [String]
  #     Output only. Specifies the resource name of the `Field` from which this field's
  #     index configuration is set (when `uses_ancestor_config` is true),
  #     or from which it *would* be set if this field had no index configuration
  #     (when `uses_ancestor_config` is false).
  # @!attribute [rw] reverting
  #   @return [true, 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`.
  class IndexConfig; end
end

#name ⇒ String

Returns 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 namedaddress.city, not the map key cityin the fieldaddress. ``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.

Returns:

  • (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 namedaddress.city, not the map key cityin the fieldaddress. ``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.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/field.rb', line 58

class Field
  # The index configuration for this field.
  # @!attribute [rw] indexes
  #   @return [Array<Google::Firestore::Admin::V1::Index>]
  #     The indexes supported for this field.
  # @!attribute [rw] uses_ancestor_config
  #   @return [true, 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.
  # @!attribute [rw] ancestor_field
  #   @return [String]
  #     Output only. Specifies the resource name of the `Field` from which this field's
  #     index configuration is set (when `uses_ancestor_config` is true),
  #     or from which it *would* be set if this field had no index configuration
  #     (when `uses_ancestor_config` is false).
  # @!attribute [rw] reverting
  #   @return [true, 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`.
  class IndexConfig; end
end