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

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

Overview

An index definition.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1beta1Index

Returns a new instance of GoogleFirestoreAdminV1beta1Index.



968
969
970
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 968

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) 


949
950
951
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 949

def collection_id
  @collection_id
end

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

The fields to index. Corresponds to the JSON property fields

Returns:



954
955
956
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 954

def fields
  @fields
end

#name ⇒ String

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

Returns:

  • (String) 


960
961
962
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 960

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


966
967
968
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 966

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



973
974
975
976
977
978
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 973

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