Interface IClientServiceRequest (1.55.0)

public interface IClientServiceRequest

A client service request which supports both sync and async execution to get the stream.

Namespace

Google.Apis.Requests

Assembly

Google.Apis.dll

Properties

HttpMethod

string HttpMethod { get; }

Gets the HTTP method of this request.

Property Value
TypeDescription
String

MethodName

string MethodName { get; }

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

Property Value
TypeDescription
String

RequestParameters

IDictionary<string, IParameter> RequestParameters { get; }

Gets the parameters information for this specific request.

Property Value
TypeDescription
IDictionary<String, IParameter>

RestPath

string RestPath { get; }

Gets the rest path of this request.

Property Value
TypeDescription
String

Service

IClientService Service { get; }

Gets the service which is related to this request.

Property Value
TypeDescription
IClientService

Methods

CreateRequest(Nullable<Boolean>)

HttpRequestMessage CreateRequest(bool? overrideGZipEnabled = default(bool? ))

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

Parameter
NameDescription
overrideGZipEnabledNullable<Boolean>

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

Returns
TypeDescription
HttpRequestMessage

ExecuteAsStream()

Stream ExecuteAsStream()

Executes the request and returns the result stream.

Returns
TypeDescription
Stream

ExecuteAsStreamAsync()

Task<Stream> ExecuteAsStreamAsync()

Executes the request asynchronously and returns the result stream.

Returns
TypeDescription
Task<Stream>

ExecuteAsStreamAsync(CancellationToken)

Task<Stream> ExecuteAsStreamAsync(CancellationToken cancellationToken)

Executes the request asynchronously and returns the result stream.

Parameter
NameDescription
cancellationTokenCancellationToken

A cancellation token to cancel operation.

Returns
TypeDescription
Task<Stream>

Extension Method