Hyak.Common

The CloudCredentials class is the base class for providing credentials to access REST services.

Initialize a ServiceClient instance to process credentials.

Type of ServiceClient. The ServiceClient.

Apply the credentials to the HTTP request.

The HTTP request. Cancellation token. Task that will complete when processing has completed.

Representation of the error object from the server.

Parsed error message.

Parsed error code.

Original error body

Original response message body

Base class used to describe HTTP requests and responses associated with error conditions.

Initializes a new instance of the CloudHttpErrorInfo class.

Add the HTTP message headers to the error info.

Collection of HTTP header.

Gets or sets the contents of the HTTP message.

Gets the collection of HTTP headers.

Gets or sets the HTTP message version.

Describes HTTP requests associated with error conditions.

Initializes a new instance of the CloudHttpRequestErrorInfo class.

Creates a new CloudHttpRequestErrorInfo from a HttpRequestMessage.

The request message. A CloudHttpRequestErrorInfo instance.

Creates a new CloudHttpRequestErrorInfo from a HttpRequestMessage.

The request message. The request content, which may be passed separately if the request has already been disposed. A CloudHttpRequestErrorInfo instance.

Gets or sets the HTTP method used by the HTTP request message.

Gets or sets the Uri used for the HTTP request.

Gets a set of properties for the HTTP request.

Describes HTTP responses associated with error conditions.

Initializes a new instance of the CloudHttpResponseErrorInfo class.

Creates a new CloudHttpResponseErrorInfo from a HttpResponseMessage.

The response message. A CloudHttpResponseErrorInfo instance.

Creates a new CloudHttpResponseErrorInfo from a HttpResponseMessage.

The response message. The response content, which may be passed separately if the response has already been disposed. A CloudHttpResponseErrorInfo instance.

Gets or sets the status code of the HTTP response.

Gets or sets the reason phrase which typically is sent by servers together with the status code.

Wrapper class that provides manual reference count functionality

Type to wrap around. Must be disposable.

Extensions for manipulating HTTP requests and responses.

Get the HTTP message content as a string.

The HTTP content. The HTTP message content as a string.

Get the content headers for an HTTP request.

The request message. The content headers.

Get the content headers for an HTTP response.

The response message. The content headers.

Get a standard string representation of an HTTP request.

The request message. String representation of the request.

Get a standard string representation of an HTTP request.

The request message. String representation of the request.

Append an HTTP request.

The StringBuilder. The request message.

Append an HTTP request.

The StringBuilder. The request message.

Append the components of an HTTP request.

The StringBuilder. The request method. The request URI. The request HTTP version. The request headers. The request content headers. The request properties. The request content.

Get a standard string representation of an HTTP response.

The response message. String representation of the response.

Get a standard string representation of an HTTP response.

The response message. String representation of the response.

Append an HTTP response.

The StringBuilder. The response message.

Append an HTTP response.

The StringBuilder. The response message.

Append the components of an HTTP response.

The StringBuilder. The response status code. The response reason phrase. The response HTTP version. The response headers. The response content headers. The response content.

Append HTTP headers.

The StringBuilder. The HTTP headers.

Wrapper class for HttpMessageHandler that prevents InnerHandler from being disposed.

Initializes a new instance of the class from HttpMessageHandler.

InnerHandler to wrap.

Overrides Dispose of the base class to prevent disposal of the InnerHandler.

If set to true indicates the method is being called from Dispose().

Static type conversion utility methods.

Converts an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits.

An array of 8-bit unsigned integers. The string representation, in base 64, of the contents of value.

Decodes all the bytes in the specified byte array into a string.

The byte array containing the sequence of bytes to decode. A string that contains the results of decoding the specified sequence of bytes.

Converts the specified string, which encodes binary data as base-64 digits, to a UTF8-encoded string.

The base 64-encoded string to convert. Returns a string.

