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.dll

string HttpMethod { get; }

Gets the HTTP method of this request.

Property Value
Type	Description
`String`

string MethodName { get; }

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

Property Value
Type	Description
`String`

IDictionary<string, IParameter> RequestParameters { get; }

Gets the parameters information for this specific request.

Property Value
Type	Description
`IDictionary<String, IParameter>`

string RestPath { get; }

Gets the rest path of this request.

Property Value
Type	Description
`String`

IClientService Service { get; }

Gets the service which is related to this request.

Property Value
Type	Description
`IClientService`

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

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

Parameter
Name	Description
`overrideGZipEnabled`	`Nullable<Boolean>` If `null` use the service default GZip behavior. Otherwise indicates if GZip is enabled or disabled.

Returns
Type	Description
`HttpRequestMessage`

Stream ExecuteAsStream()

Executes the request and returns the result stream.

Returns
Type	Description
`Stream`

Task<Stream> ExecuteAsStreamAsync()

Executes the request asynchronously and returns the result stream.

Returns
Type	Description
`Task<Stream>`

Task<Stream> ExecuteAsStreamAsync(CancellationToken cancellationToken)

Executes the request asynchronously and returns the result stream.

Parameter
Name	Description
`cancellationToken`	`CancellationToken` A cancellation token to cancel operation.

Returns
Type	Description
`Task<Stream>`