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

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

Overview

You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see Custom User Fields.

Defined Under Namespace

Classes: NumericIndexingSpec

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SchemaFieldSpec

Returns a new instance of SchemaFieldSpec.



4221
4222
4223
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4221

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

Instance Attribute Details

#display_name ⇒ String

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

Returns:

  • (String) 


4165
4166
4167
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4165

def display_name
  @display_name
end

#etag ⇒ String

The ETag of the field. Corresponds to the JSON property etag

Returns:

  • (String) 


4170
4171
4172
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4170

def etag
  @etag
end

#field_id ⇒ String

The unique identifier of the field (Read-only) Corresponds to the JSON property fieldId

Returns:

  • (String) 


4175
4176
4177
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4175

def field_id
  @field_id
end

#field_name ⇒ String

The name of the field. Corresponds to the JSON property fieldName

Returns:

  • (String) 


4180
4181
4182
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4180

def field_name
  @field_name
end

#field_type ⇒ String

The type of the field. Corresponds to the JSON property fieldType

Returns:

  • (String) 


4185
4186
4187
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4185

def field_type
  @field_type
end

#indexed ⇒ Boolean Also known as: indexed?

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

Returns:

  • (Boolean) 


4190
4191
4192
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4190

def indexed
  @indexed
end

#kind ⇒ String

The kind of resource this is. For schema fields this is always admin# directory#schema#fieldspec. Corresponds to the JSON property kind

Returns:

  • (String) 


4197
4198
4199
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4197

def kind
  @kind
end

#multi_valued ⇒ Boolean Also known as: multi_valued?

A boolean specifying whether this is a multi-valued field or not. Default: false. Corresponds to the JSON property multiValued

Returns:

  • (Boolean) 


4203
4204
4205
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4203

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

Returns:



4211
4212
4213
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4211

def numeric_indexing_spec
  @numeric_indexing_spec
end

#read_access_type ⇒ String

Specifies who can view values of this field. See Retrieve users as a non- administrator for more information. Note: It may take up to 24 hours for changes to this field to be reflected. Corresponds to the JSON property readAccessType

Returns:

  • (String) 


4219
4220
4221
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4219

def read_access_type
  @read_access_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4226

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