Class ClientServiceRequest<TResponse>

Represents an abstract, strongly typed request base class to make requests to a service. Supports a strongly typed response.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<TResponse>
Implements
Inherited Members
Namespace: Google.Apis.Requests
Assembly: Google.Apis.dll
Syntax
public abstract class ClientServiceRequest<TResponse> : ClientServiceRequest, IClientServiceRequest<TResponse>, IClientServiceRequest
Type Parameters
Name Description
TResponse

The type of the response object

Constructors

ClientServiceRequest(IClientService)

Creates a new service request.

Declaration
protected ClientServiceRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

ApiVersion

The precise API version represented by this request. Subclasses generated from a specific known version should override this property, which will result in an x-api-version header being sent on the HTTP request.

Declaration
public virtual string ApiVersion { get; }
Property Value
Type Description
string

ETagAction

Defines whether the E-Tag will be used in a specified way or be ignored.

Declaration
public ETagAction ETagAction { get; set; }
Property Value
Type Description
ETagAction

HttpMethod

Gets the HTTP method of this request.

Declaration
public abstract string HttpMethod { get; }
Property Value
Type Description
string

MethodName

Gets the name of the method to which this request belongs.

Declaration
public abstract string MethodName { get; }
Property Value
Type Description
string

ModifyRequest

Gets or sets the callback for modifying HTTP requests made by this service request.

Declaration
public Action<HttpRequestMessage> ModifyRequest { get; set; }
Property Value
Type Description
Action<HttpRequestMessage>

RequestParameters

Gets the parameters information for this specific request.

Declaration
public IDictionary<string, IParameter> RequestParameters { get; }
Property Value
Type Description
IDictionary<string, IParameter>

RestPath

Gets the rest path of this request.

Declaration
public abstract string RestPath { get; }
Property Value
Type Description
string

Service

Gets the service which is related to this request.

Declaration
public IClientService Service { get; }
Property Value
Type Description
IClientService

ValidateParameters

Override for service-wide validation configuration in ValidateParameters. If this is null (the default) then the value from the service initializer is used to determine whether or not parameters should be validated client-side. If this is non-null, it overrides whatever value is specified in the service.

Declaration
public bool? ValidateParameters { get; set; }
Property Value
Type Description
bool?

Methods

CreateRequest(bool?)

Creates a HTTP request message with all path and query parameters, ETag, etc.

Declaration
public HttpRequestMessage CreateRequest(bool? overrideGZipEnabled = null)
Parameters
Type Name Description
bool? overrideGZipEnabled

If null use the service default GZip behavior. Otherwise indicates if GZip is enabled or disabled.
Returns
Type Description
HttpRequestMessage

Execute()

Executes the request and returns the result object.

Declaration
public TResponse Execute()
Returns
Type Description
TResponse

ExecuteAsStream()

Executes the request and returns the result stream.

Declaration
public Stream ExecuteAsStream()
Returns
Type Description
Stream

ExecuteAsStreamAsync()

Executes the request asynchronously and returns the result stream.

Declaration
public Task<Stream> ExecuteAsStreamAsync()
Returns
Type Description
Task<Stream>

ExecuteAsStreamAsync(CancellationToken)

Executes the request asynchronously and returns the result stream.

Declaration
public Task<Stream> ExecuteAsStreamAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken

A cancellation token to cancel operation.
Returns
Type Description
Task<Stream>

ExecuteAsync()

Executes the request asynchronously and returns the result object.

Declaration
public Task<TResponse> ExecuteAsync()
Returns
Type Description
Task<TResponse>

ExecuteAsync(CancellationToken)

Executes the request asynchronously and returns the result object.

Declaration
public Task<TResponse> ExecuteAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken

A cancellation token to cancel operation.
Returns
Type Description
Task<TResponse>

GenerateRequestUri()

Generates the right URL for this request.

Declaration
protected string GenerateRequestUri()
Returns
Type Description
string

GetBody()

Returns the body of this request.

Declaration
protected virtual object GetBody()
Returns
Type Description
object

The body of this request.

GetDefaultETagAction(string)

Returns the default ETagAction for a specific HTTP verb.

Declaration
public static ETagAction GetDefaultETagAction(string httpMethod)
Parameters
Type Name Description
string httpMethod
Returns
Type Description
ETagAction

InitParameters()

Initializes request's parameters. Inherited classes MUST override this method to add parameters to the RequestParameters dictionary.

Declaration
protected virtual void InitParameters()

Implements

Extension Methods