Uses Uri::TryCreate method to safely attempt to parse a string value and return its Uri representation. Supports relative Uris.

The Uri string. Returns a new Uri instance or null.

A standard service response including an HTTP status code and request ID.

Gets or sets the standard HTTP status code from the REST API operations for the Service Management API.

Http retry handler.

Initializes a new instance of the class. Sets default retry policty base on Exponential Backoff.

Initializes a new instance of the class. Sets the default retry policty base on Exponential Backoff.

Inner http handler.

Initializes a new instance of the class.

Retry policy to use. Inner http handler.

Sends an HTTP request to the inner handler to send to the server as an asynchronous operation. Retries request if needed based on Retry Policy.

The HTTP request message to send to the server. A cancellation token to cancel operation. Returns System.Threading.Tasks.Task<TResult>. The task object representing the asynchronous operation.

Gets or sets retry policy.

An instance of a callback delegate that will be invoked whenever a retry condition is encountered.

The collection of tracing interceptors to notify.

A read-only, thread-safe collection of tracing interceptors. Since List is only thread-safe for reads (and adding/removing tracing interceptors isn't a very common operation), we simply replace the entire collection of interceptors so any enumeration of the list in progress on a different thread will not be affected by the change.

Lock used to synchronize mutation of the tracing interceptors.

Initializes a new instance of the CloudTracing class.

Add a tracing interceptor to be notified of changes.

The tracing interceptor.

Remove a tracing interceptor from change notifications.

The tracing interceptor. True if the tracing interceptor was found and removed; false otherwise.

Gets or sets a value indicating whether tracing is enabled. Tracing can be disabled for performance.

Gets a sequence of the tracing interceptors to notify of changes.

The base ServiceClient class used to call REST services.

Type of the ServiceClient.

Gets the Platform's IHttpTransportHandlerProvider which gives the default HttpHandler for sending web requests.

A value indicating whether or not the ServiceClient has already been disposed.

Reference to the delegated handler of our handler (so we can maintain a proper reference count).

Reference to our HTTP handler (which is the start of our HTTP pipeline).

Initializes static members of the ServiceClient class.

Initializes a new instance of the ServiceClient class.

The http client.

Dispose the ServiceClient.

Get the HTTP pipeline for the given service client.

The client's HTTP pipeline.

Add a handler to the end of the client's HTTP pipeline.

The handler to add.

Sets retry policy for the client.

Retry policy to set.

Initializes HttpClient.

Http message handler to use with Http client.

Create the HTTP client.

The HTTP client.

Get the assembly version of a service client.

The assembly version of the client.

Clone the service client.

The client to clone.

Clone HttpClient properties.

The client to clone. The client to copy into.

Extend the ServiceClient with a new handler.

The new client that will extend. The handler to extend with. The extended client.

Gets the HttpClient used for making HTTP requests.

Gets a reference to our HTTP handler (which is the start of our HTTP pipeline).

Gets the UserAgent collection which can be augmented with custom user agent strings.

Interface used to represent resource groupings of ServiceClient operations.

Type of the ServiceClient.

Gets a reference to the ServiceClient.

Exception thrown for any invalid response.

Initializes a new instance of the CloudException class.

The exception message.

Initializes a new instance of the CloudException class.

The exception message. Inner exception.

Create a CloudException from a failed response.

The HTTP request. The HTTP request content. The HTTP response. The HTTP response content. Optional inner exception. A CloudException representing the failure.

Create a CloudException from a failed response. This method is obsolete. Use Create without defaultTo parameter.

The HTTP request. The HTTP request content. The HTTP response. The HTTP response content. The content type to default to if none of the types matches. Optional inner exception. A CloudException representing the failure.

Create a CloudException from a failed response sending XML content. This method is obsolete. Use Create without defaultTo parameter.

The HTTP request. The HTTP request content. The HTTP response. The HTTP response content. Optional inner exception. A CloudException representing the failure.

Create a CloudException from a failed response sending JSON content. This method is obsolete. Use Create without defaultTo parameter.

The HTTP request. The HTTP request content. The HTTP response. The HTTP response content. Optional inner exception. A CloudException representing the failure.

Parse the response content as either an XML or JSON error message.

The response content. An object containing the parsed error code and message.

Parse the response content as an XML error message.

The response content. An object containing the parsed error code and message.

Parse the response content as an JSON error message.

The response content. An object containing the parsed error code and message.

Checks if content is possibly an XML.

String to check. If set to true will validate entire XML for validity otherwise will just check the first character. True is content is possibly an XML otherwise false.

Checks if content is possibly a JSON.

String to check. If set to true will validate entire JSON for validity otherwise will just check the first character. True is content is possibly an JSON otherwise false.

Returns first non whitespace character

Text to search in Non whitespace or default char

Gets the error returned from the server.

Gets information about the associated HTTP request.

Gets information about the associated HTTP response.

Helper extension methods used by tracing providers.

Returns string representation of a HttpRequestMessage.

Request to format. Formatted string.

Returns string representation of a HttpResponseMessage.

Response to format. Formatted string.

Converts given dictionary into a log string.

The dictionary key type The dictionary value type The dictionary collection object The log string

The ICloudTracingInterceptor provides useful information about cloud operations. Interception is global and a tracing interceptor can be added via TracingAdapter.AddTracingInterceptor.

Trace information.

The information to trace.

Probe configuration for the value of a setting.

The configuration source. The name of the setting. The value of the setting in the source.

Enter a method.

Method invocation identifier. The instance with the method. Name of the method. Method parameters.

Send an HTTP request.

Method invocation identifier. The request about to be sent.

Receive an HTTP response.

Method invocation identifier. The response instance.

Raise an error.

Method invocation identifier. The error.

Exit a method. Note: Exit will not be called in the event of an error.

Method invocation identifier. Method return value.

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized string similar to Value cannot be empty. Parameter name: {0}.

Looks up a localized string similar to The specified argument {0} cannot be greater than its ceiling value of {1}..

Looks up a localized string similar to The specified argument {0} cannot be initialized with a negative value..

Looks up a localized string similar to Failed to convert parameter {0} value '{1}' to type {2}..

Looks up a localized string similar to {3} Failed to create {0} from connection settings {1} = "{2}"..

Looks up a localized string similar to No connection settings found for type {0}. Enable tracing for more information..

Looks up a localized string similar to No credentials of type '{0}' could be initialized from the provided settings..

Looks up a localized string similar to Parameter {0} is required..

Looks up a localized string similar to Default retry strategy for technology {0}, named '{1}', is not defined..

Looks up a localized string similar to Default retry strategy for technology {0} was not not defined, and there is no overall default strategy..

Looks up a localized string similar to Retry handler is not present in the HttpClient handler stack..

Looks up a localized string similar to The RetryManager is already set..

Looks up a localized string similar to The default RetryManager has not been set. Set it by invoking the RetryManager.SetDefault static method, or if you are using declarative configuration, you can invoke the RetryPolicyFactory.CreateDefault() method to automatically create the retry manager from the configuration file..

Looks up a localized string similar to Response status code indicates server error: {0} ({1})..

Looks up a localized string similar to The action has exceeded its defined retry limit..

Looks up a localized string similar to The retry strategy with name '{0}' cannot be found..

Looks up a localized string similar to The specified string argument {0} must not be empty..

Looks up a localized string similar to The specified argument '{0}' cannot return a null task when invoked..

Looks up a localized string similar to The specified argument '{0}' must return a scheduled task (also known as "hot" task) when invoked..

Handles the execution and retries of the user-initiated task.

The result type of the user-initiated task.

Provides a wrapper for a non-generic and calls into the pipeline to retry only the generic version of the .

Wraps the non-generic into a generic .

The task to wrap. A that wraps the non-generic .

Default Http error detection strategy based on Http Status Code.

Defines an interface that must be implemented by custom components responsible for detecting specific transient conditions.

Determines whether the specified exception represents a transient failure that can be compensated by a retry.

The exception object to be verified. true if the specified exception is considered as transient; otherwise, false.

Returns true if status code in HttpRequestExceptionWithStatus exception is greater than or equal to 500 and not NotImplemented (501) or HttpVersionNotSupported (505).

Exception to check against. True if exception is transient otherwise false.

A retry strategy with backoff parameters for calculating the exponential delay between retries.

Represents a retry strategy that determines the number of retry attempts and the interval between retries.

Represents the default number of retry attempts.

Represents the default amount of time used when calculating a random delta in the exponential delay between retries.

Represents the default maximum amount of time used when calculating the exponential delay between retries.

Represents the default minimum amount of time used when calculating the exponential delay between retries.

Represents the default interval between retries.

Represents the default time increment between retry attempts in the progressive delay policy.

Represents the default flag indicating whether the first retry attempt will be made immediately, whereas subsequent retries will remain subject to the retry interval.

Initializes a new instance of the class.

The name of the retry strategy. true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval.

Returns the corresponding ShouldRetry delegate.

The ShouldRetry delegate.

Returns a default policy that performs no retries, but invokes the action only once.

Returns a default policy that implements a fixed retry interval configured with the and parameters. The default retry policy treats all caught exceptions as transient errors.

Returns a default policy that implements a progressive retry interval configured with the , , and parameters. The default retry policy treats all caught exceptions as transient errors.

Returns a default policy that implements a random exponential retry interval configured with the , , , and parameters. The default retry policy treats all caught exceptions as transient errors.

Gets or sets a value indicating whether the first retry attempt will be made immediately, whereas subsequent retries will remain subject to the retry interval.

Gets the name of the retry strategy.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified retry settings.

The maximum number of retry attempts. The minimum backoff time The maximum backoff time. The value that will be used to calculate a random delta in the exponential delay between retries.

Initializes a new instance of the class with the specified name and retry settings.

Initializes a new instance of the class with the specified name, retry settings, and fast retry option.

The name of the retry strategy. The maximum number of retry attempts. The minimum backoff time The maximum backoff time. The value that will be used to calculate a random delta in the exponential delay between retries. true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval.

Returns the corresponding ShouldRetry delegate.

The ShouldRetry delegate.

Represents a retry strategy with a specified number of retry attempts and a default, fixed time interval between retries.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified number of retry attempts.

The number of retry attempts.

Initializes a new instance of the class with the specified number of retry attempts and time interval.

The number of retry attempts. The time interval between retries.

Initializes a new instance of the class with the specified number of retry attempts, time interval, and retry strategy.

The retry strategy name. The number of retry attempts. The time interval between retries.

Initializes a new instance of the class with the specified number of retry attempts, time interval, retry strategy, and fast start option.

The retry strategy name. The number of retry attempts. The time interval between retries. true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval.

Returns the corresponding ShouldRetry delegate.

The ShouldRetry delegate.

Implements the common guard methods.

Checks a string argument to ensure that it isn't null or empty.

The argument value to check. The name of the argument. The return value should be ignored. It is intended to be used only when validating arguments during instance creation (for example, when calling the base constructor).

Checks an argument to ensure that it isn't null.

Checks an argument to ensure that its 32-bit signed value isn't negative.

The value of the argument. The name of the argument for diagnostic purposes.

Checks an argument to ensure that its 64-bit signed value isn't negative.

The value of the argument. The name of the argument for diagnostic purposes.

Checks an argument to ensure that its value doesn't exceed the specified ceiling baseline.

The value of the argument. The ceiling value of the argument. The name of the argument for diagnostic purposes.

Inherits HttpRequestException adding HttpStatusCode to the exception.

Initializes a new instance of the class.

Initializes a new instance of the class with a specific message that describes the current exception.

A message that describes the current exception.

Initializes a new instance of the class with a specific message that describes the current exception and an inner exception.

A message that describes the current exception. The inner exception.

Http status code.

A retry strategy with a specified number of retry attempts and an incremental time interval between retries.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified retry settings.

The number of retry attempts. The initial interval that will apply for the first retry. The incremental time value that will be used to calculate the progressive delay between retries.

Initializes a new instance of the class with the specified name and retry settings.

Initializes a new instance of the class with the specified number of retry attempts, time interval, retry strategy, and fast start option.

The retry strategy name. The number of retry attempts. The initial interval that will apply for the first retry. The incremental time value that will be used to calculate the progressive delay between retries. true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval.

Returns the corresponding ShouldRetry delegate.

The ShouldRetry delegate.

Contains information that is required for the event.

Initializes a new instance of the class.

The current retry attempt count. The delay that indicates how long the current thread will be suspended before the next iteration is invoked. The exception that caused the retry conditions to occur.

Gets the current retry count.

Gets the delay that indicates how long the current thread will be suspended before the next iteration is invoked.

Gets the exception that caused the retry conditions to occur.

The special type of exception that provides managed exit from a retry loop. The user code can use this exception to notify the retry policy that no further retry attempts are required.

Initializes a new instance of the class with a default error message.

Initializes a new instance of the class with a specified error message.

The message that describes the error.

Initializes a new instance of the class with a reference to the inner exception that is the cause of this exception.

The exception that is the cause of the current exception.

Initializes a new instance of the class with a specified error message and inner exception.

The message that describes the error. The exception that is the cause of the current exception.

Provides the entry point to the retry functionality.

Sets the specified retry manager as the default retry manager.

The retry manager. true to throw an exception if the manager is already set; otherwise, false. Defaults to . The singleton is already set and is true.

Initializes a new instance of the class.

The complete set of retry strategies.

Initializes a new instance of the class with the specified retry strategies and default retry strategy name.

The complete set of retry strategies. The default retry strategy.

Initializes a new instance of the class with the specified retry strategies and defaults.

The complete set of retry strategies. The default retry strategy. The names of the default strategies for different technologies.

Returns a retry policy with the specified error detection strategy and the default retry strategy defined in the configuration.

The type that implements the interface that is responsible for detecting transient conditions. A new retry policy with the specified error detection strategy and the default retry strategy defined in the configuration.

Returns a retry policy with the specified error detection strategy and retry strategy.

The type that implements the interface that is responsible for detecting transient conditions. The retry strategy name, as defined in the configuration. A new retry policy with the specified error detection strategy and the default retry strategy defined in the configuration.

Returns the default retry strategy defined in the configuration.

The retry strategy that matches the default strategy.

Returns the retry strategy that matches the specified name.

The retry strategy name. The retry strategy that matches the specified name.

Returns the retry strategy for the specified technology.

The technology to get the default retry strategy for. The retry strategy for the specified technology.

Gets the default for the application.

You can update the default retry manager by calling the method.

Gets or sets the default retry strategy name.

Provides the base implementation of the retry mechanism for unreliable actions and transient conditions.

Initializes a new instance of the class with the specified number of retry attempts and parameters defining the progressive delay between retries.

The that is responsible for detecting transient conditions. The strategy to use for this retry policy.

Initializes a new instance of the class with the specified number of retry attempts and default fixed time interval between retries.

The that is responsible for detecting transient conditions. The number of retry attempts.

Initializes a new instance of the class with the specified number of retry attempts and fixed time interval between retries.

The that is responsible for detecting transient conditions. The number of retry attempts. The interval between retries.

Initializes a new instance of the class with the specified number of retry attempts and backoff parameters for calculating the exponential delay between retries.

The that is responsible for detecting transient conditions. The number of retry attempts. The minimum backoff time. The maximum backoff time. The time value that will be used to calculate a random delta in the exponential delay between retries.

Initializes a new instance of the class with the specified number of retry attempts and parameters defining the progressive delay between retries.

The that is responsible for detecting transient conditions. The number of retry attempts. The initial interval that will apply for the first retry. The incremental time value that will be used to calculate the progressive delay between retries.

Repetitively executes the specified action while it satisfies the current retry policy.

A delegate that represents the executable action that doesn't return any results.

Repetitively executes the specified action while it satisfies the current retry policy.

The type of result expected from the executable action. A delegate that represents the executable action that returns the result of type . The result from the action.

Repetitively executes the specified asynchronous task while it satisfies the current retry policy.

A function that returns a started task (also known as "hot" task). A task that will run to completion if the original task completes successfully (either the first time or after retrying transient failures). If the task fails with a non-transient error or the retry limit is reached, the returned task will transition to a faulted state and the exception must be observed.

Repetitively executes the specified asynchronous task while it satisfies the current retry policy.

A function that returns a started task (also known as "hot" task). The token used to cancel the retry operation. This token does not cancel the execution of the asynchronous task. Returns a task that will run to completion if the original task completes successfully (either the first time or after retrying transient failures). If the task fails with a non-transient error or the retry limit is reached, the returned task will transition to a faulted state and the exception must be observed.

Repeatedly executes the specified asynchronous task while it satisfies the current retry policy.

A function that returns a started task (also known as "hot" task). Returns a task that will run to completion if the original task completes successfully (either the first time or after retrying transient failures). If the task fails with a non-transient error or the retry limit is reached, the returned task will transition to a faulted state and the exception must be observed.

Repeatedly executes the specified asynchronous task while it satisfies the current retry policy.

Notifies the subscribers whenever a retry condition is encountered.

The current retry attempt count. The exception that caused the retry conditions to occur. The delay that indicates how long the current thread will be suspended before the next iteration is invoked.

Returns a default policy that performs no retries, but invokes the action only once.

Returns a default policy that implements a fixed retry interval configured with the default retry strategy. The default retry policy treats all caught exceptions as transient errors.

Returns a default policy that implements a progressive retry interval configured with the default retry strategy. The default retry policy treats all caught exceptions as transient errors.

Returns a default policy that implements a random exponential retry interval configured with the default retry strategy. The default retry policy treats all caught exceptions as transient errors.

An instance of a callback delegate that will be invoked whenever a retry condition is encountered.

Gets the retry strategy.

Gets the instance of the error detection strategy.

Implements a strategy that ignores any transient errors.

Always returns false.

The exception. Always false.

Implements a strategy that treats all exceptions as transient errors.

Always returns true.

The exception. Always true.

Provides a generic version of the class.

The type that implements the interface that is responsible for detecting transient conditions.

Initializes a new instance of the class with the specified number of retry attempts and parameters defining the progressive delay between retries.

The strategy to use for this retry policy.

Initializes a new instance of the class with the specified number of retry attempts and the default fixed time interval between retries.

The number of retry attempts.

Initializes a new instance of the class with the specified number of retry attempts and a fixed time interval between retries.

The number of retry attempts. The interval between retries.

Initializes a new instance of the class with the specified number of retry attempts and backoff parameters for calculating the exponential delay between retries.

The number of retry attempts. The minimum backoff time. The maximum backoff time. The time value that will be used to calculate a random delta in the exponential delay between retries.

Initializes a new instance of the class with the specified number of retry attempts and parameters defining the progressive delay between retries.

The number of retry attempts. The initial interval that will apply for the first retry. The incremental time value that will be used to calculate the progressive delay between retries.

Defines a callback delegate that will be invoked whenever a retry condition is encountered.

The current retry attempt count. The exception that caused the retry conditions to occur. The delay that indicates how long the current thread will be suspended before the next iteration is invoked. if a retry is allowed; otherwise, .