Class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1IndexField

Inherits:

Object

• Object
• Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1IndexField

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

A field of an index.

Instance Attribute Summary

• #field_path ⇒ String

  The path of the field.

• #mode ⇒ String

  The field's mode.

Instance Method Summary

• #initialize(**args) ⇒ GoogleFirestoreAdminV1beta1IndexField constructor

  A new instance of GoogleFirestoreAdminV1beta1IndexField.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1beta1IndexField

Returns a new instance of GoogleFirestoreAdminV1beta1IndexField.

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1024

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

Instance Attribute Details

#field_path ⇒ String

The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path __name__ may be used by itself or at the end of a path. __type__ may be used only at the end of path. Corresponds to the JSON property fieldPath

Returns:

• (String)

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1017

def field_path
  @field_path
end

#mode ⇒ String

The field's mode. Corresponds to the JSON property mode

Returns:

• (String)

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1022

def mode
  @mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1029

def update!(**args)
  @field_path = args[:field_path] if args.key?(:field_path)
  @mode = args[:mode] if args.key?(:mode)
end