Class: Google::Apis::AdminDirectoryV1::SchemaFieldSpec
- Inherits:
-
Object
- Object
- Google::Apis::AdminDirectoryV1::SchemaFieldSpec
- 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
-
#display_name ⇒ String
Display Name of the field.
-
#etag ⇒ String
ETag of the resource.
-
#field_id ⇒ String
Unique identifier of Field (Read-only) Corresponds to the JSON property
fieldId
. -
#field_name ⇒ String
Name of the field.
-
#field_type ⇒ String
Type of the field.
-
#indexed ⇒ Boolean
(also: #indexed?)
Boolean specifying whether the field is indexed or not.
-
#kind ⇒ String
Kind of resource this is.
-
#multi_valued ⇒ Boolean
(also: #multi_valued?)
Boolean specifying whether this is a multi-valued field or not.
-
#numeric_indexing_spec ⇒ Google::Apis::AdminDirectoryV1::SchemaFieldSpec::NumericIndexingSpec
Indexing spec for a numeric field.
-
#read_access_type ⇒ String
Read ACLs on the field specifying who can view values of this field.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SchemaFieldSpec
constructor
A new instance of SchemaFieldSpec.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ SchemaFieldSpec
Returns a new instance of SchemaFieldSpec
2783 2784 2785 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2783 def initialize(**args) update!(**args) end |
Instance Attribute Details
#display_name ⇒ String
Display Name of the field.
Corresponds to the JSON property displayName
2731 2732 2733 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2731 def display_name @display_name end |
#etag ⇒ String
ETag of the resource.
Corresponds to the JSON property etag
2736 2737 2738 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2736 def etag @etag end |
#field_id ⇒ String
Unique identifier of Field (Read-only)
Corresponds to the JSON property fieldId
2741 2742 2743 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2741 def field_id @field_id end |
#field_name ⇒ String
Name of the field.
Corresponds to the JSON property fieldName
2746 2747 2748 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2746 def field_name @field_name end |
#field_type ⇒ String
Type of the field.
Corresponds to the JSON property fieldType
2751 2752 2753 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2751 def field_type @field_type end |
#indexed ⇒ Boolean Also known as: indexed?
Boolean specifying whether the field is indexed or not.
Corresponds to the JSON property indexed
2756 2757 2758 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2756 def indexed @indexed end |
#kind ⇒ String
Kind of resource this is.
Corresponds to the JSON property kind
2762 2763 2764 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2762 def kind @kind end |
#multi_valued ⇒ Boolean Also known as: multi_valued?
Boolean specifying whether this is a multi-valued field or not.
Corresponds to the JSON property multiValued
2767 2768 2769 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2767 def multi_valued @multi_valued end |
#numeric_indexing_spec ⇒ Google::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
2775 2776 2777 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2775 def numeric_indexing_spec @numeric_indexing_spec end |
#read_access_type ⇒ String
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
2781 2782 2783 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2781 def read_access_type @read_access_type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2788 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 |