Some or all of the information on this page might not apply to Trusted Cloud by S3NS. See Differences from Google Cloud for more details.

Interface IClientServiceRequest (1.68.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
`IDictionarystringIParameter`

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 = null)

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

Parameter
Name	Description
`overrideGZipEnabled`	`bool` 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
`TaskStream`

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
`TaskStream`