Class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Index

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

Overview

An index definition.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1beta1Index

Returns a new instance of GoogleFirestoreAdminV1beta1Index.



1802
1803
1804
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1802

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

Instance Attribute Details

#collection_id ⇒ String

The collection ID to which this index applies. Required. Corresponds to the JSON property collectionId

Returns:

  • (String) 


1785
1786
1787
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1785

def collection_id
  @collection_id
end

#fields ⇒ Array<Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1IndexField>

The fields to index. Corresponds to the JSON property fields

Returns:



1790
1791
1792
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1790

def fields
  @fields
end

#name ⇒ String

The resource name of the index. Output only. Corresponds to the JSON property name

Returns:

  • (String) 


1795
1796
1797
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1795

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


1800
1801
1802
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1800

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1807
1808
1809
1810
1811
1812
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1807

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