Class QueryableFieldDescription

An individual field that can be used as part of a query filter.

Inheritance

object

QueryableFieldDescription

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ResourcesearchService.Models

Assembly: OCI.DotNetSDK.Resourcesearch.dll

Syntax

public class QueryableFieldDescription

Properties

FieldName

Declaration

[Required(ErrorMessage = "FieldName is required.")]
[JsonProperty(PropertyName = "fieldName")]
public string FieldName { get; set; }

Property Value

Type	Description
string	The name of the field to use when constructing the query. Field names are present for all types except OBJECT.

Remarks

Required

FieldType

Declaration

[Required(ErrorMessage = "FieldType is required.")]
[JsonProperty(PropertyName = "fieldType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public QueryableFieldDescription.FieldTypeEnum? FieldType { get; set; }

Property Value

Type	Description
QueryableFieldDescription.FieldTypeEnum?	The type of the field, which dictates what semantics and query constraints you can use when searching or querying.

Remarks

Required

IsArray

Declaration

[JsonProperty(PropertyName = "isArray")]
public bool? IsArray { get; set; }

Property Value

Type	Description
bool?	Indicates that this field is actually an array of the specified field type.

ObjectProperties

Declaration

[JsonProperty(PropertyName = "objectProperties")]
public List<QueryableFieldDescription> ObjectProperties { get; set; }

Property Value

Type	Description
List<QueryableFieldDescription>	If the field type is OBJECT, then this property will provide all the individual properties of the object that can be queried.