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

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

Overview

JSON template for FieldSpec resource for Schemas in Directory API.

Defined Under Namespace

Classes: NumericIndexingSpec

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SchemaFieldSpec

Returns a new instance of SchemaFieldSpec.


2127
2128
2129
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2127

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

Instance Attribute Details

#etagString

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String)

2080
2081
2082
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2080

def etag
  @etag
end

#field_idString

Unique identifier of Field (Read-only) Corresponds to the JSON property fieldId

Returns:

  • (String)

2085
2086
2087
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2085

def field_id
  @field_id
end

#field_nameString

Name of the field. Corresponds to the JSON property fieldName

Returns:

  • (String)

2090
2091
2092
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2090

def field_name
  @field_name
end

#field_typeString

Type of the field. Corresponds to the JSON property fieldType

Returns:

  • (String)

2095
2096
2097
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2095

def field_type
  @field_type
end

#indexedBoolean Also known as: indexed?

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

Returns:

  • (Boolean)

2100
2101
2102
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2100

def indexed
  @indexed
end

#kindString

Kind of resource this is. Corresponds to the JSON property kind

Returns:

  • (String)

2106
2107
2108
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2106

def kind
  @kind
end

#multi_valuedBoolean Also known as: multi_valued?

Boolean specifying whether this is a multi-valued field or not. Corresponds to the JSON property multiValued

Returns:

  • (Boolean)

2111
2112
2113
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2111

def multi_valued
  @multi_valued
end

#numeric_indexing_specGoogle::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


2119
2120
2121
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2119

def numeric_indexing_spec
  @numeric_indexing_spec
end

#read_access_typeString

Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". Corresponds to the JSON property readAccessType

Returns:

  • (String)

2125
2126
2127
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2125

def read_access_type
  @read_access_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2132

def update!(**args)
  @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