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. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder- help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)

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.


2772
2773
2774
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2772

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

Instance Attribute Details

#display_nameString

Display Name of the field. Corresponds to the JSON property displayName

Returns:

  • (String)

2720
2721
2722
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2720

def display_name
  @display_name
end

#etagString

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String)

2725
2726
2727
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2725

def etag
  @etag
end

#field_idString

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

Returns:

  • (String)

2730
2731
2732
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2730

def field_id
  @field_id
end

#field_nameString

Name of the field. Corresponds to the JSON property fieldName

Returns:

  • (String)

2735
2736
2737
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2735

def field_name
  @field_name
end

#field_typeString

Type of the field. Corresponds to the JSON property fieldType

Returns:

  • (String)

2740
2741
2742
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2740

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)

2745
2746
2747
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2745

def indexed
  @indexed
end

#kindString

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

Returns:

  • (String)

2751
2752
2753
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2751

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)

2756
2757
2758
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2756

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


2764
2765
2766
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2764

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)

2770
2771
2772
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2770

def read_access_type
  @read_access_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2777

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