Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field

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

Represents a single field in the database. Fields are grouped by their " Collection Group", which represent all collections in the database with the same id.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1Field

Returns a new instance of GoogleFirestoreAdminV1Field.



1696
1697
1698
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1696

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

Instance Attribute Details

#index_config ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig

The index configuration for this field. Corresponds to the JSON property indexConfig

Returns:



1663
1664
1665
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1663

def index_config
  @index_config
end

#name ⇒ String

Required. A field name of the form projects/project_id/databases/ database_id/collectionGroups/collection_id/fields/field_pathA field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`,( backtick),[,], as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block)`address.city`represents a field namedaddress.city, not the map keycityin the fieldaddress.`` represents a field named, not any field. A specialFieldcontains the default indexing settings for all fields. This field's resource name is: projects/project_id/databases/database_id/collectionGroups/default/ fields/*Indexes defined on thisFieldwill be applied to all fields which do not have their ownFieldindex configuration. Corresponds to the JSON propertyname`

Returns:

  • (String) 


1684
1685
1686
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1684

def name
  @name
end

#ttl_config ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1TtlConfig

The TTL (time-to-live) configuration for documents that have this Field set. Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. Timestamp values in the past indicate that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document. Corresponds to the JSON property ttlConfig

Returns:



1694
1695
1696
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1694

def ttl_config
  @ttl_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1701
1702
1703
1704
1705
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1701

def update!(**args)
  @index_config = args[:index_config] if args.key?(:index_config)
  @name = args[:name] if args.key?(:name)
  @ttl_config = args[:ttl_config] if args.key?(:ttl_config)
end