Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

Cloud Firestore indexes enable simple and complex queries against documents in a database.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1Index

Returns a new instance of GoogleFirestoreAdminV1Index.



1611
1612
1613
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1611

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#api_scope ⇒ String

The API scope supported by this index. Corresponds to the JSON property apiScope

Returns:

  • (String) 


1574
1575
1576
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1574

def api_scope
  @api_scope
end

#fields ⇒ Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField>

The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. Corresponds to the JSON property fields

Returns:



1586
1587
1588
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1586

def fields
  @fields
end

#name ⇒ 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. Corresponds to the JSON propertyname`

Returns:

  • (String) 


1594
1595
1596
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1594

def name
  @name
end

#query_scope ⇒ String

Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. Corresponds to the JSON property queryScope

Returns:

  • (String) 


1604
1605
1606
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1604

def query_scope
  @query_scope
end

#state ⇒ String

Output only. The serving state of the index. Corresponds to the JSON property state

Returns:

  • (String) 


1609
1610
1611
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1609

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1616
1617
1618
1619
1620
1621
1622
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1616

def update!(**args)
  @api_scope = args[:api_scope] if args.key?(:api_scope)
  @fields = args[:fields] if args.key?(:fields)
  @name = args[:name] if args.key?(:name)
  @query_scope = args[:query_scope] if args.key?(:query_scope)
  @state = args[:state] if args.key?(:state)
end