Class: Google::Cloud::Firestore::Admin::V1::Field::IndexConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/admin/v1/field.rb

Overview

The index configuration for this field.

Instance Attribute Summary collapse

Instance Attribute Details

#ancestor_field ⇒ ::String

Returns 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).

Returns:

  • (::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).



92
93
94
95
 
# File 'proto_docs/google/firestore/admin/v1/field.rb', line 92

class IndexConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#indexes ⇒ ::Array<::Google::Cloud::Firestore::Admin::V1::Index>

Returns The indexes supported for this field.

Returns:



92
93
94
95
 
# File 'proto_docs/google/firestore/admin/v1/field.rb', line 92

class IndexConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#reverting ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



92
93
94
95
 
# File 'proto_docs/google/firestore/admin/v1/field.rb', line 92

class IndexConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#uses_ancestor_config ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



92
93
94
95
 
# File 'proto_docs/google/firestore/admin/v1/field.rb', line 92

class IndexConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end