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.



2819
2820
2821
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2819

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

Instance Attribute Details

#display_nameString

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

Returns:

  • (String)


2767
2768
2769
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2767

def display_name
  @display_name
end

#etagString

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String)


2772
2773
2774
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2772

def etag
  @etag
end

#field_idString

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

Returns:

  • (String)


2777
2778
2779
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2777

def field_id
  @field_id
end

#field_nameString

Name of the field. Corresponds to the JSON property fieldName

Returns:

  • (String)


2782
2783
2784
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2782

def field_name
  @field_name
end

#field_typeString

Type of the field. Corresponds to the JSON property fieldType

Returns:

  • (String)


2787
2788
2789
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2787

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)


2792
2793
2794
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2792

def indexed
  @indexed
end

#kindString

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

Returns:

  • (String)


2798
2799
2800
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2798

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)


2803
2804
2805
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2803

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



2811
2812
2813
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2811

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)


2817
2818
2819
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2817

def read_access_type
  @read_access_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2824

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