com.google.api.server.spi.config

Class ResourceSchema

java.lang.Object

com.google.api.server.spi.config.ResourceSchema

public class ResourceSchema
extends java.lang.Object

Defines the schema for a resource, which will be exposed in discovery.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceSchema.Builder A builder for ResourceSchema.

Method Summary

Modifier and Type	Method and Description
static ResourceSchema.Builder	builderForType(java.lang.reflect.Type type) Constructs a new builder for ResourceSchemas.
static ResourceSchema.Builder	builderWithSchema(ResourceSchema schema) Constructs a new builder populated with an existing ResourceSchema.
boolean	equals(java.lang.Object obj)
java.lang.String	getName() Returns the custom name of the resource as it should appear in the schema.
java.util.Map<java.lang.String,ResourcePropertySchema>	getProperties() Returns map of property name to property schema.
java.lang.reflect.Type	getType() Gets the type the current schema represents.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

@Nullable
public java.lang.String getName()

Returns the custom name of the resource as it should appear in the schema. Returns null if no custom name was specified.

getType

public java.lang.reflect.Type getType()

Gets the type the current schema represents.

getProperties

public java.util.Map<java.lang.String,ResourcePropertySchema> getProperties()

Returns map of property name to property schema.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builderForType

public static ResourceSchema.Builder builderForType(java.lang.reflect.Type type)

Constructs a new builder for ResourceSchemas.

Parameters:

type - the resource type

builderWithSchema

public static ResourceSchema.Builder builderWithSchema(ResourceSchema schema)

Constructs a new builder populated with an existing ResourceSchema.

Parameters:

schema - a resource schema