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