Class 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).

Inheritance

System.Object

SchemaFieldSpec

Implements

IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.Admin.Directory.directory_v1.Data

Assembly: Google.Apis.Admin.Directory.directory_v1.dll

Syntax

public class SchemaFieldSpec : IDirectResponseSchema

Properties

DisplayName

Display Name of the field.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
System.String

ETag

The ETag of the field.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

FieldId

The unique identifier of the field (Read-only)

Declaration

[JsonProperty("fieldId")]
public virtual string FieldId { get; set; }

Property Value

Type	Description
System.String

FieldName

The name of the field.

Declaration

[JsonProperty("fieldName")]
public virtual string FieldName { get; set; }

Property Value

Type	Description
System.String

FieldType

The type of the field.

Declaration

[JsonProperty("fieldType")]
public virtual string FieldType { get; set; }

Property Value

Type	Description
System.String

Indexed

Boolean specifying whether the field is indexed or not. Default: true.

Declaration

[JsonProperty("indexed")]
public virtual bool? Indexed { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Kind

The kind of resource this is. For schema fields this is always admin#directory#schema#fieldspec.

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
System.String

MultiValued

A boolean specifying whether this is a multi-valued field or not. Default: false.

Declaration

[JsonProperty("multiValued")]
public virtual bool? MultiValued { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

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.

Declaration

[JsonProperty("numericIndexingSpec")]
public virtual SchemaFieldSpec.NumericIndexingSpecData NumericIndexingSpec { get; set; }

Property Value

Type	Description
SchemaFieldSpec.NumericIndexingSpecData

ReadAccessType

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.

Declaration

[JsonProperty("readAccessType")]
public virtual string ReadAccessType { get; set; }

Property Value

Type	Description
System.String

Implements

IDirectResponseSchema