class Google::Apis::AdminDirectoryV1::SchemaFieldSpec

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](/admin-sdk/directory/v1/ guides/manage-schemas).

Attributes

display_name[RW]

Display Name of the field. Corresponds to the JSON property `displayName` @return [String]

etag[RW]

The ETag of the field. Corresponds to the JSON property `etag` @return [String]

field_id[RW]

The unique identifier of the field (Read-only) Corresponds to the JSON property `fieldId` @return [String]

field_name[RW]

The name of the field. Corresponds to the JSON property `fieldName` @return [String]

field_type[RW]

The type of the field. Corresponds to the JSON property `fieldType` @return [String]

indexed[RW]

Boolean specifying whether the field is indexed or not. Default: `true`. Corresponds to the JSON property `indexed` @return [Boolean]

indexed?[RW]

Boolean specifying whether the field is indexed or not. Default: `true`. Corresponds to the JSON property `indexed` @return [Boolean]

kind[RW]

The kind of resource this is. For schema fields this is always `admin# directory#schema#fieldspec`. Corresponds to the JSON property `kind` @return [String]

multi_valued[RW]

A boolean specifying whether this is a multi-valued field or not. Default: ` false`. Corresponds to the JSON property `multiValued` @return [Boolean]

multi_valued?[RW]

A boolean specifying whether this is a multi-valued field or not. Default: ` false`. Corresponds to the JSON property `multiValued` @return [Boolean]

numeric_indexing_spec[RW]

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` @return [Google::Apis::AdminDirectoryV1::SchemaFieldSpec::NumericIndexingSpec]

read_access_type[RW]

Specifies who can view values of this field. See [Retrieve users as a non- administrator](/admin-sdk/directory/v1/guides/manage-users# retrieve_users_non_admin) 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` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/admin_directory_v1/classes.rb, line 3428
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/admin_directory_v1/classes.rb, line 3433
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