Class RestDescription

Inheritance

object

RestDescription

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Discovery.v1.Data

Assembly: Google.Apis.Discovery.v1.dll

Syntax

public class RestDescription : IDirectResponseSchema

Properties

Auth

Authentication information.

Declaration

[JsonProperty("auth")]
public virtual RestDescription.AuthData Auth { get; set; }

Property Value

Type	Description
RestDescription.AuthData

BasePath

[DEPRECATED] The base path for REST requests.

Declaration

[JsonProperty("basePath")]
public virtual string BasePath { get; set; }

Property Value

Type	Description
string

BaseUrl

[DEPRECATED] The base URL for REST requests.

Declaration

[JsonProperty("baseUrl")]
public virtual string BaseUrl { get; set; }

Property Value

Type	Description
string

BatchPath

The path for REST batch requests.

Declaration

[JsonProperty("batchPath")]
public virtual string BatchPath { get; set; }

Property Value

Type	Description
string

CanonicalName

Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.

Declaration

[JsonProperty("canonicalName")]
public virtual string CanonicalName { get; set; }

Property Value

Type	Description
string

Description

The description of this API.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

DiscoveryVersion

Indicate the version of the Discovery API used to generate this doc.

Declaration

[JsonProperty("discoveryVersion")]
public virtual string DiscoveryVersion { get; set; }

Property Value

Type	Description
string

DocumentationLink

A link to human readable documentation for the API.

Declaration

[JsonProperty("documentationLink")]
public virtual string DocumentationLink { get; set; }

Property Value

Type	Description
string

ETag

The ETag for this response.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

Endpoints

A list of location-based endpoint objects for this API. Each object contains the endpoint URL, location, description and deprecation status.

Declaration

[JsonProperty("endpoints")]
public virtual IList<RestDescription.EndpointsData> Endpoints { get; set; }

Property Value

Type	Description
IList<RestDescription.EndpointsData>

ExponentialBackoffDefault

Enable exponential backoff for suitable methods in the generated clients.

Declaration

[JsonProperty("exponentialBackoffDefault")]
public virtual bool? ExponentialBackoffDefault { get; set; }

Property Value

Type	Description
bool?

Features

A list of supported features for this API.

Declaration

[JsonProperty("features")]
public virtual IList<string> Features { get; set; }

Property Value

Type	Description
IList<string>

Icons

Links to 16x16 and 32x32 icons representing the API.

Declaration

[JsonProperty("icons")]
public virtual RestDescription.IconsData Icons { get; set; }

Property Value

Type	Description
RestDescription.IconsData

Id

The ID of this API.

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
string

Kind

The kind for this response.

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
string

Labels

Labels for the status of this API, such as labs or deprecated.

Declaration

[JsonProperty("labels")]
public virtual IList<string> Labels { get; set; }

Property Value

Type	Description
IList<string>

Methods

API-level methods for this API.

Declaration

[JsonProperty("methods")]
public virtual IDictionary<string, RestMethod> Methods { get; set; }

Property Value

Type	Description
IDictionary<string, RestMethod>

Name

The name of this API.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

OwnerDomain

The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name.

Declaration

[JsonProperty("ownerDomain")]
public virtual string OwnerDomain { get; set; }

Property Value

Type	Description
string

OwnerName

The name of the owner of this API. See ownerDomain.

Declaration

[JsonProperty("ownerName")]
public virtual string OwnerName { get; set; }

Property Value

Type	Description
string

PackagePath

The package of the owner of this API. See ownerDomain.

Declaration

[JsonProperty("packagePath")]
public virtual string PackagePath { get; set; }

Property Value

Type	Description
string

Parameters

Common parameters that apply across all apis.

Declaration

[JsonProperty("parameters")]
public virtual IDictionary<string, JsonSchema> Parameters { get; set; }

Property Value

Type	Description
IDictionary<string, JsonSchema>

Protocol

The protocol described by this document.

Declaration

[JsonProperty("protocol")]
public virtual string Protocol { get; set; }

Property Value

Type	Description
string

Resources

The resources in this API.

Declaration

[JsonProperty("resources")]
public virtual IDictionary<string, RestResource> Resources { get; set; }

Property Value

Type	Description
IDictionary<string, RestResource>

Revision

The version of this API.

Declaration

[JsonProperty("revision")]
public virtual string Revision { get; set; }

Property Value

Type	Description
string

RootUrl

The root URL under which all API services live.

Declaration

[JsonProperty("rootUrl")]
public virtual string RootUrl { get; set; }

Property Value

Type	Description
string

Schemas

The schemas for this API.

Declaration

[JsonProperty("schemas")]
public virtual IDictionary<string, JsonSchema> Schemas { get; set; }

Property Value

Type	Description
IDictionary<string, JsonSchema>

ServicePath

The base path for all REST requests.

Declaration

[JsonProperty("servicePath")]
public virtual string ServicePath { get; set; }

Property Value

Type	Description
string

Title

The title of this API.

Declaration

[JsonProperty("title")]
public virtual string Title { get; set; }

Property Value

Type	Description
string

Version

The version of this API.

Declaration

[JsonProperty("version")]
public virtual string Version { get; set; }

Property Value

Type	Description
string

VersionModule

Declaration

[JsonProperty("version_module")]
public virtual bool? VersionModule { get; set; }

Property Value

Type	Description
bool?

Implements

IDirectResponseSchema