google_api_admin v0.18.0 GoogleApi.Admin.Directory_v1.Model.SchemaFieldSpec View Source

JSON template for FieldSpec resource for Schemas in Directory API.

Attributes

  • displayName (type: String.t, default: nil) - Display Name of the field.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • fieldId (type: String.t, default: nil) - Unique identifier of Field (Read-only)
  • fieldName (type: String.t, default: nil) - Name of the field.
  • fieldType (type: String.t, default: nil) - Type of the field.
  • indexed (type: boolean(), default: true) - Boolean specifying whether the field is indexed or not.
  • kind (type: String.t, default: admin#directory#schema#fieldspec) - Kind of resource this is.
  • multiValued (type: boolean(), default: nil) - Boolean specifying whether this is a multi-valued field or not.
  • numericIndexingSpec (type: GoogleApi.Admin.Directory_v1.Model.SchemaFieldSpecNumericIndexingSpec.t, default: nil) - 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.
  • readAccessType (type: String.t, default: ALL_DOMAIN_USERS) - Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Admin.Directory_v1.Model.SchemaFieldSpec{
  displayName: String.t(),
  etag: String.t(),
  fieldId: String.t(),
  fieldName: String.t(),
  fieldType: String.t(),
  indexed: boolean(),
  kind: String.t(),
  multiValued: boolean(),
  numericIndexingSpec:
    GoogleApi.Admin.Directory_v1.Model.SchemaFieldSpecNumericIndexingSpec.t(),
  readAccessType: String.t()
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.