Reference documentation and code samples for the Firestore in Datastore mode Admin V1 API class Google::Cloud::Datastore::Admin::V1::Index.
Datastore composite index definition.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#ancestor
def ancestor() -> ::Google::Cloud::Datastore::Admin::V1::Index::AncestorMode
Returns
- (::Google::Cloud::Datastore::Admin::V1::Index::AncestorMode) — Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.
#ancestor=
def ancestor=(value) -> ::Google::Cloud::Datastore::Admin::V1::Index::AncestorMode
Parameter
- value (::Google::Cloud::Datastore::Admin::V1::Index::AncestorMode) — Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.
Returns
- (::Google::Cloud::Datastore::Admin::V1::Index::AncestorMode) — Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.
#index_id
def index_id() -> ::String
Returns
- (::String) — Output only. The resource ID of the index.
#kind
def kind() -> ::String
Returns
- (::String) — Required. The entity kind to which this index applies.
#kind=
def kind=(value) -> ::String
Parameter
- value (::String) — Required. The entity kind to which this index applies.
Returns
- (::String) — Required. The entity kind to which this index applies.
#project_id
def project_id() -> ::String
Returns
- (::String) — Output only. Project ID.
#properties
def properties() -> ::Array<::Google::Cloud::Datastore::Admin::V1::Index::IndexedProperty>
Returns
- (::Array<::Google::Cloud::Datastore::Admin::V1::Index::IndexedProperty>) — Required. An ordered sequence of property names and their index attributes.
#properties=
def properties=(value) -> ::Array<::Google::Cloud::Datastore::Admin::V1::Index::IndexedProperty>
Parameter
- value (::Array<::Google::Cloud::Datastore::Admin::V1::Index::IndexedProperty>) — Required. An ordered sequence of property names and their index attributes.
Returns
- (::Array<::Google::Cloud::Datastore::Admin::V1::Index::IndexedProperty>) — Required. An ordered sequence of property names and their index attributes.
#state
def state() -> ::Google::Cloud::Datastore::Admin::V1::Index::State
Returns
- (::Google::Cloud::Datastore::Admin::V1::Index::State) — Output only. The state of the index.