Class: Google::Apis::AdminDirectoryV1::SchemaFieldSpec

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

Overview

JSON template for FieldSpec resource for Schemas in Directory API.

Defined Under Namespace

Classes: NumericIndexingSpec

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) ⇒ SchemaFieldSpec

Returns a new instance of SchemaFieldSpec



2622
2623
2624
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2622

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

Instance Attribute Details

#display_nameString

Display Name of the field. Corresponds to the JSON property displayName

Returns:

  • (String)


2570
2571
2572
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2570

def display_name
  @display_name
end

#etagString

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String)


2575
2576
2577
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2575

def etag
  @etag
end

#field_idString

Unique identifier of Field (Read-only) Corresponds to the JSON property fieldId

Returns:

  • (String)


2580
2581
2582
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2580

def field_id
  @field_id
end

#field_nameString

Name of the field. Corresponds to the JSON property fieldName

Returns:

  • (String)


2585
2586
2587
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2585

def field_name
  @field_name
end

#field_typeString

Type of the field. Corresponds to the JSON property fieldType

Returns:

  • (String)


2590
2591
2592
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2590

def field_type
  @field_type
end

#indexedBoolean Also known as: indexed?

Boolean specifying whether the field is indexed or not. Corresponds to the JSON property indexed

Returns:

  • (Boolean)


2595
2596
2597
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2595

def indexed
  @indexed
end

#kindString

Kind of resource this is. Corresponds to the JSON property kind

Returns:

  • (String)


2601
2602
2603
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2601

def kind
  @kind
end

#multi_valuedBoolean Also known as: multi_valued?

Boolean specifying whether this is a multi-valued field or not. Corresponds to the JSON property multiValued

Returns:

  • (Boolean)


2606
2607
2608
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2606

def multi_valued
  @multi_valued
end

#numeric_indexing_specGoogle::Apis::AdminDirectoryV1::SchemaFieldSpec::NumericIndexingSpec

Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported. Corresponds to the JSON property numericIndexingSpec



2614
2615
2616
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2614

def numeric_indexing_spec
  @numeric_indexing_spec
end

#read_access_typeString

Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". Corresponds to the JSON property readAccessType

Returns:

  • (String)


2620
2621
2622
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2620

def read_access_type
  @read_access_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2627

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @etag = args[:etag] if args.key?(:etag)
  @field_id = args[:field_id] if args.key?(:field_id)
  @field_name = args[:field_name] if args.key?(:field_name)
  @field_type = args[:field_type] if args.key?(:field_type)
  @indexed = args[:indexed] if args.key?(:indexed)
  @kind = args[:kind] if args.key?(:kind)
  @multi_valued = args[:multi_valued] if args.key?(:multi_valued)
  @numeric_indexing_spec = args[:numeric_indexing_spec] if args.key?(:numeric_indexing_spec)
  @read_access_type = args[:read_access_type] if args.key?(:read_access_type)
end