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

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/firestore_v1/classes.rb,
generated/google/apis/firestore_v1/representations.rb,
generated/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

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

  The index configuration for this field.

• #name ⇒ String

  A field name of the form projects/project_id/databases/database_id/collectionGroups/collection_id/fields/field_path`` A field path may be a simple field name, e.g.

Instance Method Summary

• #initialize(**args) ⇒ GoogleFirestoreAdminV1Field constructor

  A new instance of GoogleFirestoreAdminV1Field.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1Field

Returns a new instance of GoogleFirestoreAdminV1Field

# File 'generated/google/apis/firestore_v1/classes.rb', line 881

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:

• (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig)

# File 'generated/google/apis/firestore_v1/classes.rb', line 851

def index_config
  @index_config
end

#name ⇒ String

A field name of the form projects/project_id/databases/database_id/collectionGroups/collection_id /fields/field_path A 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 key cityin 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)

# File 'generated/google/apis/firestore_v1/classes.rb', line 879

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/firestore_v1/classes.rb', line 886

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