Class RestMethod

Inheritance

System.Object

RestMethod

Implements

Google.Apis.Requests.IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.Discovery.v1.Data

Assembly: Google.Apis.Discovery.v1.dll

Syntax

public class RestMethod : IDirectResponseSchema

Properties

Description

Description of this method.

Declaration

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

Property Value

Type	Description
System.String

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

EtagRequired

Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.

Declaration

[JsonProperty("etagRequired")]
public virtual bool? EtagRequired { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

FlatPath

The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property.

Declaration

[JsonProperty("flatPath")]
public virtual string FlatPath { get; set; }

Property Value

Type	Description
System.String

HttpMethod

HTTP method used by this method.

Declaration

[JsonProperty("httpMethod")]
public virtual string HttpMethod { get; set; }

Property Value

Type	Description
System.String

Id

A unique ID for this method. This property can be used to match methods between different versions of Discovery.

Declaration

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

Property Value

Type	Description
System.String

MediaUpload

Media upload parameters.

Declaration

[JsonProperty("mediaUpload")]
public virtual RestMethod.MediaUploadData MediaUpload { get; set; }

Property Value

Type	Description
RestMethod.MediaUploadData

ParameterOrder

Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first.

Declaration

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

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Parameters

Details for all parameters in this method.

Declaration

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

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, JsonSchema>

Path

The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.

Declaration

[JsonProperty("path")]
public virtual string Path { get; set; }

Property Value

Type	Description
System.String

Request

The schema for the request.

Declaration

[JsonProperty("request")]
public virtual RestMethod.RequestData Request { get; set; }

Property Value

Type	Description
RestMethod.RequestData

Response

The schema for the response.

Declaration

[JsonProperty("response")]
public virtual RestMethod.ResponseData Response { get; set; }

Property Value

Type	Description
RestMethod.ResponseData

Scopes

OAuth 2.0 scopes applicable to this method.

Declaration

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

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

SupportsMediaDownload

Whether this method supports media downloads.

Declaration

[JsonProperty("supportsMediaDownload")]
public virtual bool? SupportsMediaDownload { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

SupportsMediaUpload

Whether this method supports media uploads.

Declaration

[JsonProperty("supportsMediaUpload")]
public virtual bool? SupportsMediaUpload { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

SupportsSubscription

Whether this method supports subscriptions.

Declaration

[JsonProperty("supportsSubscription")]
public virtual bool? SupportsSubscription { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

UseMediaDownloadService

Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.

Declaration

[JsonProperty("useMediaDownloadService")]
public virtual bool? UseMediaDownloadService { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Implements

Google.Apis.Requests.IDirectResponseSchema