com.linkedin.restli.restspec
Class ParameterSchema.Fields

java.lang.Object
  com.linkedin.data.schema.PathSpec
      com.linkedin.restli.restspec.ParameterSchema.Fields

Enclosing class:

ParameterSchema

public static class ParameterSchema.Fields
extends com.linkedin.data.schema.PathSpec

Field Summary

Fields inherited from class com.linkedin.data.schema.PathSpec

WILDCARD

Constructor Summary

ParameterSchema.Fields()

ParameterSchema.Fields(java.util.List<java.lang.String> path, java.lang.String name)

Method Summary

CustomAnnotationContentSchemaMap.Fields	annotations() custom annotation data
com.linkedin.data.schema.PathSpec	default_() indicates the default value for this parameter
com.linkedin.data.schema.PathSpec	doc() Documentation for this parameter
com.linkedin.data.schema.PathSpec	items() type of individual items, if this is an array parameter (used for finder parameters)
com.linkedin.data.schema.PathSpec	name() name of this parameter
com.linkedin.data.schema.PathSpec	optional() indicates whether this parameter is optional.
com.linkedin.data.schema.PathSpec	type() avro type of this parameter

Methods inherited from class com.linkedin.data.schema.PathSpec

emptyPath, equals, getPathComponents, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterSchema.Fields

public ParameterSchema.Fields(java.util.List<java.lang.String> path,
                              java.lang.String name)

ParameterSchema.Fields

public ParameterSchema.Fields()

Method Detail

annotations

public CustomAnnotationContentSchemaMap.Fields annotations()

custom annotation data

name

public com.linkedin.data.schema.PathSpec name()

name of this parameter

type

public com.linkedin.data.schema.PathSpec type()

avro type of this parameter

items

public com.linkedin.data.schema.PathSpec items()

type of individual items, if this is an array parameter (used for finder parameters)

optional

public com.linkedin.data.schema.PathSpec optional()

indicates whether this parameter is optional. omitted for required parameters

default_

public com.linkedin.data.schema.PathSpec default_()

indicates the default value for this parameter

doc

public com.linkedin.data.schema.PathSpec doc()

Documentation for this parameter