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.
2886 2887 2888 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2886 def initialize(**args) update!(**args) end |
Instance Attribute Details
#display_name ⇒ String
Display Name of the field.
Corresponds to the JSON property displayName
2834 2835 2836 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2834 def display_name @display_name end |
#etag ⇒ String
ETag of the resource.
Corresponds to the JSON property etag
2839 2840 2841 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2839 def etag @etag end |
#field_id ⇒ String
Unique identifier of Field (Read-only)
Corresponds to the JSON property fieldId
2844 2845 2846 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2844 def field_id @field_id end |
#field_name ⇒ String
Name of the field.
Corresponds to the JSON property fieldName
2849 2850 2851 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2849 def field_name @field_name end |
#field_type ⇒ String
Type of the field.
Corresponds to the JSON property fieldType
2854 2855 2856 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2854 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
2859 2860 2861 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2859 def indexed @indexed end |
#kind ⇒ String
Kind of resource this is.
Corresponds to the JSON property kind
2865 2866 2867 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2865 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
2870 2871 2872 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2870 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
2878 2879 2880 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2878 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
2884 2885 2886 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2884 def read_access_type @read_access_type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 |
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2891 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 |