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.



4163
4164
4165
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4163

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) 


4107
4108
4109
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4107

def display_name
  @display_name
end

#etag ⇒ String

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

Returns:

  • (String) 


4112
4113
4114
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4112

def etag
  @etag
end

#field_id ⇒ String

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

Returns:

  • (String) 


4117
4118
4119
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4117

def field_id
  @field_id
end

#field_name ⇒ String

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

Returns:

  • (String) 


4122
4123
4124
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4122

def field_name
  @field_name
end

#field_type ⇒ String

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

Returns:

  • (String) 


4127
4128
4129
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4127

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) 


4132
4133
4134
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4132

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) 


4139
4140
4141
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4139

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) 


4145
4146
4147
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4145

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:



4153
4154
4155
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4153

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) 


4161
4162
4163
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4161

def read_access_type
  @read_access_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 4168

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