diff --git a/app_data/jobs/triggered/utility/Azure.Core.dll b/app_data/jobs/triggered/utility/Azure.Core.dll new file mode 100644 index 000000000..9d9912591 Binary files /dev/null and b/app_data/jobs/triggered/utility/Azure.Core.dll differ diff --git a/app_data/jobs/triggered/utility/Azure.Core.xml b/app_data/jobs/triggered/utility/Azure.Core.xml new file mode 100644 index 000000000..103af98e9 --- /dev/null +++ b/app_data/jobs/triggered/utility/Azure.Core.xml @@ -0,0 +1,3395 @@ + + + + Azure.Core + + + + + Represents an Azure service bearer access token with expiry information. + + + + + Creates a new instance of using the provided and . + + The bearer access token value. + The bearer access token expiry date. + + + + Get the access token value. + + + + + Gets the time when the provided token expires. + + + + Indicates whether this instance and a specified object are equal.The object to compare with the current instance. if and this instance are the same type and represent the same value; otherwise, . + + + Returns the hash code for this instance.A 32-bit signed integer that is the hash code for this instance. + + + + Base type for all client option types, exposes various common client options like , , . + + + + + Creates a new instance of . + + + + + The to be used for this client. Defaults to an instance of . + + + + + Gets the client diagnostic options. + + + + + Gets the client retry options. + + + + + Adds an policy into the client pipeline. The position of policy in the pipeline is controlled by parameter. + If you want the policy to execute once per client request use otherwise use + to run the policy for every retry. Note that the same instance of would be added to all pipelines of client constructed using this object. + + The instance to be added to the pipeline. + The position of policy in the pipeline. + + + Determines whether the specified object is equal to the current object.The object to compare with the current object. if the specified object is equal to the current object; otherwise, . + + + Serves as the default hash function.A hash code for the current object. + + + Returns a string that represents the current object.A string that represents the current object. + + + + A key which is used to encrypt, or wrap, another key. + + + + + The Id of the key used to perform cryptographic operations for the client. + + + + + Encrypts the specified key using the specified algorithm. + + The key wrap algorithm used to encrypt the specified key. + The key to be encrypted. + A controlling the request lifetime. + The encrypted key bytes. + + + + Encrypts the specified key using the specified algorithm. + + The key wrap algorithm used to encrypt the specified key. + The key to be encrypted. + A controlling the request lifetime. + The encrypted key bytes. + + + + Decrypts the specified encrypted key using the specified algorithm. + + The key wrap algorithm which was used to encrypt the specified encrypted key. + The encrypted key to be decrypted. + A controlling the request lifetime. + The decrypted key bytes. + + + + Decrypts the specified encrypted key using the specified algorithm. + + The key wrap algorithm which was used to encrypt the specified encrypted key. + The encrypted key to be decrypted. + A controlling the request lifetime. + The decrypted key bytes. + + + + An object capable of retrieving key encryption keys from a provided key identifier. + + + + + Retrieves the key encryption key corresponding to the specified keyId. + + The key identifier of the key encryption key to retrieve. + A controlling the request lifetime. + The key encryption key corresponding to the specified keyId. + + + + Retrieves the key encryption key corresponding to the specified keyId. + + The key identifier of the key encryption key to retrieve. + A controlling the request lifetime. + The key encryption key corresponding to the specified keyId. + + + + Exposes client options related to logging, telemetry and distributed tracing. + + + + + Get or sets value indicating whether HTTP pipeline logging is enabled. + + + + + Gets or sets value indicating whether distributed tracing spans are going to be created for this clients methods calls and HTTP calls. + + + + + Gets or sets value indicating whether the "User-Agent" header containing , client library package name and version, + and should be sent. + The default value can be controlled process wide by setting AZURE_TELEMETRY_DISABLED to true, false, 1 or 0. + + + + + Gets or sets value indicating if request or response content should be logged. + + + + + Gets or sets value indicating maximum size of content to log in bytes. Defaults to 4096. + + + + + Gets a list of headers names that are not redacted during logging. + + + + + Gets a list of query parameter names that are not redacted during logging. + + + + + Gets or sets the value sent a the first part of "User-Agent" headers for all requests issues by this client. Defaults to . + + + + + Gets or sets the default application id. Default application id would be set on all instances. + + + + + Implementation of that listens to events produces by Azure SDK Client libraries. + + + + + The trait name that has to be present on all event sources collected by this listener. + + + + + The trait value that has to be present on all event sources collected by this listener. + + + + + Creates an instance of that executes a callback every time event is written. + + The to call when event is written. The second parameter is formatted message. + The level of events to enable. + + + Called for all existing event sources when the event listener is created and when a new event source is attached to the listener.The event source. + + + Called whenever an event has been written by an event source for which the event listener has enabled events.The event arguments that describe the event. + + + + Creates a new instance of that forwards events to . + + The level of events to enable. + + + + Creates a new instance of that forwards events to . + + The level of events to enable. + + + + Marks the type exposing client registration options for clients registered with . + + The type of the client. + The options type used by the client. + + + + Abstraction for registering Azure clients in dependency injection containers. + + + + + Registers a client in the dependency injection container using the factory to create a client instance. + + The type of the client. + The client options type used the client. + The factory, that given the instance of options, returns a client instance. + that allows customizing the client registration. + + + + Abstraction for registering Azure clients in dependency injection containers and initializing them using IConfiguration objects. + + + + + Registers a client in the dependency injection container using the configuration to create a client instance. + + The type of the client. + The client options type used the client. + Instance of to use. + that allows customizing the client registration. + + + + Abstraction for registering Azure clients that require in dependency injection containers. + + + + + Registers a client in dependency injection container the using the factory to create a client instance. + + The type of the client. + The client options type used the client. + The factory, that given the instance of options and credential, returns a client instance. + Specifies whether the credential is optional (client supports anonymous authentication). + that allows customizing the client registration. + + + + Represents an HTTP header. + + + + + Creates a new instance of with provided name and value. + + The header name. + The header value. + + + + Gets header name. + + + + + Gets header value. If the header has multiple values they would be joined with a comma. To get separate values use or . + + + + Returns the hash code for this instance.A 32-bit signed integer that is the hash code for this instance. + + + Indicates whether this instance and a specified object are equal.The object to compare with the current instance. if and this instance are the same type and represent the same value; otherwise, . + + + Returns the fully qualified type name of this instance.The fully qualified type name. + + + Indicates whether the current object is equal to another object of the same type.An object to compare with this object. if the current object is equal to the parameter; otherwise, . + + + + Contains names of commonly used headers. + + + + + Returns. "Date" + + + + + Returns. "x-ms-date" + + + + + Returns. "Content-Type" + + + + + Returns. "Content-Length" + + + + + Returns. "ETag" + + + + + Returns. "x-ms-request-id" + + + + + Returns. "User-Agent" + + + + + Returns. "Accept" + + + + + Returns. "Authorization" + + + + + Returns. "Range" + + + + + Returns. "x-ms-range" + + + + + Returns. "If-Match" + + + + + Returns. "If-None-Match" + + + + + Returns. "If-Modified-Since" + + + + + Returns. "If-Unmodified-Since" + + + + + Returns. "Referer" + + + + + Returns. "Host" + + + + + Returns "Content-Disposition". + + + + + Returns "WWW-Authenticate". + + + + + Commonly defined header values. + + + + + Returns header with name "ContentType" and value "application/json". + + + + + Returns header with name "Accept" and value "application/json". + + + + + Returns header with name "ContentType" and value "application/octet-stream". + + + + + Returns header with name "ContentType" and value "application/x-www-form-urlencoded". + + + + + Represents a context flowing through the . + + + + + Creates a new instance of . + + The request. + The response classifier. + + + + Gets the associated with this message. + + + + + Gets the associated with this message. Throws an exception if it wasn't set yet. + To avoid the exception use property to check. + + + + + Gets the value indicating if the response is set on this message. + + + + + The to be used during the processing. + + + + + The instance to use for response classification during pipeline invocation. + + + + + Gets or sets the value indicating if response would be buffered as part of the pipeline. Defaults to true. + + + + + Gets a property that modifies the pipeline behavior. Please refer to individual policies documentation on what properties it supports. + + The property name. + The property value. + true if property exists, otherwise. false. + + + + Sets a property that modifies the pipeline behavior. Please refer to individual policies documentation on what properties it supports. + + The property name. + The property value. + + + + Returns the response content stream and releases it ownership to the caller. After calling this methods using or would result in exception. + + The content stream or null if response didn't have any. + + + + Disposes the request and response. + + + + + Represents a position of the policy in the pipeline. + + + + + The policy would be invoked once per pipeline invocation (service call). + + + + + The policy would be invoked every time request is retried. + + + + + A policy that sends an provided by a as an Authentication header. + + + + + Creates a new instance of using provided token credential and scope to authenticate for. + + The token credential to use for authentication. + The scope to authenticate for. + + + + Creates a new instance of using provided token credential and scopes to authenticate for. + + The token credential to use for authentication. + Scopes to authenticate for. + + + + Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after. + + The this policy would be applied to. + The set of to execute after current one. + The representing the asynchronous operation. + + + + Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after. + + The this policy would be applied to. + The set of to execute after current one. + + + + An implementation that uses as the transport. + + + + + Creates a new instance using default configuration. + + + + + Creates a new instance of using the provided client instance. + + The instance of to use. + + + + Creates a new instance of using the provided client instance. + + The instance of to use. + + + + A shared instance of with default parameters. + + + + + Creates a new transport specific instance of . This should not be called directly, or + should be used instead. + + + + + + Sends the request contained by the and sets the property to received response synchronously. + + The containing request and response. + + + + Sends the request contained by the and sets the property to received response asynchronously. + + The containing request and response. + + + + Represents a primitive for sending HTTP requests and receiving responses extensible by adding processing steps. + + + + + Creates a new instance of with the provided transport, policies and response classifier. + + The to use for sending the requests. + Policies to be invoked as part of the pipeline in order. + The response classifier to be used in invocations. + + + + Creates a new instance. + + The request. + + + + Creates a new instance. + + The message. + + + + The instance used in this pipeline invocations. + + + + + Invokes the pipeline asynchronously. After the task completes response would be set to the property. + + The to send. + The to use. + The representing the asynchronous operation. + + + + Invokes the pipeline synchronously. After the task completes response would be set to the property. + + The to send. + The to use. + + + + Invokes the pipeline asynchronously with the provided request. + + The to send. + The to use. + The representing the asynchronous operation. + + + + Invokes the pipeline synchronously with the provided request. + + The to send. + The to use. + The from the server. + + + + Creates a scope in which all outgoing requests would use the provided + + The client request id value to be sent with request. + The instance that needs to be disposed when client request id shouldn't be sent anymore. + + Sample usage: + + var secretClient = new SecretClient(new Uri("http://example.com"), new DefaultAzureCredential()); + + using (HttpPipeline.CreateClientRequestIdScope("<custom-client-request-id>")) + { + // The HTTP request resulting from the client call would have x-ms-client-request-id value set to <custom-client-request-id> + secretClient.GetSecret("<secret-name>"); + } + + + + + + Creates a scope in which all s would have provided properties. + + Properties to be added to s + The instance that needs to be disposed when properties shouldn't be used anymore. + + + + Factory for creating instances of populated with default policies. + + + + + Creates an instance of populated with default policies, customer provided policies from and client provided per call policies. + + The customer provided client options object. + Client provided per-retry policies. + A new instance of + + + + Creates an instance of populated with default policies, customer provided policies from and client provided per call policies. + + The customer provided client options object. + Client provided per-call policies. + Client provided per-retry policies. + The client provided response classifier. + A new instance of + + + + Represent an extension point for the that can mutate the and react to received . + + + + + Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after. + + The this policy would be applied to. + The set of to execute after current one. + The representing the asynchronous operation. + + + + Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after. + + The this policy would be applied to. + The set of to execute after current one. + + + + Invokes the next in the . + + The next policy would be applied to. + The set of to execute after next one. + The representing the asynchronous operation. + + + + Invokes the next in the . + + The next policy would be applied to. + The set of to execute after next one. + + + + Represents a that doesn't do any asynchronous or synchronously blocking operations. + + + + + Initializes a new instance of + + + + + Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after. + + The this policy would be applied to. + The set of to execute after current one. + + + + Applies the policy to the . Implementers are expected to mutate before calling and observe the changes after. + + The this policy would be applied to. + The set of to execute after current one. + The representing the asynchronous operation. + + + + Method is invoked before the request is sent. + + The containing the request. + + + + Method is invoked after the response is received. + + The containing the response. + + + + Represents an HTTP pipeline transport used to send HTTP requests and receive responses. + + + + + Sends the request contained by the and sets the property to received response synchronously. + + The containing request and response. + + + + Sends the request contained by the and sets the property to received response asynchronously. + + The containing request and response. + + + + Creates a new transport specific instance of . This should not be called directly, or + should be used instead. + + + + + + The based implementation. + + + + + Creates a new instance of + + + + + Sends the request contained by the and sets the property to received response synchronously. + + The containing request and response. + + + + Sends the request contained by the and sets the property to received response asynchronously. + + The containing request and response. + + + + Creates a new transport specific instance of . This should not be called directly, or + should be used instead. + + + + + + Gets the proxy URI. (iWebProxy interface). + + + + + Checks if URI is subject to proxy or not. + + + + + Read-only Stream that will throw a if it has to wait longer than a configurable timeout to read more data + + + + + Pipeline policy to buffer response content or add a timeout to response content managed by the client + + + + + HACK HACK HACK. Some runtime environments like Azure.Functions downgrade System.Diagnostic.DiagnosticSource package version causing method not found exceptions in customer apps + This type is a temporary workaround to avoid the issue. + + + + + Both and are defined as public structs so that foreach can use duck typing + to call and avoid heap memory allocation. + Please don't delete this method and don't make these types private. + + + + + + Represents an HTTP request. Use or to create an instance. + + + + + Gets or sets and instance of used to create the Uri. + + + + + Gets or sets the request HTTP method. + + + + + Gets or sets the request content. + + + + + Adds a header value to the header collection. + + The header name. + The header value. + + + + Returns header value if the header is stored in the collection. If the header has multiple values they are going to be joined with a comma. + + The header name. + The reference to populate with value. + true if the specified header is stored in the collection, otherwise false. + + + + Returns header values if the header is stored in the collection. + + The header name. + The reference to populate with values. + true if the specified header is stored in the collection, otherwise false. + + + + Returns true if the header is stored in the collection. + + The header name. + true if the specified header is stored in the collection, otherwise false. + + + + Sets a header value the header collection. + + The header name. + The header value. + + + + Removes the header from the collection. + + The header name. + + + + Returns an iterator enumerating in the request. + + The enumerating in the response. + + + + Gets or sets the client request id that was sent to the server as x-ms-client-request-id headers. + + + + + Gets the response HTTP headers. + + + + + Frees resources held by this instance. + + + + + Represents the content sent as part of the . + + + + + Creates an instance of that wraps a . + + The to use. + An instance of that wraps a . + + + + Creates an instance of that wraps an of . + + The of to use. + An instance of that wraps provided of . + + + + Creates an instance of that wraps an of . + + The of to use. + The offset in to start from. + The length of the segment to use. + An instance of that wraps provided of . + + + + Creates an instance of that wraps a . + + The to use. + An instance of that wraps a . + + + + Creates an instance of that wraps a . + + The to use. + An instance of that wraps a . + + + + Creates a RequestContent representing the UTF-8 Encoding of the given / + + The to use. + An instance of that wraps a . + The returned content represents the UTF-8 Encoding of the given string. + + + + Creates an instance of that wraps a . + + The to use. + An instance of that wraps a . + + + + Creates an instance of that wraps a serialized version of an object. + + The to serialize. + The to use to convert the object to bytes. If not provided, is used. + An instance of that wraps a serialized version of the object. + + + + Creates a RequestContent representing the UTF-8 Encoding of the given . + + The to use. + + + + Creates a RequestContent that wraps a . + + The to use. + + + + Writes contents of this object to an instance of . + + The stream to write to. + To cancellation token to use. + + + + Writes contents of this object to an instance of . + + The stream to write to. + To cancellation token to use. + + + + Attempts to compute the length of the underlying content, if available. + + The length of the underlying data. + + + + Frees resources held by the object. + + + + + Headers to be sent as part of the . + + + + + Returns an enumerator that iterates through the . + + A for the . + + + + Returns an enumerator that iterates through the . + + A for the . + + + + Adds the instance to the collection. + + The header to add. + + + + Adds the header to the collection. If a header with this name already exist adds an additional value to the header values. + + The header name. + The header value. + + + + Returns header value if the headers is stored in the collection. If the header has multiple values they are going to be joined with a comma. + + The header name. + The reference to populate with value. + true if the specified header is stored in the collection, otherwise false. + + + + Returns header values if the header is stored in the collection. + + The header name. + The reference to populate with values. + true if the specified header is stored in the collection, otherwise false. + + + + Returns true if the headers is stored in the collection. + + The header name. + true if the specified header is stored in the collection, otherwise false. + + + + Sets the header value name. If a header with this name already exist replaces it's value. + + The header name. + The header value. + + + + Removes the header from the collection. + + The header name. + true if the header existed, otherwise false. + + + + Represents HTTP methods sent as part of a . + + + + + Gets the HTTP method. + + + + + Gets instance for GET method. + + + + + Gets instance for POST method. + + + + + Gets instance for PUT method. + + + + + Gets instance for PATCH method. + + + + + Gets instance for DELETE method. + + + + + Gets instance for HEAD method. + + + + + Gets instance for OPTIONS method. + + + + + Gets instance for TRACE method. + + + + + Creates an instance of with provided method. Method must be all uppercase. + Prefer if can be one of predefined method names. + + The method to use. + + + + Parses string to it's representation. + + The method string to parse. + + + Indicates whether the current object is equal to another object of the same type.An object to compare with this object. if the current object is equal to the parameter; otherwise, . + + + Indicates whether this instance and a specified object are equal.The object to compare with the current instance. if and this instance are the same type and represent the same value; otherwise, . + + + Returns the hash code for this instance.A 32-bit signed integer that is the hash code for this instance. + + + + Compares equality of two instances. + + The method to compare. + The method to compare against. + true if values are equal for and , otherwise false. + + + + Compares inequality of two instances. + + The method to compare. + The method to compare against. + true if values are equal for and , otherwise false. + + + Returns the fully qualified type name of this instance.The fully qualified type name. + + + + Provides a custom builder for Uniform Resource Identifiers (URIs) and modifies URIs for the class. + + + + + Gets or sets the scheme name of the URI. + + + + + Gets or sets the Domain Name System (DNS) host name or IP address of a server. + + + + + Gets or sets the port number of the URI. + + + + + Gets or sets any query information included in the URI. + + + + + Gets or sets the path to the resource referenced by the URI. + + + + + Gets the path and query string to the resource referenced by the URI. + + + + + Replaces values inside this instance with values provided in the parameter. + + The instance to get values from. + + + + Gets the instance constructed by the specified instance. + + + A that contains the URI constructed by the . + + + + + Appends a query parameter adding separator if required. Escapes the value. + + The name of parameter. + The value of parameter. + + + + Appends a query parameter adding separator if required. + + The name of parameter. + The value of parameter. + Whether value should be escaped. + + + + Escapes and appends the to without adding path separator. + Path segments and any other characters will be escaped, e.g. "/" will be escaped as "%3a". + + The value to escape and append. + + + + Optionally escapes and appends the to without adding path separator. + If is true, path segments and any other characters will be escaped, e.g. "/" will be escaped as "%3a". + + The value to optionally escape and append. + Whether value should be escaped. + + + + Returns a string representation of this . + + A string representation of this . + + + + A type that analyzes HTTP responses and exceptions and determines if they should be retried. + + + + + Specifies if the request contained in the should be retried. + + + + + Specifies if the operation that caused the exception should be retried. + + + + + Specifies if the operation that caused the exception should be retried taking the into consideration. + + + + + Specifies if the response contained in the is not successful. + + + + + Headers received as part of the . + + + + + Gets the parsed value of "Date" or "x-ms-date" header. + + + + + Gets the value of "Content-Type" header. + + + + + Gets the parsed value of "Content-Length" header. + + + + + Gets the parsed value of "ETag" header. + + + + + Gets the value of "x-ms-request-id" header. + + + + + Returns an enumerator that iterates through the . + + A for the . + + + + Returns an enumerator that iterates through the . + + A for the . + + + + Returns header value if the header is stored in the collection. If header has multiple values they are going to be joined with a comma. + + The header name. + The reference to populate with value. + true if the specified header is stored in the collection, otherwise false. + + + + Returns header values if the header is stored in the collection. + + The header name. + The reference to populate with values. + true if the specified header is stored in the collection, otherwise false. + + + + Returns true if the header is stored in the collection. + + The header name. + true if the specified header is stored in the collection, otherwise false. + + + + The type of approach to apply when calculating the delay + between retry attempts. + + + + + Retry attempts happen at fixed intervals; each delay is a consistent duration. + + + + + Retry attempts will delay based on a backoff strategy, where each attempt will increase + the duration that it waits before retrying. + + + + + The set of options that can be specified to influence how + retry attempts are made, and a failure is eligible to be retried. + + + + + The maximum number of retry attempts before giving up. + + + + + The delay between retry attempts for a fixed approach or the delay + on which to base calculations for a backoff-based approach. + + + + + The maximum permissible delay between retry attempts. + + + + + The approach to use for calculating retry delays. + + + + + The timeout applied to an individual network operations. + + + + + Converts type member names to serializable member names. + + + + + Converts a to a serializable member name. + + The to convert to a serializable member name. + The serializable member name, or null if the member is not defined or ignored by the serializer. + is null. + + + + A implementation that uses to for serialization/deserialization. + + + + + A shared instance of , initialized with the default options. + + + + + Initializes new instance of . + + + + + Initializes new instance of . + + The instance to use when serializing/deserializing. + is null. + + + + Convert the provided value to it's binary representation and write it to . + + The to write to. + The value to convert. + The type of the to convert. + The to use during serialization. + + + + Convert the provided value to it's binary representation and write it to . + + The to write to. + The value to convert. + The type of the to convert. + The to use during serialization. + + + + Read the binary representation into a . + The Stream will be read to completion. + + The to read from. + The type of the object to convert to and return. + The to use during deserialization. + + + + Read the binary representation into a . + The Stream will be read to completion. + + The to read from. + The type of the object to convert to and return. + The to use during deserialization. + + + + Convert the provided value to it's binary representation and return it as a instance. + + The value to convert. + The type to use when serializing . If omitted, the type will be determined using (). + The to use during serialization. + The object's binary representation as . + + + + Convert the provided value to it's binary representation and return it as a instance. + + The value to convert. + The type to use when serializing . If omitted, the type will be determined using (). + The to use during serialization. + The object's binary representation as . + + + + Converts a to a serializable member name. + + The to convert to a serializable member name. + The serializable member name, or null if the member is not defined or ignored by the serializer. + is null. + + + + An abstraction for reading typed objects. + + + + + Convert the provided value to it's binary representation and write it to . + + The to write to. + The value to convert. + The type of the to convert. + The to use during serialization. + + + + Convert the provided value to it's binary representation and write it to . + + The to write to. + The value to convert. + The type of the to convert. + The to use during serialization. + + + + Read the binary representation into a . + The Stream will be read to completion. + + The to read from. + The type of the object to convert to and return. + The to use during deserialization. + + + + Read the binary representation into a . + The Stream will be read to completion. + + The to read from. + The type of the object to convert to and return. + The to use during deserialization. + + + + Convert the provided value to it's binary representation and return it as a instance. + + The value to convert. + The type to use when serializing . If omitted, the type will be determined using (). + The to use during serialization. + The object's binary representation as . + + + + Convert the provided value to it's binary representation and return it as a instance. + + The value to convert. + The type to use when serializing . If omitted, the type will be determined using (). + The to use during serialization. + The object's binary representation as . + + + + Represents a method that can handle an event and execute either + synchronously or asynchronously. + + + Type of the event arguments deriving or equal to + . + + + An instance that contains the event + data. + + + A task that represents the handler. You can return + if implementing a sync handler. + Please see the Remarks section for more details. + + + + If you're using the synchronous, blocking methods of a client (i.e., + methods without an Async suffix), they will raise events that require + handlers to execute synchronously as well. Even though the signature + of your handler returns a , you should write regular + sync code that blocks and return when + finished. + + var client = new AlarmClient(); + client.Ring += (SyncAsyncEventArgs e) => + { + Console.WriteLine("Wake up!"); + return Task.CompletedTask; + }; + + client.Snooze(); + + If you need to call an async method from a synchronous event handler, + you have two options. You can use to + queue a task for execution on the ThreadPool without waiting on it to + complete. This "fire and forget" approach may not run before your + handler finishes executing. Be sure to understand + + exception handling in the Task Parallel Library to avoid + unhandled exceptions tearing down your process. If you absolutely need + the async method to execute before returning from your handler, you can + call myAsyncTask.GetAwaiter().GetResult(). Please be aware + this may cause ThreadPool starvation. See the sync-over-async note in + Remarks for more details. + + + If you're using the asynchronous, non-blocking methods of a client + (i.e., methods with an Async suffix), they will raise events that + expect handlers to execute asynchronously. + + var client = new AlarmClient(); + client.Ring += async (SyncAsyncEventArgs e) => + { + await Console.Out.WriteLineAsync("Wake up!"); + }; + + await client.SnoozeAsync(); + + + + The same event can be raised from both synchronous and asynchronous + code paths depending on whether you're calling sync or async methods + on a client. If you write an async handler but raise it from a sync + method, the handler will be doing sync-over-async and may cause + ThreadPool starvation. See the note in Remarks for more details. You + should use the + property to check how the event is being raised and implement your + handler accordingly. Here's an example handler that's safe to invoke + from both sync and async code paths. + + var client = new AlarmClient(); + client.Ring += async (SyncAsyncEventArgs e) => + { + if (e.IsRunningSynchronously) + { + Console.WriteLine("Wake up!"); + } + else + { + await Console.Out.WriteLineAsync("Wake up!"); + } + }; + + client.Snooze(); // sync call that blocks + await client.SnoozeAsync(); // async call that doesn't block + + + + + + + Any exceptions thrown by an event handler will be wrapped in a single + AggregateException and thrown from the code that raised the event. You + can check the property + to see the original exceptions thrown by your event handlers. + AggregateException also provides + + a number of helpful methods like + and + to make + complex failures easier to work with. + + var client = new AlarmClient(); + client.Ring += (SyncAsyncEventArgs e) => + throw new InvalidOperationException("Alarm unplugged."); + + try + { + client.Snooze(); + } + catch (AggregateException ex) + { + ex.Handle(e => e is InvalidOperationException); + Console.WriteLine("Please switch to your backup alarm."); + } + + + + + Most Azure client libraries for .NET offer both synchronous and + asynchronous methods for calling Azure services. You can distinguish + the asynchronous methods by their Async suffix. For example, + BlobClient.Download and BlobClient.DownloadAsync make the same + underlying REST call and only differ in whether they block. We + recommend using our async methods for new applications, but there are + perfectly valid cases for using sync methods as well. These dual + method invocation semantics allow for flexibility, but require a little + extra care when writing event handlers. + + + The SyncAsyncEventHandler is a delegate used by events in Azure client + libraries to represent an event handler that can be invoked from either + sync or async code paths. It takes event arguments deriving from + that contain important information for + writing your event handler: + + + + is a cancellation + token related to the original operation that raised the event. It's + important for your handler to pass this token along to any asynchronous + or long-running synchronous operations that take a token so cancellation + (via something like + new CancellationTokenSource(TimeSpan.FromSeconds(10)).Token, + for example) will correctly propagate. + + + + + is a flag indicating + whether your handler was invoked synchronously or asynchronously. If + you're calling sync methods on your client, you should use sync methods + to implement your event handler (you can return + ). If you're calling async methods on + your client, you should use async methods where possible to implement + your event handler. If you're not in control of how the client will be + used or want to write safer code, you should check the + property and call + either sync or async methods as directed. + + + + + Most events will customize the event data by deriving from + and including details about what + triggered the event or providing options to react. Many times this + will include a reference to the client that raised the event in case + you need it for additional processing. + + + + + + When an event using SyncAsyncEventHandler is raised, the handlers will + be executed sequentially to avoid introducing any unintended + parallelism. The event handlers will finish before returning control + to the code path raising the event. This means blocking for events + raised synchronously and waiting for the returned to + complete for events raised asynchronously. + + + Any exceptions thrown from a handler will be wrapped in a single + . If one handler throws an exception, + it will not prevent other handlers from running. This is also relevant + for cancellation because all handlers are still raised if cancellation + occurs. You should both pass + to asynchronous or long-running synchronous operations and consider + calling + in compute heavy handlers. + + + A + distributed tracing span is wrapped around your handlers using + the event name so you can see how long your handlers took to run, + whether they made other calls to Azure services, and details about any + exceptions that were thrown. + + + Executing asynchronous code from a sync code path is commonly referred + to as sync-over-async because you're getting sync behavior but still + invoking all the async machinery. See + + Diagnosing.NET Core ThreadPool Starvation with PerfView + for a detailed explanation of how that can cause serious performance + problems. We recommend you use the + flag to avoid + ThreadPool starvation. + + + + + + Represents a credential capable of providing an OAuth token. + + + + + Gets an for the specified set of scopes. + + The with authentication information. + The to use. + A valid . + + + + Gets an for the specified set of scopes. + + The with authentication information. + The to use. + A valid . + + + + Contains the details of an authentication token request. + + + + + Creates a new TokenRequest with the specified scopes. + + The scopes required for the token. + The of the request requiring a token for authentication, if applicable. + + + + Creates a new TokenRequest with the specified scopes. + + The scopes required for the token. + The of the request requiring a token for authentication, if applicable. + Additional claims to be included in the token. + + + + The scopes required for the token. + + + + + The of the request requiring a token for authentication, if applicable. + + + + + Additional claims to be included in the token. See https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter for more information on format and content. + + + + + Argument validation. + + + This class should be shared via source using Azure.Core.props and contain only common argument validation. + It is declared partial so that you can use the same familiar class name but extend it with project-specific validation. + To extend the functionality of this class, just declare your own partial class with project-specific methods. + + + Be sure to document exceptions thrown by these methods on your public methods. + + + + + + Throws if is null. + + The value to validate. + The name of the parameter. + is null. + + + + Throws if has not been initialized. + + The value to validate. + The name of the parameter. + has not been initialized. + + + + Throws if is null or an empty collection. + + The value to validate. + The name of the parameter. + is an empty collection. + is null. + + + + Throws if is null or an empty string. + + The value to validate. + The name of the parameter. + is an empty string. + is null. + + + + Throws if is null, an empty string, or consists only of white-space characters. + + The value to validate. + The name of the parameter. + is an empty string or consists only of white-space characters. + is null. + + + + Throws if is the default value for type . + + The type of structure to validate which implements . + The value to validate. + The name of the parameter. + is the default value for type . + + + + Throws if is less than the or greater than the . + + The type of to validate which implements . + The value to validate. + The minimum value to compare. + The maximum value to compare. + The name of the parameter. + + + + A helper class for parsing Authorization challenge headers. + + + + + Parses the specified parameter from a challenge hearder found in the specified . + + The to parse. + The challenge scheme containing the . For example: "Bearer" + The parameter key name containing the value to return. + The value of the parameter name specified in if it is found in the specified . + + + + Iterates through the challenge schemes present in a challenge header. + + + The header value which will be sliced to remove the first parsed . + + The parsed challenge scheme. + + true if a challenge scheme was successfully parsed. + The value of should be passed to to parse the challenge parameters if true. + + + + + Iterates through a challenge header value after being parsed by . + + The header value after being parsed by . + The parsed challenge parameter key. + The parsed challenge parameter value. + The challenge parameter key / value pair separator. The default is '='. + + true if the next available challenge parameter was successfully parsed. + false if there are no more parameters for the current challenge scheme or an additional challenge scheme was encountered in the . + The value of should be passed again to to attempt to parse any additional challenge schemes if false. + + + + + Initializes a new instance of the class. + + The used to authenticate requests. + The name of the key header used for the credential. + + + + Method is invoked before the request is sent. + + The containing the request. + + + + Initializes a new instance of the class. + + The used to authenticate requests. + + + + Method is invoked before the request is sent. + + The containing the request. + + + Converts a Base64URL encoded string to a string. + The Base64Url encoded string containing UTF8 bytes for a string. + The string represented by the Base64URL encoded string. + + + Encode a byte array as a Base64URL encoded string. + Raw byte input buffer. + The bytes, encoded as a Base64URL string. + + + Converts a Base64URL encoded string to a string. + The Base64Url encoded string containing UTF8 bytes for a string. + The string represented by the Base64URL encoded string. + + + Encode a string as a Base64URL encoded string. + String input buffer. + The UTF8 bytes for the string, encoded as a Base64URL string. + + + + An implementation for manipulating headers on . + + + + + Initializes an instance of + + + + + Adds a header value to the header collection. + + The header name. + The header value. + + + + Returns header value if the header is stored in the collection. If the header has multiple values they are going to be joined with a comma. + + The header name. + The reference to populate with value. + true if the specified header is stored in the collection, otherwise false. + + + + Returns header values if the header is stored in the collection. + + The header name. + The reference to populate with values. + true if the specified header is stored in the collection, otherwise false. + + + + Returns true if the header is stored in the collection. + + The header name. + true if the specified header is stored in the collection, otherwise false. + + + + Sets a header value the header collection. + + The header name. + The header value. + + + + Removes the header from the collection. + + The header name. + + + + Returns an iterator enumerating in the request. + + The enumerating in the response. + + + + Copied from https://github.com/dotnet/corefx/blob/master/src/Common/src/CoreLib/System/HashCode.cs. + + + + + A collection of values that may take multiple service requests to + iterate over. + + The type of the values. + + Example of enumerating an AsyncPageable using the async foreach loop: + + // call a service method, which returns AsyncPageable<T> + AsyncPageable<SecretProperties> allSecretProperties = client.GetPropertiesOfSecretsAsync(); + + await foreach (SecretProperties secretProperties in allSecretProperties) + { + Console.WriteLine(secretProperties.Name); + } + + or using a while loop: + + // call a service method, which returns AsyncPageable<T> + AsyncPageable<SecretProperties> allSecretProperties = client.GetPropertiesOfSecretsAsync(); + + IAsyncEnumerator<SecretProperties> enumerator = allSecretProperties.GetAsyncEnumerator(); + try + { + while (await enumerator.MoveNextAsync()) + { + SecretProperties secretProperties = enumerator.Current; + Console.WriteLine(secretProperties.Name); + } + } + finally + { + await enumerator.DisposeAsync(); + } + + + + + + Gets a used for requests made while + enumerating asynchronously. + + + + + Initializes a new instance of the + class for mocking. + + + + + Initializes a new instance of the + class. + + + The used for requests made while + enumerating asynchronously. + + + + + Enumerate the values a at a time. This may + make multiple service requests. + + + A continuation token indicating where to resume paging or null to + begin paging from the beginning. + + + The size of s that should be requested (from + service operations that support it). + + + An async sequence of s. + + + + + Enumerate the values in the collection asynchronously. This may + make multiple service requests. + + + The used for requests made while + enumerating asynchronously. + + An async sequence of values. + + + + Creates an instance of using the provided pages. + + The pages of values to list as part of net new pageable instance. + A new instance of + + + + Creates a string representation of an . + + + A string representation of an . + + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the . + + Hash code for the . + + + + Key credential used to authenticate to an Azure Service. + It provides the ability to update the key without creating a new client. + + + + + Key used to authenticate to an Azure service. + + + + + Initializes a new instance of the class. + + Key to use to authenticate with the Azure service. + + Thrown when the is null. + + + Thrown when the is empty. + + + + + Updates the service key. + This is intended to be used when you've regenerated your service key + and want to update long lived clients. + + Key to authenticate the service against. + + Thrown when the is null. + + + Thrown when the is empty. + + + + + Credential allowing a named key to be used for authenticating to an Azure Service. + It provides the ability to update the key without creating a new client. + + + + + Name of the key used to authenticate to an Azure service. + + + + + Initializes a new instance of the class. + + The name of the . + The key to use for authenticating with the Azure service. + + Thrown when the or is null. + + + Thrown when the or is empty. + + + + + Updates the named key. This is intended to be used when you've regenerated your + service key and want to update long-lived clients. + + The name of the . + The key to use for authenticating with the Azure service. + + Thrown when the or is null. + + + Thrown when the or is empty. + + + + + Allows deconstruction of the credential into the associated name and key as an atomic operation. + + The name of the . + The key to use for authenticating with the Azure service. + + + var credential = new AzureNamedKeyCredential("SomeName", "SomeKey"); + (string name, string key) = credential; + + + Deconstructing tuples and other types + + + + Shared access signature credential used to authenticate to an Azure Service. + It provides the ability to update the shared access signature without creating a new client. + + + + + Shared access signature used to authenticate to an Azure service. + + + + + Initializes a new instance of the class. + + Shared access signature to use to authenticate with the Azure service. + + Thrown when the is null. + + + Thrown when the is empty. + + + + + Updates the shared access signature. + This is intended to be used when you've regenerated your shared access signature + and want to update long lived clients. + + Shared access signature to authenticate the service against. + + Thrown when the is null. + + + Thrown when the is empty. + + + + + Represents an HTTP ETag. + + + + + Creates a new instance of . + + The string value of the ETag. + + + + Compares equality of two instances. + + The to compare. + The to compare to. + true if values of both ETags are equal, otherwise false. + + + + Compares inequality of two instances. + + The to compare. + The to compare to. + true if values of both ETags are not equal, otherwise false. + + + + Instance of with the value. * + + + + Indicates whether the current object is equal to another object of the same type.An object to compare with this object. if the current object is equal to the parameter; otherwise, . + + + + Indicates whether the value of current is equal to the provided string. + An object to compare with this object. + true if the current object is equal to the other parameter; otherwise, false. + + + Indicates whether this instance and a specified object are equal.The object to compare with the current instance. if and this instance are the same type and represent the same value; otherwise, . + + + Returns the hash code for this instance.A 32-bit signed integer that is the hash code for this instance. + + + + + + The string representation of this . + + + + Returns the string representation of the . + + A format string. Valid values are "G" for standard format and "H" for header format. + The formatted string representation of this . This includes outer quotes and the W/ prefix in the case of weak ETags. + + + ETag tag = ETag.Parse("\"sometag\""); + Console.WriteLine(tag.ToString("G")); + // Displays: sometag + Console.WriteLine(tag.ToString("H")); + // Displays: "sometag" + + + + + + Defines a range of bytes within an HTTP resource, starting at an offset and + ending at offset+count-1 inclusively. + + + + + Gets the starting offset of the . + + + + + Gets the size of the . null means the range + extends all the way to the end. + + + + + Creates an instance of HttpRange. + + The starting offset of the . Defaults to 0. + The length of the range. null means to the end. + + + + Converts the specified range to a string. + + String representation of the range. + For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations. + + + + Check if two instances are equal. + + The first instance to compare. + The second instance to compare. + True if they're equal, false otherwise. + + + + Check if two instances are not equal. + + The first instance to compare. + The second instance to compare. + True if they're not equal, false otherwise. + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the . + + Hash code for the . + + + + Represents a JSON Patch document. + + + + + Initializes a new instance of that uses as the default serializer. + + + + + Initializes a new instance of + + The instance to use for value serialization. + + + + Initializes a new instance of + + The binary representation of JSON Patch document. + + + + Initializes a new instance of using an existing UTF8-encoded JSON Patch document. + + The binary representation of JSON Patch document. + The instance to use for value serialization. + + + + Initializes a new instance of using an existing UTF8-encoded JSON Patch document. + + The path to apply the addition to. + The raw JSON value to add to the path. + + + + Appends an "add" operation to this . + + The path to apply the addition to. + The value to add to the path. + + + + Appends a "replace" operation to this . + + The path to replace. + The raw JSON value to replace with. + + + + Appends a "replace" operation to this . + + The path to replace. + The value to replace with. + + + + Appends a "copy" operation to this . + + The path to copy from. + The path to copy to. + + + + Appends a "move" operation to this . + + The path to move from. + The path to move to. + + + + Appends a "remove" operation to this . + + The path to remove. + + + + Appends a "test" operation to this . + + The path to test. + The raw JSON value to test against. + + + + Appends a "test" operation to this . + + The path to test. + The value to replace with. + + + + Returns a UTF8-encoded representation of this instance. + + The UTF8-encoded JSON. + + + + Returns a formatted JSON string representation of this . + + A formatted JSON string representation of this . + + + + Specifies HTTP options for conditional requests. + + + + + Optionally limit requests to resources that have a matching ETag. + + + + + Optionally limit requests to resources that do not match the ETag. + + + + Represents a CloudEvent conforming to the 1.0 schema. This type has built-in serialization using System.Text.Json. + + + Initializes a new instance of the class. + Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event. + Type of event related to the originating occurrence. For example, "Contoso.Items.ItemReceived". + Event data specific to the event type. + The type to use when serializing the data. + If not specified, will be used on . + + or was null. + + + + Initializes a new instance of the class using binary event data. + Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event. + Type of event related to the originating occurrence. For example, "Contoso.Items.ItemReceived". + Binary event data specific to the event type. + Content type of the payload. A content type different from "application/json" should be specified if payload is not JSON. + The format that the data of a should be sent in + when using the JSON envelope format. + + or was null. + + + + + Gets or sets the event data as . Using BinaryData, + one can deserialize the payload into rich data, or access the raw JSON data using . + + + + + Gets or sets an identifier for the event. The combination of and must be unique for each distinct event. + If not explicitly set, this will default to a . + + + + Gets or sets the context in which an event happened. The combination of + and must be unique for each distinct event. + + + Gets or sets the type of event related to the originating occurrence. + + + + The spec version of the cloud event. + + + + + Gets or sets the time (in UTC) the event was generated, in RFC3339 format. + If not explicitly set, this will default to the time that the event is constructed. + + + + Gets or sets the schema that the data adheres to. + + + Gets or sets the content type of the data. + + + Gets or sets the subject of the event in the context of the event producer (identified by source). + + + + Gets extension attributes that can be additionally added to the CloudEvent envelope. + + + + + Given JSON-encoded events, parses the event envelope and returns an array of CloudEvents. + If the specified event is not valid JSON an exception is thrown. + By default, if the event is missing required properties, an exception is thrown though this can be relaxed + by setting the parameter. + + An instance of containing the JSON for one or more CloudEvents. + Set to to allow missing or invalid properties to still parse into a CloudEvent. + In particular, by setting strict to , the source, id, specversion and type properties are no longer required + to be present in the JSON. Additionally, the casing requirements of the extension attribute names are relaxed. + + An array of instances. + + + + Given a single JSON-encoded event, parses the event envelope and returns a . + If the specified event is not valid JSON an exception is thrown. + By default, if the event is missing required properties, an exception is thrown though this can be relaxed + by setting the parameter. + + An instance of containing the JSON for the CloudEvent. + Set to to allow missing or invalid properties to still parse into a CloudEvent. + In particular, by setting strict to , the source, id, specversion and type properties are no longer required + to be present in the JSON. Additionally, the casing requirements of the extension attribute names are relaxed. + + A . + + contained multiple events. should be used instead. + + + + + A custom converter that attributes the type. + This allows System.Text.Json to serialize and deserialize CloudEvents by default. + + + + + Gets or sets the serializer to use for the data portion of the . If not specified, + JsonObjectSerializer is used. + + The reader.The type to convert.An object that specifies serialization options to use.The converted value. + + + Writes a specified value as JSON.The writer to write to.The value to convert to JSON.An object that specifies serialization options to use. + + + + Specifies the format that the data of a should be sent in + when using the JSON envelope format for a . + . + + + + + Indicates the should be serialized as binary data. + This data will be included as a Base64 encoded string in the "data_base64" + field of the JSON payload. + + + + + Indicates the should be serialized as JSON. + The data will be included in the "data" field of the JSON payload. + + + + + Represents a long-running operation. + + + + + Gets an ID representing the operation that can be used to poll for + the status of the long-running operation. + + + + + The last HTTP response received from the server. + + + The last response returned from the server during the lifecycle of this instance. + An instance of sends requests to a server in UpdateStatusAsync, UpdateStatus, and other methods. + Responses from these requests can be accessed using GetRawResponse. + + + + + Returns true if the long-running operation completed. + + + + + Calls the server to get updated status of the long-running operation. + + A used for the service call. + The HTTP response received from the server. + + This operation will update the value returned from GetRawResponse and might update HasCompleted, HasValue, and Value. + + + + + Calls the server to get updated status of the long-running operation. + + A used for the service call. + The HTTP response received from the server. + + This operation will update the value returned from GetRawResponse and might update HasCompleted, HasValue, and Value. + + + + + Periodically calls the server till the long-running operation completes. + + A used for the periodical service calls. + The last HTTP response received from the server. + + This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final response of the operation. + + + + + Periodically calls the server till the long-running operation completes. + + + The interval between status requests to the server. + The interval can change based on information returned from the server. + For example, the server might communicate to the client that there is not reason to poll for status change sooner than some time. + + A used for the periodical service calls. + The last HTTP response received from the server. + + This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final response of the operation. + + + + Determines whether the specified object is equal to the current object.The object to compare with the current object. if the specified object is equal to the current object; otherwise, . + + + Serves as the default hash function.A hash code for the current object. + + + Returns a string that represents the current object.A string that represents the current object. + + + + Represents a long-running operation that returns a value when it completes. + + The final result of the long-running operation. + + + + Final result of the long-running operation. + + + This property can be accessed only after the operation completes successfully (HasValue is true). + + + + + Returns true if the long-running operation completed successfully and has produced final result (accessible by Value property). + + + + + Periodically calls the server till the long-running operation completes. + + A used for the periodical service calls. + The last HTTP response received from the server. + + This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation. + + + + + Periodically calls the server till the long-running operation completes. + + + The interval between status requests to the server. + The interval can change based on information returned from the server. + For example, the server might communicate to the client that there is not reason to poll for status change sooner than some time. + + A used for the periodical service calls. + The last HTTP response received from the server. + + This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation. + + + + + Periodically calls the server till the long-running operation completes. + + A used for the periodical service calls. + The last HTTP response received from the server. + + This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final response of the operation. + + + + + Periodically calls the server till the long-running operation completes. + + + The interval between status requests to the server. + The interval can change based on information returned from the server. + For example, the server might communicate to the client that there is not reason to poll for status change sooner than some time. + + A used for the periodical service calls. + The last HTTP response received from the server. + + This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final response of the operation. + + + + + A single of values from a request that may return + zero or more s of values. + + The type of values. + + + + Gets the values in this . + + + + + Gets the continuation token used to request the next + . The continuation token may be null or + empty when there are no more pages. + + + + + Gets the that provided this + . + + + + + Creates a new . + + + The values in this . + + + The continuation token used to request the next . + + + The that provided this . + + + + + Creates a string representation of an . + + + A string representation of an . + + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the . + + Hash code for the . + + + + A collection of values that may take multiple service requests to + iterate over. + + The type of the values. + + + + Gets a used for requests made while + enumerating asynchronously. + + + + + Initializes a new instance of the + class for mocking. + + + + + Initializes a new instance of the + class. + + + The used for requests made while + enumerating asynchronously. + + + + + Enumerate the values a at a time. This may + make multiple service requests. + + + A continuation token indicating where to resume paging or null to + begin paging from the beginning. + + + The size of s that should be requested (from + service operations that support it). + + + An async sequence of s. + + + + + Creates a string representation of an . + + + A string representation of an . + + + + + Enumerate the values in the collection. This may make multiple service requests. + + + + + Creates an instance of using the provided pages. + + The pages of values to list as part of net new pageable instance. + A new instance of + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the . + + Hash code for the . + + + + Specifies HTTP options for conditional requests based on modification time. + + + + + Optionally limit requests to resources that have only been + modified since this point in time. + + + + + Optionally limit requests to resources that have remained + unmodified. + + + + + An exception thrown when service request fails. + + + + + Gets the HTTP status code of the response. Returns. 0 if response was not received. + + + + + Gets the service specific error code if available. Please refer to the client documentation for the list of supported error codes. + + + + 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 specified error message, HTTP status code and a reference to the inner exception that is the cause of this exception. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + + + Initializes a new instance of the class with a specified error message and HTTP status code. + The HTTP status code, or 0 if not available. + The message that describes the error. + + + Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. + The HTTP status code, or 0 if not available. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + + + Initializes a new instance of the class with a specified error message, HTTP status code, error code, and a reference to the inner exception that is the cause of this exception. + The HTTP status code, or 0 if not available. + The error message that explains the reason for the exception. + The service specific error code. + The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + + + Initializes a new instance of the class with serialized data.The that holds the serialized object data about the exception being thrown.The that contains contextual information about the source or destination. is .The class name is or is zero (0). + + + When overridden in a derived class, sets the with information about the exception.The that holds the serialized object data about the exception being thrown.The that contains contextual information about the source or destination.The parameter is a null reference ( in Visual Basic). + + + + Represents the HTTP response from the service. + + + + + Gets the HTTP status code. + + + + + Gets the HTTP reason phrase. + + + + + Gets the contents of HTTP response. Returns null for responses without content. + + + + + Gets the client request id that was sent to the server as x-ms-client-request-id headers. + + + + + Get the HTTP response headers. + + + + + Gets the contents of HTTP response, if it is available. + + + Throws when is not a . + + + + + Frees resources held by this instance. + + + + + Returns header value if the header is stored in the collection. If header has multiple values they are going to be joined with a comma. + + The header name. + The reference to populate with value. + true if the specified header is stored in the collection, otherwise false. + + + + Returns header values if the header is stored in the collection. + + The header name. + The reference to populate with values. + true if the specified header is stored in the collection, otherwise false. + + + + Returns true if the header is stored in the collection. + + The header name. + true if the specified header is stored in the collection, otherwise false. + + + + Returns an iterator for enumerating in the response. + + The enumerating in the response. + + + + Creates a new instance of with the provided value and HTTP response. + + The type of the value. + The value. + The HTTP response. + A new instance of with the provided value and HTTP response. + + + + Returns the string representation of this . + + The string representation of this + + + + Represents a result of Azure operation. + + The type of returned value. + + + + Returns the HTTP response returned by the service. + + The HTTP response returned by the service. + + + + Gets the value returned by the service. + + + + + Returns the value of this object. + + The instance. + + + Determines whether the specified object is equal to the current object.The object to compare with the current object. if the specified object is equal to the current object; otherwise, . + + + Serves as the default hash function.A hash code for the current object. + + + Returns a string that represents the current object.A string that represents the current object. + + + + Extensions that can be used for serialization. + + + + + Converts the to the specified type using + the provided . + + The type that the data should be + converted to. + The instance to convert. + The serializer to use + when deserializing the data. + The to use during deserialization. + The data converted to the specified type. + + + + Converts the to the specified type using + the provided . + + The type that the data should be + converted to. + The instance to convert. + The serializer to use + when deserializing the data. + The to use during deserialization. + The data converted to the specified type. + + + + Provides data for + events that can be invoked either synchronously or asynchronously. + + + + + Gets a value indicating whether the event handler was invoked + synchronously or asynchronously. Please see + for more details. + + + + The same + event can be raised from both synchronous and asynchronous code + paths depending on whether you're calling sync or async methods on + a client. If you write an async handler but raise it from a sync + method, the handler will be doing sync-over-async and may cause + ThreadPool starvation. See + + Diagnosing .NET Core ThreadPool Starvation with PerfView for + a detailed explanation of how that can cause ThreadPool starvation + and serious performance problems. + + + You can use this property to check + how the event is being raised and implement your handler + accordingly. Here's an example handler that's safe to invoke from + both sync and async code paths. + + var client = new AlarmClient(); + client.Ring += async (SyncAsyncEventArgs e) => + { + if (e.IsRunningSynchronously) + { + Console.WriteLine("Wake up!"); + } + else + { + await Console.Out.WriteLineAsync("Wake up!"); + } + }; + + client.Snooze(); // sync call that blocks + await client.SnoozeAsync(); // async call that doesn't block + + + + + + + Gets a cancellation token related to the original operation that + raised the event. It's important for your handler to pass this + token along to any asynchronous or long-running synchronous + operations that take a token so cancellation (via something like + + new CancellationTokenSource(TimeSpan.FromSeconds(10)).Token + + for example) will correctly propagate. + + + + + Initializes a new instance of the + class. + + + A value indicating whether the event handler was invoked + synchronously or asynchronously. Please see + for more details. + + + A cancellation token related to the original operation that raised + the event. It's important for your handler to pass this token + along to any asynchronous or long-running synchronous operations + that take a token so cancellation will correctly propagate. The + default value is . + + + + Specifies that null is allowed as an input even if the corresponding type disallows it. + + + Specifies that null is disallowed as an input even if the corresponding type allows it. + + + Specifies that an output may be null even if the corresponding type disallows it. + + + Specifies that an output will not be null even if the corresponding type allows it. + + + Specifies that when a method returns , the parameter may be null even if the corresponding type disallows it. + + + Initializes the attribute with the specified return value condition. + + The return value condition. If the method returns this value, the associated parameter may be null. + + + + Gets the return value condition. + + + Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. + + + Initializes the attribute with the specified return value condition. + + The return value condition. If the method returns this value, the associated parameter will not be null. + + + + Gets the return value condition. + + + Specifies that the output will be non-null if the named parameter is non-null. + + + Initializes the attribute with the associated parameter name. + + The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null. + + + + Gets the associated parameter name. + + + Applied to a method that will never return under any circumstance. + + + Specifies that the method will not return if the associated Boolean parameter is passed the specified value. + + + Initializes the attribute with the specified parameter value. + + The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to + the associated parameter matches this value. + + + + Gets the condition parameter value. + + + Returns an enumerator that iterates through a collection.An object that can be used to iterate through the collection. + + + Returns an enumerator that iterates through a collection.An object that can be used to iterate through the collection. + + + Returns an enumerator that iterates through the collection.An enumerator that can be used to iterate through the collection. + + + Returns an enumerator that iterates through a collection.An object that can be used to iterate through the collection. + + + Gets the element in the collection at the current position of the enumerator.The element in the collection at the current position of the enumerator. + + + diff --git a/app_data/jobs/triggered/utility/Azure.Storage.Blobs.dll b/app_data/jobs/triggered/utility/Azure.Storage.Blobs.dll new file mode 100644 index 000000000..2fd2216f2 Binary files /dev/null and b/app_data/jobs/triggered/utility/Azure.Storage.Blobs.dll differ diff --git a/app_data/jobs/triggered/utility/Azure.Storage.Blobs.xml b/app_data/jobs/triggered/utility/Azure.Storage.Blobs.xml new file mode 100644 index 000000000..cfd2e3225 --- /dev/null +++ b/app_data/jobs/triggered/utility/Azure.Storage.Blobs.xml @@ -0,0 +1,23111 @@ + + + + Azure.Storage.Blobs + + + + + The allows you to manipulate Azure + Storage append blobs. + + An append blob is comprised of blocks and is optimized for append + operations. When you modify an append blob, blocks are added to the + end of the blob only, via the + operation. Updating or deleting of existing blocks is not supported. + Unlike a block blob, an append blob does not expose its block IDs. + + Each block in an append blob can be a different size, up to a maximum + of 4 MB, and an append blob can include up to 50,000 blocks. The + maximum size of an append blob is therefore slightly more than 195 GB + (4 MB X 50,000 blocks). + + + + + Gets the maximum number of bytes that can be sent in a call + to AppendBlock. + + + + + Gets the maximum number of blocks allowed in an append blob. + + + + + Initializes a new instance of the + class for mocking. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, Configure Azure Storage connection strings + + + The name of the container containing this append blob. + + + The name of this append blob. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, Configure Azure Storage connection strings + + + The name of the container containing this append blob. + + + The name of this append blob. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the append blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the append blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + The shared key credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the append blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + Must not contain shared access signature, which should be passed in the second parameter. + + + The shared access signature credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + This constructor should only be used when shared access signature needs to be updated during lifespan of this client. + + + + + Initializes a new instance of the + class. + + + A referencing the append blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + The token credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the append blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + The transport pipeline used to send every request. + + + The version of the service to use when sending requests. + + + The shared key credential used to sign requests. + + Client diagnostics. + Customer provided key. + Encryption scope. + + + + Initializes a new instance of the + class with an identical source but the specified + timestamp. + + For more information, see + + Create a snapshot of a blob. + + The snapshot identifier. + A new instance. + + Pass null or empty string to remove the snapshot returning a URL + to the base blob. + + + + + Initializes a new instance of the + class with an identical source but the specified + timestamp. + + + The version identifier. + A new instance. + + Pass null or empty string to remove the version returning a URL + to the base blob. + + + + + The + operation creates a new 0-length append blob. The content of any existing + blob is overwritten with the newly initialized append blob. To add content + to the append blob, call the operation. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + newly created append blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new 0-length append blob. The content of any existing + blob is overwritten with the newly initialized append blob. To add content + to the append blob, call the operation. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + newly created append blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new 0-length append blob. The content of any existing blob is overwritten with + the newly initialized append blob. To add content to the append + blob, call the operation. + + For more information, see + + Put Blob. + + + Optional standard HTTP header properties that can be set for the + new append blob. + + + Optional custom metadata to set for this append blob. + + + Optional to add + conditions on the creation of this new append blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + newly created append blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new 0-length append blob. The content of any existing blob is overwritten with + the newly initialized append blob. To add content to the append + blob, call the operation. + + For more information, see + + Put Blob. + + + Optional standard HTTP header properties that can be set for the + new append blob. + + + Optional custom metadata to set for this append blob. + + + Optional to add + conditions on the creation of this new append blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + newly created append blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new 0-length append blob. If the append blob already exists, + the content of the existing append blob will remain unchanged. To add content to + the append blob, call the operation. + + For more information, see + + Put Blob. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + If the append blob does not already exist, a + describing the newly created append blob. Otherwise, null. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new 0-length append blob. If the append blob already exists, + the content of the existing append blob will remain unchanged. To add content to + the append blob, call the operation. + + For more information, see + + Put Blob. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + If the append blob does not already exist, a + describing the newly created append blob. Otherwise, null. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new 0-length append blob. If the append blob already exists, + the content of the existing append blob will remain unchanged. To add content to + the append blob, call the operation. + + For more information, see + + Put Blob. + + + Optional standard HTTP header properties that can be set for the + new append blob. + + + Optional custom metadata to set for this append blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + If the append blob does not already exist, a + describing the newly created append blob. Otherwise, null. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new 0-length append blob. If the append blob already exists, + the content of the existing append blob will remain unchanged. To add content to the append + blob, call the operation. + + For more information, see + + Put Blob. + + + Optional standard HTTP header properties that can be set for the + new append blob. + + + Optional custom metadata to set for this append blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + If the append blob does not already exist, a + describing the newly created append blob. Otherwise, null. + + + A will be thrown if + a failure occurs. + + + + + The operation commits a new block + of data, represented by the , + to the end of the existing append blob. The + operation is only permitted if the blob was created as an append + blob. + + For more information, see + + Append Block. + + + A containing the content of the block to + append. + + + Optional MD5 hash of the block content. This hash is used to + verify the integrity of the block during transport. When this hash + is specified, the storage service compares the hash of the content + that has arrived with this value. Note that this MD5 hash is not + stored with the blob. If the two hashes do not match, the + operation will fail with a . + + + Optional to add + conditions on appending content to this append blob. + + + Optional to provide + progress updates about data transfers. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated append blob. + + + A will be thrown if + a failure occurs. + + + + + The operation commits a new block + of data, represented by the , + to the end of the existing append blob. The + operation is only permitted if the blob was created as an append + blob. + + For more information, see + + Append Block. + + + A containing the content of the block to + append. + + + Optional MD5 hash of the block content. This hash is used to + verify the integrity of the block during transport. When this hash + is specified, the storage service compares the hash of the content + that has arrived with this value. Note that this MD5 hash is not + stored with the blob. If the two hashes do not match, the + operation will fail with a . + + + Optional to add + conditions on appending content to this append blob. + + + Optional to provide + progress updates about data transfers. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated append blob. + + + A will be thrown if + a failure occurs. + + + + + The operation commits a new block + of data, represented by the , + to the end of the existing append blob. The + operation is only permitted if the blob was created as an append + blob. + + For more information, see + + Append Block. + + + A containing the content of the block to + append. + + + Optional MD5 hash of the block content. This hash is used to + verify the integrity of the block during transport. When this hash + is specified, the storage service compares the hash of the content + that has arrived with this value. Note that this MD5 hash is not + stored with the blob. If the two hashes do not match, the + operation will fail with a . + + + Optional to add + conditions on appending content to this append blob. + + + Optional to provide + progress updates about data transfers. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated append blob. + + + A will be thrown if + a failure occurs. + + + + + The operation commits a new + block of data, represented by the , + to the end of the existing append blob. The + operation is only permitted + if the blob was created as an append blob. + + For more information, see + + Append Block From URL. + + + Specifies the of the source blob. The value may + be a of up to 2 KB in length that specifies a + blob. The source blob must either be public or must be + authenticated via a shared access signature. If the source blob + is public, no authentication is required to perform the operation. + + + Optionally only upload the bytes of the blob in the + in the specified range. If this is + not specified, the entire source blob contents are uploaded as a + single append block. + + + Optional MD5 hash of the append block content from the + . This hash is used to verify the + integrity of the block during transport of the data from the Uri. + When this hash is specified, the storage service compares the hash + of the content that has arrived from the + with this value. Note that this md5 hash is not stored with the + blob. If the two hashes do not match, the operation will fail + with a . + + + Optional to add + conditions on the copying of data to this append blob. + + + Optional to add + conditions on the copying of data from this source blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated append blob. + + + A will be thrown if + a failure occurs. + + + + + The operation commits a new + block of data, represented by the , + to the end of the existing append blob. The + operation is only permitted + if the blob was created as an append blob. + + For more information, see + + Append Block From URL. + + + Specifies the of the source blob. The value may + be a of up to 2 KB in length that specifies a + blob. The source blob must either be public or must be + authenticated via a shared access signature. If the source blob + is public, no authentication is required to perform the operation. + + + Optionally only upload the bytes of the blob in the + in the specified range. If this is + not specified, the entire source blob contents are uploaded as a + single append block. + + + Optional MD5 hash of the append block content from the + . This hash is used to verify the + integrity of the block during transport of the data from the Uri. + When this hash is specified, the storage service compares the hash + of the content that has arrived from the + with this value. Note that this md5 hash is not stored with the + blob. If the two hashes do not match, the operation will fail + with a . + + + Optional to add + conditions on the copying of data to this append blob. + + + Optional to add + conditions on the copying of data from this source blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated append blob. + + + A will be thrown if + a failure occurs. + + + + + Seals the append blob, making it read only. + Any subsequent appends will fail. + + + Optional to add + conditions on the sealing of this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the sealed append blob. + + + A will be thrown if + a failure occurs. + + + + + Seals the append blob, making it read only. + Any subsequent appends will fail. + + + Optional to add + conditions on the sealing of this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the sealed append blob. + + + A will be thrown if + a failure occurs. + + + + + Opens a stream for writing to the blob. + + + Whether an existing blob should be deleted and recreated. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A stream to write to the Append Blob. + + + A will be thrown if + a failure occurs. + + + + + Opens a stream for writing to the blob. + + + Whether an existing blob should be deleted and recreated. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A stream to write to the Append Blob. + + + A will be thrown if + a failure occurs. + + + + + Add easy to discover methods to for + creating instances. + + + Add easy to discover methods to for + creating instances. + + + Add easy to discover methods to for + creating instances. + + + Add easy to discover methods to and + for easily creating + instances. + + + Add easy to discover methods to for + creating instances. + + + Add easy to discover methods to for + creating instances. + + + + + Create a new object by + concatenating to + the end of the 's + . The new + + uses the same request policy pipeline as the + . + + The . + The name of the append blob. + A new instance. + + + + Create a new that pointing to this 's parent container. + The new + uses the same request policy pipeline as the + . + + The . + A new instance. + + + + Create a new object by concatenating + to the end of the + 's . + The new uses the same request policy + pipeline as the . + + The . + The name of the blob. + A new instance. + + + + Creates a new instance of the class, maintaining all the same + internals but specifying new . + + Client to base off of. + New encryption options. Setting this to default will clear client-side encryption. + New instance with provided options and same internals otherwise. + + + + Create a new that pointing to this 's blob service. + The new + uses the same request policy pipeline as the + . + + A new instance. + + + + Initializes a new instance of the class. + + + A representing the blob being leased. + + + An optional lease ID. If no lease ID is provided, a random lease + ID will be created. + + + + + Initializes a new instance of the class. + + + A representing the container + being leased. + + + An optional lease ID. If no lease ID is provided, a random lease + ID will be created. + + + + + Create a new object by + concatenating to + the end of the 's + . The new + + uses the same request policy pipeline as the + . + + The . + The name of the block blob. + A new instance. + + + + Create a new object by + concatenating to + the end of the 's + . The new + + uses the same request policy pipeline as the + . + + The . + The name of the page blob. + A new instance. + + + + The allows you to manipulate Azure Storage + blobs. + + + + + Gets the blob's primary endpoint. + + + + + The transport pipeline used to send + every request. + + + + + The version of the service to use when sending requests. + + + + + The instance used to create diagnostic scopes + every request. + + + + + The to be used when sending requests. + + + + + The to be used when sending requests. + + + + + The to be used when sending/receiving requests. + + + + + The name of the Encryption Scope to be used when sending requests. + + + + + The name of the Encryption Scope to be used when sending requests. + + + + + Gets the Storage account name corresponding to the blob client. + + + + + Gets the container name corresponding to the blob client. + + + + + Gets the name of the blob. + + + + + Gets the The used to authenticate and generate SAS. + + + + + Determines whether the client is able to generate a SAS. + If the client is authenticated with a . + + + + + Initializes a new instance of the + class. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, + + Configure Azure Storage connection strings + + + The name of the container containing this blob. + + + The name of this blob. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, + + Configure Azure Storage connection strings + + + The name of the container containing this blob. + + + The name of this blob. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + The shared key credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + Must not contain shared access signature, which should be passed in the second parameter. + + + The shared access signature credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + This constructor should only be used when shared access signature needs to be updated during lifespan of this client. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + The token credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + An optional authentication policy used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + The shared key credential used to sign requests. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + The transport pipeline used to send every request. + + + The version of the service to use when sending requests. + + + The shared key credential used to sign requests. + + Client diagnostics. + Customer provided key. + Client-side encryption options. + Encryption scope. + + + + Initializes a new instance of the + class with an identical source but the specified + timestamp. + + For more information, see + + Create a snapshot of a blob. + + The snapshot identifier. + A new instance. + + Pass null or empty string to remove the snapshot returning a URL + to the base blob. + + + + + Creates a new instance of the class + with an identical source but the specified + timestamp. + + The snapshot identifier. + A new instance. + + + + Initializes a new instance of the + class with an identical source but the specified + timestamp. + + + The version identifier. + A new instance. + + Pass null or empty string to remove the version returning a URL + to the base blob. + + + + + Creates a new instance of the class + with an identical source but the specified + timestamp. + + The version identifier. + A new instance. + + + + Initializes a new instance of the class. + + + An optional lease ID. If no lease ID is provided, a random lease + ID will be created. + + + + + The operation downloads a blob from + the service, including its metadata and properties. + + For more information, see + + Get Blob. + + + A describing the + downloaded blob. contains + the blob's data. + + + A will be thrown if + a failure occurs. + + + + + The operation downloads a blob from + the service, including its metadata and properties. + + For more information, see + + Get Blob. + + + A describing the + downloaded blob. contains + the blob's data. + + + A will be thrown if + a failure occurs. + + + + + The operation downloads + a blob from the service, including its metadata and properties. + + For more information, see + + Get Blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + downloaded blob. contains + the blob's data. + + + A will be thrown if + a failure occurs. + + + + + The operation + downloads a blob from the service, including its metadata and + properties. + + For more information, see + + Get Blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + downloaded blob. contains + the blob's data. + + + A will be thrown if + a failure occurs. + + + + + The + operation downloads a blob from the service, including its metadata + and properties. + + For more information, see + + Get Blob. + + + If provided, only download the bytes of the blob in the specified + range. If not provided, download the entire blob. + + + Optional to add conditions on + downloading this blob. + + + When set to true and specified together with the , + the service returns the MD5 hash for the range, as long as the + range is less than or equal to 4 MB in size. If this value is + specified without or set to true when the + range exceeds 4 MB in size, a + is thrown. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + downloaded blob. contains + the blob's data. + + + A will be thrown if + a failure occurs. + + + + + The + operation downloads a blob from the service, including its metadata + and properties. + + For more information, see + + Get Blob. + + + If provided, only download the bytes of the blob in the specified + range. If not provided, download the entire blob. + + + Optional to add conditions on + downloading this blob. + + + When set to true and specified together with the , + the service returns the MD5 hash for the range, as long as the + range is less than or equal to 4 MB in size. If this value is + specified without or set to true when the + range exceeds 4 MB in size, a + is thrown. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + downloaded blob. contains + the blob's data. + + + A will be thrown if + a failure occurs. + + + + + The operation downloads a blob using parallel requests, + and writes the content to . + + + A to write the downloaded content to. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + The operation downloads a blob using parallel requests, + and writes the content to . + + + A file path to write the downloaded content to. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + The downloads a blob using parallel requests, + and writes the content to . + + + A to write the downloaded content to. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + The downloads a blob using parallel requests, + and writes the content to . + + + A file path to write the downloaded content to. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + The operation + downloads a blob using parallel requests, + and writes the content to . + + + A to write the downloaded content to. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + The operation + downloads a blob using parallel requests, + and writes the content to . + + + A file path to write the downloaded content to. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + The operation + downloads a blob using parallel requests, + and writes the content to . + + + A to write the downloaded content to. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + The operation + downloads a blob using parallel requests, + and writes the content to . + + + A file path to write the downloaded content to. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + The + operation downloads a blob using parallel requests, + and writes the content to . + + + A to write the downloaded content to. + + + Optional to add conditions on + the creation of this new block blob. + + + Optional to configure + parallel transfer behavior. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + The + operation downloads a blob using parallel requests, + and writes the content to . + + + A file path to write the downloaded content to. + + + Optional to add conditions on + the creation of this new block blob. + + + Optional to configure + parallel transfer behavior. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + The + operation downloads a blob using parallel requests, + and writes the content to . + + + A to write the downloaded content to. + + + Optional to add conditions on + the creation of this new block blob. + + + Optional to configure + parallel transfer behavior. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + The + operation downloads a blob using parallel requests, + and writes the content to . + + + A file path to write the downloaded content to. + + + Optional to add conditions on + the creation of this new block blob. + + + Optional to configure + parallel transfer behavior. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + This operation will download a blob of arbitrary size by downloading it as individually staged + partitions if it's larger than the + MaximumTransferLength. + + + A to write the downloaded content to. + + + Optional to add conditions on + the creation of this new block blob. + + + Optional to configure + parallel transfer behavior. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the operation. + + + A will be thrown if + a failure occurs. + + + + + Opens a stream for reading from the blob. The stream will only download + the blob as the stream is read from. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + Returns a stream that will download the blob as the stream + is read from. + + + + + Opens a stream for reading from the blob. The stream will only download + the blob as the stream is read from. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + Returns a stream that will download the blob as the stream + is read from. + + + + + Opens a stream for reading from the blob. The stream will only download + the blob as the stream is read from. + + + The position within the blob to begin the stream. + Defaults to the beginning of the blob. + + + The buffer size to use when the stream downloads parts + of the blob. Defaults to 1 MB. + + + Optional to add conditions on + the download of the blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + Returns a stream that will download the blob as the stream + is read from. + + + + + Opens a stream for reading from the blob. The stream will only download + the blob as the stream is read from. + + + If true, you can continue streaming a blob even if it has been modified. + + + The position within the blob to begin the stream. + Defaults to the beginning of the blob. + + + The buffer size to use when the stream downloads parts + of the blob. Defaults to 1 MB. + + + Optional to propagate + notifications that the operation should be cancelled. + + + Returns a stream that will download the blob as the stream + is read from. + + + + + Opens a stream for reading from the blob. The stream will only download + the blob as the stream is read from. + + + The position within the blob to begin the stream. + Defaults to the beginning of the blob. + + + The buffer size to use when the stream downloads parts + of the blob. Defaults to 1 MB. + + + Optional to add conditions on + the download of the blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + Returns a stream that will download the blob as the stream + is read from. + + + + + Opens a stream for reading from the blob. The stream will only download + the blob as the stream is read from. + + + If true, you can continue streaming a blob even if it has been modified. + + + The position within the blob to begin the stream. + Defaults to the beginning of the blob. + + + The buffer size to use when the stream downloads parts + of the blob. Defaults to 1 MB. + + + Optional to propagate + notifications that the operation should be cancelled. + + + Returns a stream that will download the blob as the stream + is read from. + + + + + Opens a stream for reading from the blob. The stream will only download + the blob as the stream is read from. + + + The position within the blob to begin the stream. + Defaults to the beginning of the blob. + + + The buffer size to use when the stream downloads parts + of the blob. Defaults to 1 MB. + + + Optional to add conditions on + the download of the blob. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + Returns a stream that will download the blob as the stream + is read from. + + + + + The + operation begins an asynchronous copy of the data from the to this blob. + You can check the + returned from the to determine if the + copy has completed. + + For more information, see + + Copy Blob. + + + Specifies the of the source blob. The value may + be a of up to 2 KB in length that specifies a + blob. A source blob in the same storage account can be + authenticated via Shared Key. However, if the source is a blob in + another account, the source blob must either be public or must be + authenticated via a shared access signature. If the source blob + is public, no authentication is required to perform the copy + operation. + + The source object may be a file in the Azure File service. If the + source object is a file that is to be copied to a blob, then the + source file must be authenticated using a shared access signature, + whether it resides in the same account or in a different account. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the copy operation. + + + A will be thrown if + a failure occurs. + + + + + The + operation begins an asynchronous copy of the data from the to this blob. + You can check the + returned from the to determine if the + copy has completed. + + For more information, see + + Copy Blob. + + + Specifies the of the source blob. The value may + be a of up to 2 KB in length that specifies a + blob. A source blob in the same storage account can be + authenticated via Shared Key. However, if the source is a blob in + another account, the source blob must either be public or must be + authenticated via a shared access signature. If the source blob + is public, no authentication is required to perform the copy + operation. + + The source object may be a file in the Azure File service. If the + source object is a file that is to be copied to a blob, then the + source file must be authenticated using a shared access signature, + whether it resides in the same account or in a different account. + + + Optional custom metadata to set for this blob. + + + Optional + Indicates the tier to be set on the blob. + + + Optional to add + conditions on the copying of data from this source blob. + + + Optional to add conditions on + the copying of data to this blob. + + + Optional + Indicates the priority with which to rehydrate an archived blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the copy operation. + + + A will be thrown if + a failure occurs. + + + + + The + operation begins an asynchronous copy of the data from the + to this blob. You can check the + returned from the to determine if + the copy has completed. + + For more information, see + + Copy Blob. + + + Specifies the of the source blob. The value may + be a of up to 2 KB in length that specifies a + blob. A source blob in the same storage account can be + authenticated via Shared Key. However, if the source is a blob in + another account, the source blob must either be public or must be + authenticated via a shared access signature. If the source blob + is public, no authentication is required to perform the copy + operation. + + The source object may be a file in the Azure File service. If the + source object is a file that is to be copied to a blob, then the + source file must be authenticated using a shared access signature, + whether it resides in the same account or in a different account. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the copy operation. + + + A will be thrown if + a failure occurs. + + + + + The + operation begins an asynchronous copy of the data from the + to this blob.You can check the + returned from the to determine if + the copy has completed. + + For more information, see + + Copy Blob. + + + Specifies the of the source blob. The value may + be a of up to 2 KB in length that specifies a + blob. A source blob in the same storage account can be + authenticated via Shared Key. However, if the source is a blob in + another account, the source blob must either be public or must be + authenticated via a shared access signature. If the source blob + is public, no authentication is required to perform the copy + operation. + + The source object may be a file in the Azure File service. If the + source object is a file that is to be copied to a blob, then the + source file must be authenticated using a shared access signature, + whether it resides in the same account or in a different account. + + + Optional custom metadata to set for this blob. + + + Optional + Indicates the tier to be set on the blob. + + + Optional to add + conditions on the copying of data from this source blob. + + + Optional to add conditions on + the copying of data to this blob. + + + Optional + Indicates the priority with which to rehydrate an archived blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the copy operation. + + + A will be thrown if + a failure occurs. + + + + + The operation aborts a pending + , and leaves a this + blob with zero length and full metadata. + + For more information, see + + Abort Copy Blob. + + + ID of the copy operation to abort. + + + Optional to add + conditions on aborting the copy operation. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully aborting. + + + A will be thrown if + a failure occurs. + + + + + The operation aborts a pending + , and leaves a this + blob with zero length and full metadata. + + For more information, see + + Abort Copy Blob. + + + ID of the copy operation to abort. + + + Optional to add + conditions on aborting the copy operation. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully aborting. + + + A will be thrown if + a failure occurs. + + + + + The Copy Blob From URL operation copies a blob to a destination within the storage account synchronously + for source blob sizes up to 256 MB. This API is available starting in version 2018-03-28. + The source for a Copy Blob From URL operation can be any committed block blob in any Azure storage account + which is either public or authorized with a shared access signature. + + The size of the source blob can be a maximum length of up to 256 MB. + + For more information, see + + Copy Blob From URL. + + + Required. Specifies the URL of the source blob. The value may be a URL of up to 2 KB in length + that specifies a blob. The value should be URL-encoded as it would appear in a request URI. The + source blob must either be public or must be authorized via a shared access signature. If the + source blob is public, no authorization is required to perform the operation. If the size of the + source blob is greater than 256 MB, the request will fail with 409 (Conflict). The blob type of + the source blob has to be block blob. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the copy operation. + + + A will be thrown if + a failure occurs. + + + + + The Copy Blob From URL operation copies a blob to a destination within the storage account synchronously + for source blob sizes up to 256 MB. This API is available starting in version 2018-03-28. + The source for a Copy Blob From URL operation can be any committed block blob in any Azure storage account + which is either public or authorized with a shared access signature. + + The size of the source blob can be a maximum length of up to 256 MB. + + For more information, see + + Copy Blob From URL. + + + Required. Specifies the URL of the source blob. The value may be a URL of up to 2 KB in length + that specifies a blob. The value should be URL-encoded as it would appear in a request URI. The + source blob must either be public or must be authorized via a shared access signature. If the + source blob is public, no authorization is required to perform the operation. If the size of the + source blob is greater than 256 MB, the request will fail with 409 (Conflict). The blob type of + the source blob has to be block blob. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the copy operation. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified blob + or snapshot for deletion. The blob is later deleted during + garbage collection. + + Note that in order to delete a blob, you must delete all of its + snapshots. You can delete both at the same time using + . + + For more information, see + + Delete Blob. + + + Specifies options for deleting blob snapshots. + + + Optional to add conditions on + deleting this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully deleting. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified blob + or snapshot for deletion. The blob is later deleted during + garbage collection. + + Note that in order to delete a blob, you must delete all of its + snapshots. You can delete both at the same time using + . + + For more information, see + + Delete Blob. + + + Specifies options for deleting blob snapshots. + + + Optional to add conditions on + deleting this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully deleting. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified blob + or snapshot for deletion, if the blob exists. The blob is later deleted + during garbage collection. + + Note that in order to delete a blob, you must delete all of its + snapshots. You can delete both at the same time using + . + + For more information, see + + Delete Blob. + + + Specifies options for deleting blob snapshots. + + + Optional to add conditions on + deleting this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A Returns true if blob exists and was + deleted, return false otherwise. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified blob + or snapshot for deletion, if the blob exists. The blob is later deleted + during garbage collection. + + Note that in order to delete a blob, you must delete all of its + snapshots. You can delete both at the same time using + . + + For more information, see + + Delete Blob. + + + Specifies options for deleting blob snapshots. + + + Optional to add conditions on + deleting this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A Returns true if blob exists and was + deleted, return false otherwise. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified blob + or snapshot for deletion, if the blob exists. The blob is later deleted + during garbage collection. + + Note that in order to delete a blob, you must delete all of its + snapshots. You can delete both at the same time using + . + + For more information, see + + Delete Blob. + + + Specifies options for deleting blob snapshots. + + + Optional to add conditions on + deleting this blob. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully deleting. + + + A will be thrown if + a failure occurs. + + + + + The operation can be called on a + to see if the associated blob + exists in the container on the storage account in the + storage service. + + + Optional to propagate + notifications that the operation should be cancelled. + + + Returns true if the blob exists. + + + A will be thrown if + a failure occurs. + + + + + The operation can be called on a + to see if the associated blob + exists in the container on the storage account in the storage service. + + + Optional to propagate + notifications that the operation should be cancelled. + + + Returns true if the blob exists. + + + A will be thrown if + a failure occurs. + + + + + The operation restores the contents + and metadata of a soft deleted blob and any associated soft + deleted snapshots. + + For more information, see + + Undelete Blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully deleting. + + + A will be thrown if + a failure occurs. + + + + + The operation restores the contents + and metadata of a soft deleted blob and any associated soft + deleted snapshots. + + For more information, see + + Undelete Blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully deleting. + + + A will be thrown if + a failure occurs. + + + + + The operation returns all + user-defined metadata, standard HTTP properties, and system + properties for the blob. It does not return the content of the + blob. + + For more information, see + + Get Blob Properties. + + + Optional to add + conditions on getting the blob's properties. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + blob's properties. + + + A will be thrown if + a failure occurs. + + + + + The operation returns all + user-defined metadata, standard HTTP properties, and system + properties for the blob. It does not return the content of the + blob. + + For more information, see + + Get Blob Properties. + + + Optional to add + conditions on getting the blob's properties. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + blob's properties. + + + A will be thrown if + a failure occurs. + + + + + The operation returns all + user-defined metadata, standard HTTP properties, and system + properties for the blob. It does not return the content of the + blob. + + For more information, see + + Get Blob Properties. + + + Optional to add + conditions on getting the blob's properties. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + The name of the calling operation. + + + A describing the + blob's properties. + + + A will be thrown if + a failure occurs. + + + + + The operation sets system + properties on the blob. + + For more information, see + + Set Blob Properties. + + + Optional. The standard HTTP header system properties to set. + If not specified, existing values will be cleared. + + + Optional to add conditions on + setting the blob's HTTP headers. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the updated + blob. + + + A will be thrown if + a failure occurs. + + + + + The operation sets system + properties on the blob. + + For more information, see + + Set Blob Properties. + + + Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared. + + + Optional to add conditions on + setting the blob's HTTP headers. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the updated + blob. + + + A will be thrown if + a failure occurs. + + + + + The operation sets user-defined + metadata for the specified blob as one or more name-value pairs. + + For more information, see + + Set Blob Metadata. + + + Custom metadata to set for this blob. + + + Optional to add conditions on + setting the blob's metadata. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the updated + blob. + + + A will be thrown if + a failure occurs. + + + + + The operation sets user-defined + metadata for the specified blob as one or more name-value pairs. + + For more information, see + + Set Blob Metadata. + + + Custom metadata to set for this blob. + + + Optional to add conditions on + setting the blob's metadata. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the updated + blob. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a + read-only snapshot of a blob. + + For more information, see + + Snapshot Blob. + + + Optional custom metadata to set for this blob snapshot. + + + Optional to add conditions on + setting creating this snapshot. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + new blob snapshot. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a + read-only snapshot of a blob. + + For more information, see + + Snapshot Blob. + + + Optional custom metadata to set for this blob snapshot. + + + Optional to add conditions on + setting creating this snapshot. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + new blob snapshot. + + + A will be thrown if + a failure occurs. + + + + + The operation sets the tier on a blob. + The operation is allowed on a page blob in a premium storage + account and on a block blob in a blob storage or general purpose + v2 account. + + A premium page blob's tier determines the allowed size, IOPS, and + bandwidth of the blob. A block blob's tier determines + Hot/Cool/Archive storage type. This operation does not update the + blob's ETag. For detailed information about block blob level + tiering + Blob Storage Tiers. + + For more information about setting the tier, see + + Blob Storage Tiers. + + + Indicates the tier to be set on the blob. + + + Optional to add conditions on + setting the access tier. + + + Optional + Indicates the priority with which to rehydrate an archived blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully setting the tier. + + + A will be thrown if + a failure occurs. + + + + + The operation sets the tier on a blob. + The operation is allowed on a page blob in a premium storage + account and on a block blob in a blob storage or general purpose + v2 account. + + A premium page blob's tier determines the allowed size, IOPS, and + bandwidth of the blob. A block blob's tier determines + Hot/Cool/Archive storage type. This operation does not update the + blob's ETag. For detailed information about block blob level + tiering + Blob Storage Tiers. + + For more information about setting the tier, see + + Blob Storage Tiers. + + + Indicates the tier to be set on the blob. + + + Optional to add conditions on + setting the access tier. + + + Optional + Indicates the priority with which to rehydrate an archived blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully setting the tier. + + + A will be thrown if + a failure occurs. + + + + + Gets the tags associated with the underlying blob. + + For more information, see + + Get Blob Tags + + + Optional to add conditions on + getting the blob's tags. Note that TagConditions is currently the + only condition supported by GetTags. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully getting tags. + + + A will be thrown if + a failure occurs. + + + + + Gets the tags associated with the underlying blob. + + For more information, see + + Get Blob Tags + + + Optional to add conditions on + getting the blob's tags. Note that TagConditions is currently the + only condition supported by GetTags. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully getting tags. + + + A will be thrown if + a failure occurs. + + + + + Sets tags on the underlying blob. + A blob can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters. + Valid tag key and value characters include lower and upper case letters, digits (0-9), + space (' '), plus ('+'), minus ('-'), period ('.'), foward slash ('/'), colon (':'), equals ('='), and underscore ('_'). + + For more information, see + + Set Blob Tags. + + + The tags to set on the blob. + + + Optional to add conditions on + setting the blob's tags. Note that TagConditions is currently the + only condition supported by SetTags. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully setting the blob tags.. + + + A will be thrown if + a failure occurs. + + + + + Sets tags on the underlying blob. + A blob can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters. + Valid tag key and value characters include lower and upper case letters, digits (0-9), + space (' '), plus ('+'), minus ('-'), period ('.'), foward slash ('/'), colon (':'), equals ('='), and underscore ('_'). + + For more information, see + + Set Blob Tags. + + + The tags to set on the blob. + + + Optional to add conditions on + setting the blob's tags. Note that TagConditions is currently the + only condition supported by SetTags. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully setting the blob tags.. + + + A will be thrown if + a failure occurs. + + + + + The + returns a that generates a Blob Service + Shared Access Signature (SAS) Uri based on the Client properties and + parameters passed. The SAS is signed by the shared key credential + of the client. + + To check if the client is able to sign a Service Sas see + . + + For more information, see + + Constructing a service SAS. + + + Required. Specifies the list of permissions to be associated with the SAS. + See . + + + Required. Specifies the time at which the SAS becomes invalid. This field + must be omitted if it has been specified in an associated stored access policy. + + + A containing the SAS Uri. + + + A will be thrown if a failure occurs. + + + + + The returns a + that generates a Blob Service Shared Access Signature (SAS) Uri + based on the Client properties and and builder. The SAS is signed + by the shared key credential of the client. + + To check if the client is able to sign a Service Sas see + . + + For more information, see + + Constructing a Service SAS. + + + Used to generate a Shared Access Signature (SAS). + + + A containing the SAS Uri. + + + A will be thrown if + a failure occurs. + + + + + Create a new that pointing to this 's parent container. + The new + uses the same request policy pipeline as the + . + + A new instance. + + + + The allows you to manipulate Azure + Storage leases on containers and blobs. + + + + + Gets the to manage leases for. + + + + + Gets the to manage leases for. + + + + + Gets the URI of the object being leased. + + + + + Gets the Lease ID for this lease. + + + + + The version of the service to use when sending requests. + + + + + The instance used to create diagnostic scopes + every request. + + + + + The representing an infinite lease duration. + + + + + Initializes a new instance of the class + for mocking. + + + + + Initializes a new instance of the class. + + + A representing the blob being leased. + + + An optional lease ID. If no lease ID is provided, a random lease + ID will be created. + + + + + Initializes a new instance of the class. + + + A representing the blob container + being leased. + + + An optional lease ID. If no lease ID is provided, a random lease + ID will be created. + + + + + The operation acquires a lease on + the blob or container. The lease must + be between 15 to 60 seconds, or infinite (-1). + + If the container does not have an active lease, the Blob service + creates a lease on the blob or container and returns it. If the + container has an active lease, you can only request a new lease + using the active lease ID as , but you can + specify a new . + + For more information, see . + + + Specifies the duration of the lease, in seconds, or specify + for a lease that never expires. + A non-infinite lease can be between 15 and 60 seconds. + A lease duration cannot be changed using + or . + + + Optional to add + conditions on acquiring a lease. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the lease. + + + A will be thrown if + a failure occurs. + + + + + The operation acquires a lease on + the blob or container. The lease must + be between 15 to 60 seconds, or infinite (-1). + + If the container does not have an active lease, the Blob service + creates a lease on the blob or container and returns it. If the + container has an active lease, you can only request a new lease + using the active lease ID as , but you can + specify a new . + + For more information, see + + Lease Container. + + + Specifies the duration of the lease, in seconds, or specify + for a lease that never expires. + A non-infinite lease can be between 15 and 60 seconds. + A lease duration cannot be changed using + or . + + + Optional to add + conditions on acquiring a lease. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the lease. + + + A will be thrown if + a failure occurs. + + + + + The operation renews the blob or + container's previously-acquired lease. + + The lease can be renewed if the leaseId + matches that associated with the blob or container. Note that the] + lease may be renewed even if it has expired as long as the blob or + container has not been leased again since the expiration of that + lease. When you renew a lease, the lease duration clock resets. + + For more information, see + + Lease Container. + + + Optional to add + conditions on renewing a lease. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the lease. + + + A will be thrown if + a failure occurs. + + + + + The operation renews the blob or + container's previously-acquired lease. + + The lease can be renewed if the leaseId + matches that associated with the blob or container. Note that the] + lease may be renewed even if it has expired as long as the blob or + container has not been leased again since the expiration of that + lease. When you renew a lease, the lease duration clock resets. + + For more information, see + + Lease Container. + + + Optional to add + conditions on renewing a lease. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the lease. + + + A will be thrown if + a failure occurs. + + + + + The operation releases the + container or blob's previously-acquired lease. + + The lease may be released if the + matches that associated with the container or blob. Releasing the + lease allows another client to immediately acquire the lease for the + container or blob as soon as the release is complete. + + For more information, see + + Lease Container. + + + Optional to add + conditions on releasing a lease. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + updated blob or container. + + + A will be thrown if + a failure occurs. + + + + + The operation releases the + container or blob's previously-acquired lease. + + The lease may be released if the + matches that associated with the container or blob. Releasing the + lease allows another client to immediately acquire the lease for the + container or blob as soon as the release is complete. + + For more information, see + + Lease Container. + + + Optional to add + conditions on releasing a lease. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + updated blob or container. + + + A will be thrown if + a failure occurs. + + + + + The operation releases the + container or blob's previously-acquired lease. + + The lease may be released if the + matches that associated with the container or blob. Releasing the + lease allows another client to immediately acquire the lease for the + container or blob as soon as the release is complete. + + For more information, see + + Lease Container. + + + Optional to add + conditions on releasing a lease. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + updated blob or container. + + + A will be thrown if + a failure occurs. + + + + + The operation changes the lease + of an active lease. A change must include the current + and a new . + + For more information, see + + Lease Container. + + + An optional proposed lease ID, in a GUID string format. A + will be thrown if the + proposed lease ID is not in the correct format. + + + Optional to add + conditions on changing a lease. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the lease. + + + A will be thrown if + a failure occurs. + + + + + The operation changes the lease + of an active lease. A change must include the current + and a new . + + For more information, see + + Lease Container. + + + An optional proposed lease ID, in a GUID string format. A + will be thrown if the + proposed lease ID is not in the correct format. + + + Optional to add + conditions on changing a lease. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the lease. + + + A will be thrown if + a failure occurs. + + + + + The operation breaks the blob or + container's previously-acquired lease (if it exists). + + Once a lease is broken, it cannot be renewed. Any authorized + request can break the lease; the request is not required to + specify a matching lease ID. When a lease is broken, the lease + break is allowed to elapse, + during which time no lease operation except + + and can be + performed on the blob or container. When a lease is successfully + broken, the response indicates the interval in seconds until a new + lease can be acquired. + + A lease that has been broken can also be released. A client can + immediately acquire a blob or container lease that has been + released. + + For more information, see + + Lease Container. + + + Specifies the proposed duration the lease should continue before + it is broken, in seconds, between 0 and 60. This break period is + only used if it is shorter than the time remaining on the lease. + If longer, the time remaining on the lease is used. A new lease + will not be available before the break period has expired, but the + lease may be held for longer than the break period. If this value + is not provided, a fixed-duration lease breaks after the remaining + lease period elapses, and an infinite lease breaks immediately. + + + Optional to add + conditions on breaking a lease. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the broken lease. + + + A will be thrown if + a failure occurs. + + + + + The operation breaks the blob or + container's previously-acquired lease (if it exists). + + Once a lease is broken, it cannot be renewed. Any authorized + request can break the lease; the request is not required to + specify a matching lease ID. When a lease is broken, the lease + break is allowed to elapse, + during which time no lease operation except + + and can be + performed on the blob or container. When a lease is successfully + broken, the response indicates the interval in seconds until a new + lease can be acquired. + + A lease that has been broken can also be released. A client can + immediately acquire a blob or container lease that has been + released. + + For more information, see + + Lease Container. + + + Specifies the proposed duration the lease should continue before + it is broken, in seconds, between 0 and 60. This break period is + only used if it is shorter than the time remaining on the lease. + If longer, the time remaining on the lease is used. A new lease + will not be available before the break period has expired, but the + lease may be held for longer than the break period. If this value + is not provided, a fixed-duration lease breaks after the remaining + lease period elapses, and an infinite lease breaks immediately. + + + Optional to add + conditions on breaking a lease. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the broken lease. + + + A will be thrown if + a failure occurs. + + + + + The allows you to manipulate Azure + Storage block blobs. + + Block blobs let you upload large blobs efficiently. Block blobs are + comprised of blocks, each of which is identified by a block ID. You + create or modify a block blob by writing a set of blocks and + committing them by their block IDs. Each block can be a different + size, up to a maximum of 4,000 MB (100 MB for requests using REST + versions before 2019-12-12 and 4 MB for requests using REST versions + before 2016-05-31), and a block blob can include up to 50,000 blocks. + The maximum size of a block blob is therefore approximately 190.73 TiB + (4,000 MB X 50,000 blocks). If you are writing a block blob that is + no more than 5,000 MB in size, you can upload it in its entirety with a + single write operation; see . + + When you upload a block to a blob in your storage account, it is + associated with the specified block blob, but it does not become part + of the blob until you commit a list of blocks that includes the new + block's ID. New blocks remain in an uncommitted state until they are + specifically committed or discarded. Writing a block does not update + the last modified time of an existing blob. + + Block blobs include features that help you manage large files over + networks. With a block blob, you can upload multiple blocks in + parallel to decrease upload time. Each block can include an MD5 hash + to verify the transfer, so you can track upload progress and re-send + blocks as needed.You can upload blocks in any order, and determine + their sequence in the final block list commitment step. You can also + upload a new block to replace an existing uncommitted block of the + same block ID. You have one week to commit blocks to a blob before + they are discarded. All uncommitted blocks are also discarded when a + block list commitment operation occurs but does not include them. + + You can modify an existing block blob by inserting, replacing, or + deleting existing blocks. After uploading the block or blocks that + have changed, you can commit a new version of the blob by committing + the new blocks with the existing blocks you want to keep using a + single commit operation. To insert the same range of bytes in two + different locations of the committed blob, you can commit the same + block in two places within the same commit operation.For any commit + operation, if any block is not found, the entire commitment operation + fails with an error, and the blob is not modified. Any block commitment + overwrites the blob’s existing properties and metadata, and discards + all uncommitted blocks. + + Block IDs are strings of equal length within a blob. Block client code + usually uses base-64 encoding to normalize strings into equal lengths. + When using base-64 encoding, the pre-encoded string must be 64 bytes + or less. Block ID values can be duplicated in different blobs. A + blob can have up to 100,000 uncommitted blocks, with a max total size + of appoximately 381.46 TiB (4,000 MB x 100,000 blocks) + + If you write a block for a blob that does not exist, a new block blob + is created, with a length of zero bytes. This blob will appear in + blob lists that include uncommitted blobs. If you don’t commit any + block to this blob, it and its uncommitted blocks will be discarded + one week after the last successful block upload. All uncommitted + blocks are also discarded when a new blob of the same name is created + using a single step(rather than the two-step block upload-then-commit + process). + + + + + Gets the maximum number of bytes that can be sent in a call + to . Supported value is now larger + than ; please use + . + + + + + Gets the maximum number of bytes that can be sent in a call + to . + + + + + Gets the maximum number of bytes that can be sent in a call + to . Supported value is now larger + than ; please use + . + + + + + Gets the maximum number of bytes that can be sent in a call + to . + + + + + Gets the maximum number of blocks allowed in a block blob. + + + + + Initializes a new instance of the + class for mocking. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, + + Configure Azure Storage connection strings + + + The name of the container containing this block blob. + + + The name of this block blob. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, + + Configure Azure Storage connection strings + + + The name of the container containing this block blob. + + + The name of this block blob. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the block blob that includes the + name of the account, the name of the container, and the name of + the blob. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + + + The shared key credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + Must not contain shared access signature, which should be passed in the second parameter. + + + The shared access signature credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + This constructor should only be used when shared access signature needs to be updated during lifespan of this client. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + + + The token credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the block blob that includes the + name of the account, the name of the container, and the name of + the blob. + + + The transport pipeline used to send every request. + + + The shared key credential used to sign requests. + + + The version of the service to use when sending requests. + + Client diagnostics. + Customer provided key. + Encryption scope. + + + + Initializes a new instance of the + class. + + + A referencing the block blob that includes the + name of the account, the name of the container, and the name of + the blob. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + The transport pipeline used to send every request. + + + New instanc of the class. + + + + + Initializes a new instance of the + class with an identical source but the specified + timestamp. + + For more information, see + + Create a snapshot of a blob. + + The snapshot identifier. + A new instance. + + Pass null or empty string to remove the snapshot returning a URL + to the base blob. + + + + + Initializes a new instance of the + class with an identical source but the specified + timestamp. + + + The version identifier. + A new instance. + + Pass null or empty string to remove the snapshot returning a URL + to the base blob. + + + + + Creates a new instance of the class + with an identical source but the specified + timestamp. + + The snapshot identifier. + A new instance. + + + + The + operation creates a new block blob, or updates the content of an existing block blob. + Updating an existing block blob overwrites any existing metadata on the blob. + + Partial updates are not supported with ; + the content of the existing blob is overwritten with the content + of the new blob. To perform a partial update of the content of a + block blob, use the and + operations. + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new block blob, or updates the content of an existing block blob. + Updating an existing block blob overwrites any existing metadata on the blob. + + Partial updates are not supported with ; + the content of the existing blob is overwritten with the content + of the new blob. To perform a partial update of the content of a + block blob, use the and + operations. + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new block blob, or updates the content of an existing block blob. Updating an + existing block blob overwrites any existing metadata on the blob. + + Partial updates are not supported with ; + the content of the existing blob is overwritten with the content + of the new blob. To perform a partial update of the content of a + block blob, use the and + operations. + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Optional standard HTTP header properties that can be set for the + block blob. + + + Optional custom metadata to set for this block blob. + + + Optional to add + conditions on the creation of this new block blob. + + + Optional + Indicates the tier to be set on the blob. + + + Optional to provide + progress updates about data transfers. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new block blob, or updates the content of an existing block blob. Updating an + existing block blob overwrites any existing metadata on the blob. + + Partial updates are not supported with ; + the content of the existing blob is overwritten with the content + of the new blob. To perform a partial update of the content of a + block blob, use the and + operations. + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Optional standard HTTP header properties that can be set for the + block blob. + + + Optional custom metadata to set for this block blob. + + + Optional to add + conditions on the creation of this new block blob. + + + Optional + Indicates the tier to be set on the blob. + + + Optional to provide + progress updates about data transfers. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new block blob, + or updates the content of an existing block blob. Updating an + existing block blob overwrites any existing metadata on the blob. + + Partial updates are not supported with ; + the content of the existing blob is overwritten with the content + of the new blob. To perform a partial update of the content of a + block blob, use the and + operations. + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Optional standard HTTP header properties that can be set for the + block blob. + + + Optional custom metadata to set for this block blob. + + + Optional tags to set for this block blob. + + + Optional to add + conditions on the creation of this new block blob. + + + Optional + Indicates the tier to be set on the blob. + + + Optional to provide + progress updates about data transfers. + + + The name of the calling operation. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new block as + part of a block blob's "staging area" to be eventually committed + via the operation. + + For more information, see + + Put Block. + + + A valid Base64 string value that identifies the block. Prior to + encoding, the string must be less than or equal to 64 bytes in + size. + + For a given blob, the length of the value specified for the + blockid parameter must be the same size for each block. Note that + the Base64 string must be URL-encoded. + + + A containing the content to upload. + + + An optional MD5 hash of the block . + This hash is used to verify the integrity of the block during + transport. When this value is specified, the storage service + compares the hash of the content that has arrived with this value. + Note that this MD5 hash is not stored with the blob. If the two + hashes do not match, the operation will throw a + . + + + Optional to add + conditions on the upload of this block. + + + Optional to provide + progress updates about data transfers. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new block as + part of a block blob's "staging area" to be eventually committed + via the operation. + + For more information, see + + Put Block. + + + A valid Base64 string value that identifies the block. Prior to + encoding, the string must be less than or equal to 64 bytes in + size. + + For a given blob, the length of the value specified for the + blockid parameter must be the same size for each block. Note that + the Base64 string must be URL-encoded. + + + A containing the content to upload. + + + An optional MD5 hash of the block . + This hash is used to verify the integrity of the block during + transport. When this value is specified, the storage service + compares the hash of the content that has arrived with this value. + Note that this MD5 hash is not stored with the blob. If the two + hashes do not match, the operation will throw a + . + + + Optional to add + conditions on the upload of this block. + + + Optional to provide + progress updates about data transfers. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new block + as part of a block blob's "staging area" to be eventually committed + via the operation. + + For more information, see + + Put Block. + + + A valid Base64 string value that identifies the block. Prior to + encoding, the string must be less than or equal to 64 bytes in + size. + + For a given blob, the length of the value specified for the + blockid parameter must be the same size for each block. Note that + the Base64 string must be URL-encoded. + + + A containing the content to upload. + + + An optional MD5 hash of the block . + This hash is used to verify the integrity of the block during + transport. When this value is specified, the storage service + compares the hash of the content that has arrived with this value. + Note that this MD5 hash is not stored with the blob. If the two + hashes do not match, the operation will throw a + . + + + Optional to add + conditions on the upload of this block. + + + Optional to provide + progress updates about data transfers. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new + block to be committed as part of a blob where the contents are + read from the . + + For more information, see + + Put Block From URL. + + + Specifies the of the source blob. The value may + be a URL of up to 2 KB in length that specifies a blob. The + source blob must either be public or must be authenticated via a + shared access signature. If the source blob is public, no + authentication is required to perform the operation. + + + A valid Base64 string value that identifies the block. Prior to + encoding, the string must be less than or equal to 64 bytes in + size. For a given blob, the length of the value specified for + the parameter must be the same + size for each block. Note that the Base64 string must be + URL-encoded. + + + Optionally uploads only the bytes of the blob in the + in the specified range. If this is + not specified, the entire source blob contents are uploaded as a + single block. + + + Optional MD5 hash of the block content from the + . This hash is used to verify the + integrity of the block during transport of the data from the Uri. + When this hash is specified, the storage service compares the hash + of the content that has arrived from the + with this value. Note that this md5 hash is not stored with the + blob. If the two hashes do not match, the operation will fail + with a . + + + Optional to add + conditions on the copying of data from this source blob. + + + Optional to add + conditions on the staging of this block. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new + block to be committed as part of a blob where the contents are + read from the . + + For more information, see + + Put Block From URL. + + + Specifies the of the source blob. The value may + be a URL of up to 2 KB in length that specifies a blob. The + source blob must either be public or must be authenticated via a + shared access signature. If the source blob is public, no + authentication is required to perform the operation. + + + A valid Base64 string value that identifies the block. Prior to + encoding, the string must be less than or equal to 64 bytes in + size. For a given blob, the length of the value specified for + the parameter must be the same + size for each block. Note that the Base64 string must be + URL-encoded. + + + Optionally uploads only the bytes of the blob in the + in the specified range. If this is + not specified, the entire source blob contents are uploaded as a + single block. + + + Optional MD5 hash of the block content from the + . This hash is used to verify the + integrity of the block during transport of the data from the Uri. + When this hash is specified, the storage service compares the hash + of the content that has arrived from the + with this value. Note that this md5 hash is not stored with the + blob. If the two hashes do not match, the operation will fail + with a . + + + Optional to add + conditions on the copying of data from this source blob. + + + Optional to add + conditions on the staging of this block. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block. + + + A will be thrown if + a failure occurs. + + + + + The + operation writes a blob by specifying the list of block IDs that make up the blob. In order + to be written as part of a blob, a block must have been + successfully written to the server in a prior + operation. You can call + to update a blob by uploading only those blocks that have changed, + then committing the new and existing blocks together. You can do + this by specifying whether to commit a block from the committed + block list or from the uncommitted block list, or to commit the + most recently uploaded version of the block, whichever list it + may belong to. Any blocks not specified in the block list and + permanently deleted. + + For more information, see + + Put Block List. + + + Specify the Uncommitted Base64 encoded block IDs to indicate that + the blob service should search only the uncommitted block list for + the named blocks. If the block is not found in the uncommitted + block list, it will not be written as part of the blob, and a + will be thrown. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation writes a blob by specifying the list of block IDs that make up the blob. + In order to be written as part of a blob, a block must have been + successfully written to the server in a prior + operation. You can call + to update a blob by uploading only those blocks that have changed, + then committing the new and existing blocks together. You can do + this by specifying whether to commit a block from the committed + block list or from the uncommitted block list, or to commit the + most recently uploaded version of the block, whichever list it + may belong to. Any blocks not specified in the block list and + permanently deleted. + + For more information, see + + Put Block List. + + + Specify the Uncommitted Base64 encoded block IDs to indicate that + the blob service should search only the uncommitted block list for + the named blocks. If the block is not found in the uncommitted + block list, it will not be written as part of the blob, and a + will be thrown. + + + Optional standard HTTP header properties that can be set for the + block blob. + + + Optional custom metadata to set for this block blob. + + + Optional to add + conditions on committing this block list. + + + Optional + Indicates the tier to be set on the blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation writes a blob by specifying the list of block IDs that make up the blob. In order + to be written as part of a blob, a block must have been + successfully written to the server in a prior + operation. You can call + to update a blob by uploading only those blocks that have changed, + then committing the new and existing blocks together. You can do + this by specifying whether to commit a block from the committed + block list or from the uncommitted block list, or to commit the + most recently uploaded version of the block, whichever list it + may belong to. Any blocks not specified in the block list and + permanently deleted. + + For more information, see + + Put Block List. + + + Specify the Uncommitted Base64 encoded block IDs to indicate that + the blob service should search only the uncommitted block list for + the named blocks. If the block is not found in the uncommitted + block list, it will not be written as part of the blob, and a + will be thrown. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation writes a blob bys pecifying the list of block IDs that make up the blob. + In order to be written as part of a blob, a block must have been + successfully written to the server in a prior + operation. You can call + to update a blob by uploading only those blocks that have changed, + then committing the new and existing blocks together. You can do + this by specifying whether to commit a block from the committed + block list or from the uncommitted block list, or to commit the + most recently uploaded version of the block, whichever list it + may belong to. Any blocks not specified in the block list and + permanently deleted. + + For more information, see + + Put Block List. + + + Specify the Uncommitted Base64 encoded block IDs to indicate that + the blob service should search only the uncommitted block list for + the named blocks. If the block is not found in the uncommitted + block list, it will not be written as part of the blob, and a + will be thrown. + + + Optional standard HTTP header properties that can be set for the + block blob. + + + Optional custom metadata to set for this block blob. + + + Optional to add + conditions on committing this block list. + + + Optional + Indicates the tier to be set on the blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation writes a blob by + specifying the list of block IDs that make up the blob. In order + to be written as part of a blob, a block must have been + successfully written to the server in a prior + operation. You can call to + update a blob by uploading only those blocks that have changed, + then committing the new and existing blocks together. You can do + this by specifying whether to commit a block from the committed + block list or from the uncommitted block list, or to commit the + most recently uploaded version of the block, whichever list it + may belong to. Any blocks not specified in the block list and + permanently deleted. + + For more information, see + + Put Block List. + + + Specify the Uncommitted Base64 encoded block IDs to indicate that + the blob service should search only the uncommitted block list for + the named blocks. If the block is not found in the uncommitted + block list, it will not be written as part of the blob, and a + will be thrown. + + + Optional standard HTTP header properties that can be set for the + block blob. + + + Optional custom metadata to set for this block blob. + + + Optional tags to set for this block blob. + + + Optional to add + conditions on committing this block list. + + + Optional + Indicates the tier to be set on the blob. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation operation retrieves + the list of blocks that have been uploaded as part of a block blob. + There are two block lists maintained for a blob. The Committed + Block list has blocks that have been successfully committed to a + given blob with . + The Uncommitted Block list has blocks that have been uploaded for a + blob using , but that have not yet + been committed. These blocks are stored in Azure in association + with a blob, but do not yet form part of the blob. + + + Specifies whether to return the list of committed blocks, the + list of uncommitted blocks, or both lists together. If you omit + this parameter, Get Block List returns the list of committed blocks. + + + Optionally specifies the blob snapshot to retrieve the block list + from. For more information on working with blob snapshots, see + + Create a snapshot of a blob. + + + Optional to add + conditions on retrieving the block list. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing requested + block list. + + + A will be thrown if + a failure occurs. + + + + + The operation operation retrieves + the list of blocks that have been uploaded as part of a block blob. + There are two block lists maintained for a blob. The Committed + Block list has blocks that have been successfully committed to a + given blob with . + The Uncommitted Block list has blocks that have been uploaded for a + blob using , but that have not yet + been committed. These blocks are stored in Azure in association + with a blob, but do not yet form part of the blob. + + + Specifies whether to return the list of committed blocks, the + list of uncommitted blocks, or both lists together. If you omit + this parameter, Get Block List returns the list of committed blocks. + + + Optionally specifies the blob snapshot to retrieve the block list + from. For more information on working with blob snapshots, see + + Create a snapshot of a blob. + + + Optional to add + conditions on retrieving the block list. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing requested + block list. + + + A will be thrown if + a failure occurs. + + + + + The API returns the + result of a query against the blob. + + For more information, see + + Query Blob Contents. + + + The query. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A will be thrown if + a failure occurs. + + + A . + + + + + The API returns the + result of a query against the blob. + + For more information, see + + Query Blob Contents. + + + The query. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A will be thrown if + a failure occurs. + + + A . + + + + + Opens a stream for writing to the blob. + + + Whether an existing blob should be deleted and recreated. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A stream to write to the Append Blob. + + + A will be thrown if + a failure occurs. + + + + + Opens a stream for writing to the blob. If the blob exists, + it will be overwritten. + + + Whether an existing blob should be deleted and recreated. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A stream to write to the Append Blob. + + + A will be thrown if + a failure occurs. + + + + + The Upload from Uri operation creates a new Block Blob where the contents of the + blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. + + Partial updates are not supported with Put Blob from URL; the content of an existing blob is + overwritten with the content of the new blob. To perform partial updates to a block blob’s + contents using a source URL, use the Put Block from URL API in conjunction with Put Block List. + + + Required. Specifies the URL of the source blob. The source blob may be of any type, + including a block blob, append blob, or page blob. The value may be a URL of up to 2 + KiB in length that specifies a blob. The value should be URL-encoded as it would appear + in a request URI. The source blob must either be public or must be authorized via a + shared access signature. If the source blob is public, no authorization is required + to perform the operation. + + + Whether the upload should overwrite the existing blob. The + default value is false. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The Upload from Uri operation creates a new Block Blob where the contents of the + blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. + + Partial updates are not supported with Put Blob from URL; the content of an existing blob is + overwritten with the content of the new blob. To perform partial updates to a block blob’s + contents using a source URL, use the Put Block from URL API in conjunction with Put Block List. + + + Required. Specifies the URL of the source blob. The source blob may be of any type, + including a block blob, append blob, or page blob. The value may be a URL of up to 2 + KiB in length that specifies a blob. The value should be URL-encoded as it would appear + in a request URI. The source blob must either be public or must be authorized via a + shared access signature. If the source blob is public, no authorization is required + to perform the operation. + + + Whether the upload should overwrite the existing blob. The + default value is false. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The Upload from Uri operation creates a new Block Blob where the contents of the + blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. + + Partial updates are not supported with Put Blob from URL; the content of an existing blob is + overwritten with the content of the new blob. To perform partial updates to a block blob’s + contents using a source URL, use the Put Block from URL API in conjunction with Put Block List. + + + Required. Specifies the URL of the source blob. The source blob may be of any type, + including a block blob, append blob, or page blob. The value may be a URL of up to 2 + KiB in length that specifies a blob. The value should be URL-encoded as it would appear + in a request URI. The source blob must either be public or must be authorized via a + shared access signature. If the source blob is public, no authorization is required + to perform the operation. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The Upload from Uri operation creates a new Block Blob where the contents of the + blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. + + Partial updates are not supported with Put Blob from URL; the content of an existing blob is + overwritten with the content of the new blob. To perform partial updates to a block blob’s + contents using a source URL, use the Put Block from URL API in conjunction with Put Block List. + + + Required. Specifies the URL of the source blob. The source blob may be of any type, + including a block blob, append blob, or page blob. The value may be a URL of up to 2 + KiB in length that specifies a blob. The value should be URL-encoded as it would appear + in a request URI. The source blob must either be public or must be authorized via a + shared access signature. If the source blob is public, no authorization is required + to perform the operation. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The Upload from Uri operation creates a new Block Blob where the contents of the + blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. + + Partial updates are not supported with Put Blob from URL; the content of an existing blob is + overwritten with the content of the new blob. To perform partial updates to a block blob’s + contents using a source URL, use the Put Block from URL API in conjunction with Put Block List. + + + Required. Specifies the URL of the source blob. The source blob may be of any type, + including a block blob, append blob, or page blob. The value may be a URL of up to 2 + KiB in length that specifies a blob. The value should be URL-encoded as it would appear + in a request URI. The source blob must either be public or must be authorized via a + shared access signature. If the source blob is public, no authorization is required + to perform the operation. + + + Optional parameters. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The allows you to manipulate Azure + Storage page blobs. + + Page blobs are a collection of 512-byte pages optimized for random + read and write operations. To create a page blob, you initialize the + page blob and specify the maximum size the page blob will grow. To add + or update the contents of a page blob, you write a page or pages by + specifying an offset and a range that align to 512-byte page + boundaries. A write to a page blob can overwrite just one page, some + pages, or up to 4 MB of the page blob. Writes to page blobs happen + in-place and are immediately committed to the blob. The maximum size + for a page blob is 8 TB. + + + + + Gets the number of bytes in a page (512). + + + + + Gets the maximum number of bytes that can be sent in a call + to the operation. + + + + + Initializes a new instance of the + class for mocking. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information + + Configure Azure Storage connection strings + + + The name of the container containing this page blob. + + + The name of this page blob. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, + + Configure Azure Storage connection strings + + + The name of the container containing this page blob. + + + The name of this page blob. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the page blob that includes the + name of the account, the name of the blob container, and the name of + the blob. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the page blob that includes the + name of the account, the name of the blob container, and the name of + the blob. + + + The shared key credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the page blob that includes the + name of the account, the name of the blob container, and the name of + the blob. + Must not contain shared access signature, which should be passed in the second parameter. + + + The shared access signature credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + This constructor should only be used when shared access signature needs to be updated during lifespan of this client. + + + + + Initializes a new instance of the + class. + + + A referencing the page blob that includes the + name of the account, the name of the blob container, and the name of + the blob. + + + The token credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the page blob that includes the + name of the account, the name of the blob container, and the name of + the blob. + + + The transport pipeline used to send every request. + + + The shared key credential used to sign requests. + + + The version of the service to use when sending requests. + + Client diagnostics. + Customer provided key. + Encryption scope. + + + + Initializes a new instance of the + class with an identical source but the specified + snapshot timestamp. + + For more information, see + + Create a snapshot of a blob. + + The snapshot identifier. + A new instance. + + Pass null or empty string to remove the snapshot returning a URL + to the base blob. + + + + + Creates a new instance of the class + with an identical source but the specified + snapshot timestamp. + + The snapshot identifier. + A new instance. + + + + Creates a new PageBlobClient object identical to the source but with the specified version ID. + Pass "" to remove the version ID returning a URL to the base blob. + + version ID + + + + + The + operation creates a new page blob of the specified . + The content of any existing blob is overwritten with the newly initialized page blob + To add content to the page blob, call the + operation. + + For more information, see https://docs.microsoft.com/rest/api/storageservices/put-blob. + + + Specifies the maximum size for the page blob, up to 8 TB. The + size must be aligned to a 512-byte boundary. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + newly created page blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new page blob of the specified . + The content of any existing blob is overwritten with the newly initialized page blob + To add content to the page blob, call the + operation. + + For more information, see https://docs.microsoft.com/rest/api/storageservices/put-blob. + + + Specifies the maximum size for the page blob, up to 8 TB. The + size must be aligned to a 512-byte boundary. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + newly created page blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new page blob of the specified . The content of any + existing blob is overwritten with the newly initialized page blob + To add content to the page blob, call the + operation. + + For more information, see https://docs.microsoft.com/rest/api/storageservices/put-blob. + + + Specifies the maximum size for the page blob, up to 8 TB. The + size must be aligned to a 512-byte boundary. + + + Optional user-controlled value that you can use to track requests. + The value of the must be between + 0 and 2^63 - 1. The default value is 0. + + + Optional standard HTTP header properties that can be set for the + new page blob. + + + Optional custom metadata to set for this page blob. + + + Optional to add + conditions on the creation of this new page blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + newly created page blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new page blob of the specified . The content of any + existing blob is overwritten with the newly initialized page blob + To add content to the page blob, call the + operation. + + For more information, see https://docs.microsoft.com/rest/api/storageservices/put-blob. + + + Specifies the maximum size for the page blob, up to 8 TB. The + size must be aligned to a 512-byte boundary. + + + Optional user-controlled value that you can use to track requests. + The value of the must be between + 0 and 2^63 - 1. The default value is 0. + + + Optional standard HTTP header properties that can be set for the + new page blob. + + + Optional custom metadata to set for this page blob. + + + Optional to add + conditions on the creation of this new page blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + newly created page blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new page blob of the specified . If the blob already + exists, the content of the existing blob will remain unchanged. If the blob does not already exists, + a new page blob with the specified will be created. + operation. + + For more information, see https://docs.microsoft.com/rest/api/storageservices/put-blob. + + + Specifies the maximum size for the page blob, up to 8 TB. The + size must be aligned to a 512-byte boundary. + + + Optional parameters. + + /// + Optional to propagate + notifications that the operation should be cancelled. + + + If the page blob does not already exist, A + describing the newly created page blob. Otherwise, null. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new page blob of the specified . If the blob already + exists, the content of the existing blob will remain unchanged. If the blob does not already exists, + a new page blob with the specified will be created. + operation. + + For more information, see https://docs.microsoft.com/rest/api/storageservices/put-blob. + + + Specifies the maximum size for the page blob, up to 8 TB. The + size must be aligned to a 512-byte boundary. + + + Optional parameters. + + /// + Optional to propagate + notifications that the operation should be cancelled. + + + If the page blob does not already exist, A + describing the newly created page blob. Otherwise, null. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new page blob of the specified . If the blob already + exists, the content of the existing blob will remain unchanged. If the blob does not already exists, + a new page blob with the specified will be created. + operation. + + For more information, see https://docs.microsoft.com/rest/api/storageservices/put-blob. + + + Specifies the maximum size for the page blob, up to 8 TB. The + size must be aligned to a 512-byte boundary. + + + Optional user-controlled value that you can use to track requests. + The value of the must be between + 0 and 2^63 - 1. The default value is 0. + + + Optional standard HTTP header properties that can be set for the + new page blob. + + + Optional custom metadata to set for this page blob. + + /// + Optional to propagate + notifications that the operation should be cancelled. + + + If the page blob does not already exist, A + describing the newly created page blob. Otherwise, null. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new page blob of the specified . If the blob already exists, + the content of the existing blob will remain unchanged. If the blob does not already exists, + a new page blob with the specified will be created. + operation. + + For more information, see https://docs.microsoft.com/rest/api/storageservices/put-blob. + + + Specifies the maximum size for the page blob, up to 8 TB. The + size must be aligned to a 512-byte boundary. + + + Optional user-controlled value that you can use to track requests. + The value of the must be between + 0 and 2^63 - 1. The default value is 0. + + + Optional standard HTTP header properties that can be set for the + new page blob. + + + Optional custom metadata to set for this page blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + If the page blob does not already exist, A + describing the newly created page blob. Otherwise, null. + + + A will be thrown if + a failure occurs. + + + + + The operation writes + to a range of pages in a page blob, + starting at . + + For more information, see + + Put Page. + + + A containing the content of the pages to + upload. The content can be up to 4 MB in size. + + + Specifies the starting offset for the + to be written as a page. Given that pages must be aligned with + 512-byte boundaries, the start offset must be a modulus of 512. + + + Optional MD5 hash of the block content. This hash is used to + verify the integrity of the block during transport. When this hash + is specified, the storage service compares the hash of the content + that has arrived with this value. Note that this MD5 hash is not + stored with the blob. If the two hashes do not match, the + operation will fail with a . + + + Optional to add + conditions on uploading pages to this page blob. + + + Optional to provide + progress updates about data transfers. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated pages. + + + A will be thrown if + a failure occurs. + + + + + The operation writes + to a range of pages in a page blob, + starting at . + + For more information, see + + Put Page. + + + A containing the content of the pages to + upload. The content can be up to 4 MB in size. + + + Specifies the starting offset for the + to be written as a page. Given that pages must be aligned with + 512-byte boundaries, the start offset must be a modulus of 512. + + + Optional MD5 hash of the block content. This hash is used to + verify the integrity of the block during transport. When this hash + is specified, the storage service compares the hash of the content + that has arrived with this value. Note that this MD5 hash is not + stored with the blob. If the two hashes do not match, the + operation will fail with a . + + + Optional to add + conditions on uploading pages to this page blob. + + + Optional to provide + progress updates about data transfers. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated pages. + + + A will be thrown if + a failure occurs. + + + + + The operation writes + to a range of pages in a page blob, + starting at . + + For more information, see + + Put Page. + + + A containing the content of the pages to + upload. The content can be up to 4 MB in size. + + + Specifies the starting offset for the + to be written as a page. Given that pages must be aligned with + 512-byte boundaries, the start offset must be a modulus of 512. + + + Optional MD5 hash of the block content. This hash is used to + verify the integrity of the block during transport. When this hash + is specified, the storage service compares the hash of the content + that has arrived with this value. Note that this MD5 hash is not + stored with the blob. If the two hashes do not match, the + operation will fail with a . + + + Optional to add + conditions on uploading pages to this page blob. + + + Optional to provide + progress updates about data transfers. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated pages. + + + A will be thrown if + a failure occurs. + + + + + The operation clears one or more + pages from the page blob, as specificed by the . + + For more information, see + + Put Page. + + + Specifies the range of bytes to be cleared. Both the start and + end of the range must be specified. For a page clear operation, + the page range can be up to the value of the blob's full size. + Given that pages must be aligned with 512-byte boundaries, the + start of the range must be a modulus of 512 and the end of the + range must be a modulus of 512 – 1. Examples of valid byte ranges + are 0-511, 512-1023, etc. + + + Optional to add + conditions on clearing pages from this page blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated pages. + + + A will be thrown if + a failure occurs. + + + + + The operation clears one or more + pages from the page blob, as specificed by the . + + For more information, see + + Put Page. + + + Specifies the range of bytes to be cleared. Both the start and + end of the range must be specified. For a page clear operation, + the page range can be up to the value of the blob's full size. + Given that pages must be aligned with 512-byte boundaries, the + start of the range must be a modulus of 512 and the end of the + range must be a modulus of 512 – 1. Examples of valid byte ranges + are 0-511, 512-1023, etc. + + + Optional to add + conditions on clearing pages from this page blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated pages. + + + A will be thrown if + a failure occurs. + + + + + The operation returns the list of + valid page ranges for a page blob or snapshot of a page blob. + + For more information, see + + Get Page Ranges. + + + Optionally specifies the range of bytes over which to list ranges, + inclusively. If omitted, then all ranges for the blob are returned. + + + Optionally specifies the blob snapshot to retrieve page ranges + information from. For more information on working with blob snapshots, + + Create a snapshot of a blob. + + + Optional to add + conditions on getting page ranges for the this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + valid page ranges for this blob. + + + A will be thrown if + a failure occurs. + + + + + The operation returns the list of + valid page ranges for a page blob or snapshot of a page blob. + + For more information, see + + Get Page Ranges. + + + Optionally specifies the range of bytes over which to list ranges, + inclusively. If omitted, then all ranges for the blob are returned. + + + Optionally specifies the blob snapshot to retrieve page ranges + information from. For more information on working with blob snapshots, + + Create a snapshot of a blob. + + + Optional to add + conditions on getting page ranges for the this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + valid page ranges for this blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation returns the list of page ranges that differ between a + and this page blob. Changed pages + include both updated and cleared pages. + + For more information, see + + Get Page Ranges. + + + Optionally specifies the range of bytes over which to list ranges, + inclusively. If omitted, then all ranges for the blob are returned. + + + Optionally specifies the blob snapshot to retrieve page ranges + information from. For more information on working with blob snapshots, + + Create a snapshot of a blob. + + + Specifies that the response will contain only pages that were + changed between target blob and previous snapshot. Changed pages + include both updated and cleared pages. The target blob may be a + snapshot, as long as the snapshot specified by + is the older of the two. + + + Optional to add + conditions on getting page ranges for the this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + valid page ranges for this blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation returns the list of page ranges that differ between a + and this page blob. Changed pages + include both updated and cleared pages. + + For more information, see + + Get Page Ranges. + + + Optionally specifies the range of bytes over which to list ranges, + inclusively. If omitted, then all ranges for the blob are returned. + + + Optionally specifies the blob snapshot to retrieve page ranges + information from. For more information on working with blob snapshots, + + Create a snapshot of a blob. + + + Specifies that the response will contain only pages that were + changed between target blob and previous snapshot. Changed pages + include both updated and cleared pages. The target blob may be a + snapshot, as long as the snapshot specified by + is the older of the two. + + + Optional to add + conditions on getting page ranges for the this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + valid page ranges for this blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation returns the list of page ranges that differ between a + and this page blob. Changed pages + include both updated and cleared pages. This API only works with + managed disk storage accounts. + + For more information, see + + Get Page Ranges. + + + Optionally specifies the range of bytes over which to list ranges, + inclusively. If omitted, then all ranges for the blob are returned. + + + Optionally specifies the blob snapshot to retrieve page ranges + information from. For more information on working with blob snapshots, + + Create a snapshot of a blob. + + + This parameter only works with managed disk storage accounts. + Specifies that the response will contain only pages that were + changed between target blob and previous snapshot. Changed pages + include both updated and cleared pages. The target blob may be a + snapshot, as long as the snapshot specified by + is the older of the two. + + + Optional to add + conditions on getting page ranges for the this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + valid page ranges for this blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation returns the list of page ranges that differ between a + and this page blob. Changed pages + include both updated and cleared pages. This API only works with + managed disk storage accounts. + + For more information, see + + Get Page Ranges. + + + Optionally specifies the range of bytes over which to list ranges, + inclusively. If omitted, then all ranges for the blob are returned. + + + Optionally specifies the blob snapshot to retrieve page ranges + information from. For more information on working with blob snapshots, + + Create a snapshot of a blob. + + + This parameter only works with managed disk storage accounts. + Specifies that the response will contain only pages that were + changed between target blob and previous snapshot. Changed pages + include both updated and cleared pages. The target blob may be a + snapshot, as long as the snapshot specified by + is the older of the two. + + + Optional to add + conditions on getting page ranges for the this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + valid page ranges for this blob. + + + A will be thrown if + a failure occurs. + + + + + The operation resizes the page blob to + the specified size (which must be a multiple of 512). If the + specified value is less than the current size of the blob, then + all pages above the specified value are cleared. + + For more information, see + + Set Blob Properties. + + + Specifies the maximum size for the page blob, up to 8 TB. The + size must be aligned to a 512-byte boundary. If the specified + value is less than the current size of the blob, then all pages + above the specified value are cleared. + + + Optional to add + conditions on the resize of this page blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the resized + page blob. + + + A will be thrown if + a failure occurs. + + + + + The operation resizes the page blob to + the specified size (which must be a multiple of 512). If the + specified value is less than the current size of the blob, then + all pages above the specified value are cleared. + + For more information, see + + Set Blob Properties. + + + Specifies the maximum size for the page blob, up to 8 TB. The + size must be aligned to a 512-byte boundary. If the specified + value is less than the current size of the blob, then all pages + above the specified value are cleared. + + + Optional to add + conditions on the resize of this page blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the resized + page blob. + + + A will be thrown if + a failure occurs. + + + + + The operation changes the + sequence number and + for this page blob. + + For more information, see + + Set Blob Properties. + + + Specifies how the service should modify the blob's sequence number. + sets the sequence number to + be the higher of the value included with the request and the value + currently stored for the blob. + sets the sequence number to the + value. increments + the value of the sequence number by 1. If specifying + , do not include the + because that will throw a + . + + + An updated sequence number of your choosing, if + is + or . The value should + not be provided if is + . The sequence number + is a user-controlled property that you can use to track requests + and manage concurrency issues via . + + + Optional to add conditions + on updating the sequence number of this page blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the updated + page blob. + + + A will be thrown if + a failure occurs. + + + + + The operation changes the + sequence number and + for this page blob. + + For more information, see + + Set Blob Properties. + + + Specifies how the service should modify the blob's sequence number. + sets the sequence number to + be the higher of the value included with the request and the value + currently stored for the blob. + sets the sequence number to the + value. increments + the value of the sequence number by 1. If specifying + , do not include the + because that will throw a + . + + + An updated sequence number of your choosing, if + is + or . The value should + not be provided if is + . The sequence number + is a user-controlled property that you can use to track requests + and manage concurrency issues via . + + + Optional to add conditions + on updating the sequence number of this page blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the updated + page blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation starts copying a snapshot of the sourceUri page blob to + this page blob. The snapshot is copied such that only the + differential changes between the previously copied snapshot are + transferred to the destination. The copied snapshots are complete + copies of the original snapshot and can be read or copied from as + usual. You can check the + returned from the to + determine if the copy has completed. + + For more information, see + + Incremental Copy Blob and + + Back up Azure unmanaged VM disks with incremental snapshots. + + + Specifies the to the source page blob as a up to + 2 KB in length. The source blob must either be public or must be + authenticated via a shared access signature. + + + The name of a snapshot to start copying from + sourceUri. + + + Optional to add + conditions on the incremental copy into this page blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A referencing the incremental + copy operation. + + + A will be thrown if + a failure occurs. + + The destination of an incremental copy must either not exist, or + must have been created with a previous incremental copy from the + same source blob. Once created, the destination blob is + permanently associated with the source and may only be used for + incremental copies. + + The , + , and + + operations indicate whether the blob is an incremental copy blob + created in this way. Incremental copy blobs may not be downloaded + directly. The only supported operations are + , + , + and . The copied snapshots may + be read and deleted as usual. + + An incremental copy is performed asynchronously on the service and + must be polled for completion. You can poll + and check + to determine when the copy + has completed. When the copy completes, the destination blob will + contain a new snapshot. The + operation returns the snapshot time of the newly created snapshot. + + The first time an incremental copy is performed on a destination + blob, a new blob is created with a snapshot that is fully copied + from the source. Each subsequent call to + will create a new snapshot by copying only the differential + changes from the previously copied snapshot. The differential + changes are computed on the server by issuing a + call on the source blob snapshot with prevSnapshot set to the most + recently copied snapshot. Therefore, the same restrictions on + apply to + . + Specifically, snapshots must be copied in ascending order and if + the source blob is recreated using or + + then + on new snapshots will fail. + + The additional storage space consumed by the copied snapshot is + the size of the differential data transferred during the copy. + This can be determined by performing a + + call on the snapshot to compare it to the previous snapshot. + + + + + The + operation starts copying a snapshot of the sourceUri page blob to + this page blob. The snapshot is copied such that only the + differential changes between the previously copied snapshot are + transferred to the destination. The copied snapshots are complete + copies of the original snapshot and can be read or copied from as + usual. You can check the + returned from the + to determine if thecopy has completed. + + For more information, see + + Incremental Copy Blob and + + Back up Azure unmanaged VM disks with incremental snapshots. + + + Specifies the to the source page blob as a up to + 2 KB in length. The source blob must either be public or must be + authenticated via a shared access signature. + + + The name of a snapshot to start copying from + sourceUri. + + + Optional to add + conditions on the incremental copy into this page blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the incremental copy operation. + + + A will be thrown if + a failure occurs. + + The destination of an incremental copy must either not exist, or + must have been created with a previous incremental copy from the + same source blob. Once created, the destination blob is + permanently associated with the source and may only be used for + incremental copies. + + The , + , and + + operations indicate whether the blob is an incremental copy blob + created in this way. Incremental copy blobs may not be downloaded + directly. The only supported operations are + , + , + and . The copied + snapshots may be read and deleted as usual. + + An incremental copy is performed asynchronously on the service and + must be polled for completion. You can poll + and check + to determine when the copy + has completed. When the copy completes, the destination blob will + contain a new snapshot. The + operation returns the snapshot time of the newly created snapshot. + + The first time an incremental copy is performed on a destination + blob, a new blob is created with a snapshot that is fully copied + from the source. Each subsequent call to + will create a new snapshot by copying only the differential + changes from the previously copied snapshot. The differential + changes are computed on the server by issuing a + call on the source blob snapshot with prevSnapshot set to the most + recently copied snapshot. Therefore, the same restrictions on + apply to + . + Specifically, snapshots must be copied in ascending order and if + the source blob is recreated using or + + then + on new snapshots will fail. + + The additional storage space consumed by the copied snapshot is + the size of the differential data transferred during the copy. + This can be determined by performing a + + call on the snapshot to compare it to the previous snapshot. + + + + + The operation writes a range + of pages to a page blob where the contents are read from + sourceUri. + + For more information, see + + Put Page From URL. + + + Specifies the of the source blob. The value may + be a of up to 2 KB in length that specifies a + blob. The source blob must either be public or must be + authenticated via a shared access signature. If the source blob + is public, no authentication is required to perform the operation. + + + Optionally only upload the bytes of the blob in the + sourceUri in the specified range. + + + Specifies the range to be written as a page. Both the start and + end of the range must be specified and can be up to 4MB in size. + Given that pages must be aligned with 512-byte boundaries, the + start of the range must be a modulus of 512 and the end of the + range must be a modulus of 512 – 1. Examples of valid byte ranges + are 0-511, 512-1023, etc. + + + Optional MD5 hash of the page block content from the + sourceUri. This hash is used to verify the + integrity of the block during transport of the data from the Uri. + When this hash is specified, the storage service compares the hash + of the content that has arrived from the sourceUri + with this value. Note that this md5 hash is not stored with the + blob. If the two hashes do not match, the operation will fail + with a . + + + Optional to add + conditions on the copying of data to this page blob. + + + Optional to add + conditions on the copying of data from this source blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated pages. + + + A will be thrown if + a failure occurs. + + + + + The operation writes a range + of pages to a page blob where the contents are read from + sourceUri. + + For more information, see + + Put Page From URL. + + + Specifies the of the source blob. The value may + be a of up to 2 KB in length that specifies a + blob. The source blob must either be public or must be + authenticated via a shared access signature. If the source blob + is public, no authentication is required to perform the operation. + + + Optionally only upload the bytes of the blob in the + sourceUri in the specified range. + + + Specifies the range to be written as a page. Both the start and + end of the range must be specified and can be up to 4MB in size. + Given that pages must be aligned with 512-byte boundaries, the + start of the range must be a modulus of 512 and the end of the + range must be a modulus of 512 – 1. Examples of valid byte ranges + are 0-511, 512-1023, etc. + + + Optional MD5 hash of the page block content from the + sourceUri. This hash is used to verify the + integrity of the block during transport of the data from the Uri. + When this hash is specified, the storage service compares the hash + of the content that has arrived from the sourceUri + with this value. Note that this md5 hash is not stored with the + blob. If the two hashes do not match, the operation will fail + with a . + + + Optional to add + conditions on the copying of data to this page blob. + + + Optional to add + conditions on the copying of data from this source blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated pages. + + + A will be thrown if + a failure occurs. + + + + + Opens a stream for writing to the blob. + + + Whether an existing blob should be deleted and recreated. + + + The offset within the blob to begin writing from. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A stream to write to the Append Blob. + + + A will be thrown if + a failure occurs. + + + + + Opens a stream for writing to the blob. + + + Whether an existing blob should be deleted and recreated. + + + The offset within the blob to begin writing from. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A stream to write to the Append Blob. + + + A will be thrown if + a failure occurs. + + + + + Provides advanced client configuration options for connecting to Azure Blob + Storage. + + + + + Initializes a new instance of the + class. + + + The of the service API used when + making requests. + + + + + Settings for data encryption when uploading and downloading with a . + Client-side encryption adds metadata to your blob which is necessary for decryption. + + For more information, see . + + + + + The allows you to manipulate Azure Storage + blobs. + + + + + Initializes a new instance of the + class for mocking. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, + + Configure Azure Storage connection strings. + + + The name of the container containing this blob. + + + The name of this blob. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, + + Configure Azure Storage connection strings. + + + The name of the container containing this blob. + + + The name of this blob. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + The shared key credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + Must not contain shared access signature, which should be passed in the second parameter. + + + The shared access signature credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + This constructor should only be used when shared access signature needs to be updated during lifespan of this client. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + The token credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob that includes the + name of the account, the name of the container, and the name of + the blob. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". + + + The transport pipeline used to send every request. + + + The shared key credential used to sign requests. + + + The version of the service to use when sending requests. + + Client diagnostics. + Customer provided key. + Client-side encryption options. + Encryption scope. + + + + Initializes a new instance of the + class with an identical source but the specified + timestamp. + + For more information, see . + + The snapshot identifier. + A new instance. + + Pass null or empty string to remove the snapshot returning a URL + to the base blob. + + + + + Initializes a new instance of the + class with an identical source but the specified + timestamp. + + + The version identifier. + A new instance. + + Pass null or empty string to remove the version returning a URL + to the base blob. + + + + + Creates a new instance of the class, maintaining all the same + internals but specifying new . + + New encryption options. Setting this to default will clear client-side encryption. + New instance with provided options and same internals otherwise. + + + + The operation creates a new block blob + or updates the content of an existing block blob. Updating an + existing block blob overwrites any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new block blob + or updates the content of an existing block blob. Updating an + existing block blob overwrites any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A file path containing the content to upload. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new block blob + or updates the content of an existing block blob. Updating an + existing block blob overwrites any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new block blob + or updates the content of an existing block blob. Updating an + existing block blob overwrites any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A file path containing the content to upload. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation + creates a new block blob or updates the content of an existing + block blob. Updating an existing block blob overwrites any + existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation + creates a new block blob or updates the content of an existing + block blob. Updating an existing block blob overwrites any + existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A file path containing the content to upload. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation + creates a new block blob or updates the content of an existing + block blob. Updating an existing block blob overwrites any + existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation + creates a new block blob or updates the content of an existing + block blob. Updating an existing block blob overwrites any + existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A file path containing the content to upload. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation + creates a new block blob or updates the content of an existing + block blob. Updating an existing block blob overwrites any + existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Whether the upload should overwrite any existing blobs. The + default value is false. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation + creates a new block blob or updates the content of an existing + block blob. Updating an existing block blob overwrites any + existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A file path containing the content to upload. + + + Whether the upload should overwrite any existing blobs. The + default value is false. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation + creates a new block blob or updates the content of an existing + block blob. Updating an existing block blob overwrites any + existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Whether the upload should overwrite any existing blobs. The + default value is false. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The operation + creates a new block blob or updates the content of an existing + block blob. Updating an existing block blob overwrites any + existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A file path containing the content to upload. + + + Whether the upload should overwrite any existing blobs. The + default value is false. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new block blob or updates the content of an + existing block blob. Updating an existing block blob overwrites + any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new block blob or updates the content of an + existing block blob. Updating an existing block blob overwrites + any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, + + Put Blob. + + + A containing the content to upload. + + + Optional standard HTTP header properties that can be set for the + block blob. + + + Optional custom metadata to set for this block blob. + + + Optional to add conditions on + the creation of this new block blob. + + + Optional to provide + progress updates about data transfers. + + + Optional + Indicates the tier to be set on the blob. + + + Optional to configure + parallel transfer behavior. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new block blob or updates the content of an + existing block blob. Updating an existing block blob overwrites + any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A file path containing the content to upload. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new block blob or updates the content of an + existing block blob. Updating an existing block blob overwrites + any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A file path containing the content to upload. + + + Optional standard HTTP header properties that can be set for the + block blob. + + + Optional custom metadata to set for this block blob. + + + Optional to add conditions on + the creation of this new block blob. + + + Optional to provide + progress updates about data transfers. + + + Optional + Indicates the tier to be set on the blob. + + + Optional to configure + parallel transfer behavior. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new block blob or updates the content of an + existing block blob. Updating an existing block blob overwrites + any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new block blob or updates the content of an + existing block blob. Updating an existing block blob overwrites + any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A containing the content to upload. + + + Optional standard HTTP header properties that can be set for the + block blob. + + + Optional custom metadata to set for this block blob. + + + Optional to add conditions on + the creation of this new block blob. + + + Optional to configure + parallel transfer behavior. + + + Optional to provide + progress updates about data transfers. + + + Optional + Indicates the tier to be set on the blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new block blob or updates the content of an + existing block blob. Updating an existing block blob overwrites + any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob.. + + + A file path containing the content to upload. + + + Optional parameters. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new block blob or updates the content of an + existing block blob. Updating an existing block blob overwrites + any existing metadata on the blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + + A file path containing the content to upload. + + + Optional standard HTTP header properties that can be set for the + block blob. + + + Optional custom metadata to set for this block blob. + + + Optional to add conditions on + the creation of this new block blob. + + + Optional to provide + progress updates about data transfers. + + + Optional + Indicates the tier to be set on the blob. + + + Optional to configure + parallel transfer behavior. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + This operation will create a new + block blob of arbitrary size by uploading it as indiviually staged + blocks if it's larger than the + MaximumTransferLength. + + + A containing the content to upload. + + + Options for this upload. + + + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + This operation will create a new + block blob of arbitrary size by uploading it as indiviually staged + blocks if it's larger than the + . MaximumTransferLength. + + + A file path of the file to upload. + + + Options for this upload. + + + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown if + a failure occurs. + + + + + Provides the client configuration options for connecting to Azure Blob + Storage. + + + + + The Latest service version supported by this client library. + + + + + The versions of Azure Blob Storage supported by this client + library. For more, see + + Versioning for Azure Storage Services. + + + + + The 2019-02-02 service version described at + + Version 2019-02-02 + + + + + The 2019-07-07 service version described at + + Version 2019-07-07 + + + + + The 2019-12-12 service version. + + + + + The 2020-02-10 service version. + + + + + The 2020-04-08 service version. + + + + + Gets the of the service API used when + making requests. For more, see + + Versioning for Azure Storage Services. + + + + + Gets the to be used when making requests. + + + + + Gets the to be used when making requests. + + + + + Gets or sets the secondary storage that can be read from for the storage account if the + account is enabled for RA-GRS. + + If this property is set, the secondary Uri will be used for GET or HEAD requests during retries. + If the status of the response from the secondary Uri is a 404, then subsequent retries for + the request will not use the secondary Uri again, as this indicates that the resource + may not have propagated there yet. Otherwise, subsequent retries will alternate back and forth + between primary and secondary Uri. + + + + + Initializes a new instance of the + class. + + + The of the service API used when + making requests. + + + + + Create an HttpPipeline from BlobClientOptions. + + Optional authentication policy. + An HttpPipeline to use for Storage requests. + + + + Create an HttpPipeline from BlobClientOptions. + + Optional authentication credentials. + An HttpPipeline to use for Storage requests. + + + + Applies client-side encryption to the data for upload. + + + Content to encrypt. + + + Metadata to add encryption metadata to. + + + Whether to perform this operation asynchronously. + + + Cancellation token. + + Transformed content stream and metadata. + + + + The allows you to manipulate Azure + Storage containers and their blobs. + + + + + The Azure Storage name used to identify a storage account's root container. + + + + + The Azure Storage name used to identify a storage account's logs container. + + + + + The Azure Storage name used to identify a storage account's web content container. + + + + + Gets the container's primary endpoint. + + + + + The transport pipeline used to send + every request. + + + + + The version of the service to use when sending requests. + + + + + The instance used to create diagnostic scopes + every request. + + + + + The to be used when sending requests. + + + + + The to be used when sending requests. + + + + + The to be used when sending/receiving requests. + + + + + The to be used when sending requests. + + + + + The to be used when sending requests. + + + + + Gets the Storage account name corresponding to the container client. + + + + + Gets the name of the container. + + + + + Gets the The used to authenticate and generate SAS. + + + + + Determines whether the client is able to generate a SAS. + If the client is authenticated with a . + + + + + Initializes a new instance of the + class for mocking. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, + + Configure Azure Storage connection strings + + + The name of the blob container in the storage account to reference. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, + + Configure Azure Storage connection strings + + + The name of the container in the storage account to reference. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob container that includes the + name of the account and the name of the container. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}". + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob container that includes the + name of the account and the name of the container. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}". + + + The shared key credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob container that includes the + name of the account and the name of the container. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}". + Must not contain shared access signature, which should be passed in the second parameter. + + + The shared access signature credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + This constructor should only be used when shared access signature needs to be updated during lifespan of this client. + + + + + Initializes a new instance of the + class. + + + A referencing the blob container that includes the + name of the account and the name of the container. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}". + + + The token credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob container that includes the + name of the account and the name of the container. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}". + + + An optional authentication policy used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob container that includes the + name of the account and the name of the container. + This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}". + + + The transport pipeline used to send every request. + + + The version of the service to use when sending requests. + + + The shared key credential used to sign requests. + + + Customer provided key. + + Encryption scope. + + + + Initializes a new instance of the + class. + + + A referencing the block blob that includes the + name of the account, the name of the container, and the name of + the blob. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + The transport pipeline used to send every request. + + + New instance of the class. + + + + + Create a new object by appending + to the end of . The + new uses the same request policy + pipeline as the . + + The name of the blob. + A new instance. + + + + Create a new object by appending + to the end of . The + new uses the same request policy + pipeline as the . + + The name of the blob. + A new instance. + + + + Create a new object by + concatenating to + the end of the . The new + + uses the same request policy pipeline as the + . + + The name of the block blob. + A new instance. + + + + Create a new object by + concatenating to + the end of the . The new + + uses the same request policy pipeline as the + . + + The name of the append blob. + A new instance. + + + + Create a new object by + concatenating to + the end of the . The new + + uses the same request policy pipeline as the + . + + The name of the page blob. + A new instance. + + + + Initializes a new instance of the class. + + + An optional lease ID. If no lease ID is provided, a random lease + ID will be created. + + + + + The + operation creates a new container + under the specified account. If the container with the same name + already exists, the operation fails. + + For more information, see + + Create Container. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Optional custom metadata to set for this container. + + + Optional encryption scope options to set for this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the newly + created blob container. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new container + under the specified account. If the container with the same name + already exists, the operation fails. + + For more information, see + + Create Container. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Optional custom metadata to set for this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the newly + created blob container. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new container under the specified account. If the container with the same name + already exists, the operation fails. + + For more information, see + + Create Container. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Optional custom metadata to set for this container. + + + Optional encryption scope options to set for this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the newly + created container. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new container + under the specified account. If the container with the same name + already exists, the operation fails. + + For more information, see + + Create Container. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Optional custom metadata to set for this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the newly + created container. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new container under the specified account. If the container with the same name + already exists, it is not changed. + + For more information, see + + Create Container. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Optional custom metadata to set for this container. + + + Optional encryption scope options to set for this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + If the container does not already exist, a + describing the newly created container. If the container already exists, null. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new container + under the specified account. If the container with the same name + already exists, it is not changed. + + For more information, see + + Create Container. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Optional custom metadata to set for this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + If the container does not already exist, a + describing the newly created container. If the container already exists, null. + + + A will be thrown if + a failure occurs. + + + + + The + operation creates a new container under the specified account. If the container with the same name + already exists, it is not changed. + + For more information, see + + Create Container. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Optional custom metadata to set for this container. + + + Optional encryption scope options to set for this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the newly + created container. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new container + under the specified account. If the container with the same name + already exists, it is not changed. + + For more information, see + + Create Container. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Optional custom metadata to set for this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the newly + created container. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified + container for deletion. The container and any blobs contained + within it are later deleted during garbage collection. + + For more information, see + + Delete Container. + + + Optional to add + conditions on the deletion of this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A if successful. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified + container for deletion. The container and any blobs contained + within it are later deleted during garbage collection. + + For more information, see + + Delete Container. + + + Optional to add + conditions on the deletion of this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A if successful. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified + container for deletion if it exists. The container and any blobs + contained within it are later deleted during garbage collection. + + For more information, see + + Delete Container. + + + Optional to add + conditions on the deletion of this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A Returns true if container exists and was + deleted, return false otherwise. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified + container for deletion if it exists. The container and any blobs + contained within it are later deleted during garbage collection. + + For more information, see + + Delete Container. + + + Optional to add + conditions on the deletion of this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A Returns true if container exists and was + deleted, return false otherwise. + + + A will be thrown if + a failure occurs. + + + + + The operation can be called on a + to see if the associated container + exists on the storage account in the storage service. + + + Optional to propagate + notifications that the operation should be cancelled. + + + Returns true if the container exists. + + + A will be thrown if + a failure occurs. If you want to create the container if + it doesn't exist, use + + instead. + + + + + The operation can be called on a + to see if the associated container + exists on the storage account in the storage service. + + + Optional to propagate + notifications that the operation should be cancelled. + + + Returns true if the container exists. + + + A will be thrown if + a failure occurs. If you want to create the container if + it doesn't exist, use + + instead. + + + + + The operation returns all + user-defined metadata and system properties for the specified + container. The data returned does not include the container's + list of blobs. + + For more information, see + + Get Container Properties. + + + Optional to add + conditions on getting the blob container's properties. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + container and its properties. + + + A will be thrown if + a failure occurs. + + + + + The operation returns all + user-defined metadata and system properties for the specified + container. The data returned does not include the container's + list of blobs. + + For more information, see + + Get Container Properties. + + + Optional to add + conditions on getting the blob container's properties. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + container and its properties. + + + A will be thrown if + a failure occurs. + + + + + The operation sets one or more + user-defined name-value pairs for the specified container. + + For more information, see + + Set Container Metadata. + + + Custom metadata to set for this container. + + + Optional to add + conditions on the deletion of this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A if successful. + + + A will be thrown if + a failure occurs. + + + + + The operation sets one or more + user-defined name-value pairs for the specified container. + + For more information, see + + Set Container Metadata. + + + Custom metadata to set for this container. + + + Optional to add + conditions on the deletion of this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A if successful. + + + A will be thrown if + a failure occurs. + + + + + The operation gets the + permissions for this container. The permissions indicate whether + container data may be accessed publicly. + + For more information, see + + Get Container ACL. + + + Optional to add + conditions on getting the blob container's access policy. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing + the container's access policy. + + + A will be thrown if + a failure occurs. + + + + + The operation gets the + permissions for this container. The permissions indicate whether + container data may be accessed publicly. + + For more information, see + + Get Container ACL. + + + Optional to add + conditions on getting the blob container's access policy. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing + the container's access policy. + + + A will be thrown if + a failure occurs. + + + + + The operation sets the + permissions for the specified container. The permissions indicate + whether blob container data may be accessed publicly. + + For more information, see + + Set Container ACL. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Stored access policies that you can use to provide fine grained + control over container permissions. + + + Optional to add + conditions on setting this blob container's access policy. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + updated container. + + + A will be thrown if + a failure occurs. + + + + + The operation sets the + permissions for the specified container. The permissions indicate + whether blob container data may be accessed publicly. + + For more information, see + + Set Container ACL. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Stored access policies that you can use to provide fine grained + control over container permissions. + + + Optional to add + conditions on setting this blob container's access policy. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + updated container. + + + A will be thrown if + a failure occurs. + + + + + The operation returns an async sequence + of blobs in this container. Enumerating the blobs may make + multiple requests to the service while fetching all the values. + Blobs are ordered lexicographically by name. + + For more information, see + + List Blobs. + + + Specifies trait options for shaping the blobs. + + + Specifies state options for filtering the blobs. + + + Specifies a string that filters the results to return only blobs + whose name begins with the specified . + + + Optional to propagate + notifications that the operation should be cancelled. + + + An of + describing the blobs in the container. + + + A will be thrown if + a failure occurs. + + + + + The operation returns an async + sequence of blobs in this container. Enumerating the blobs may + make multiple requests to the service while fetching all the + values. Blobs are ordered lexicographically by name. + + For more information, see + + List Blobs. + + + Specifies trait options for shaping the blobs. + + + Specifies state options for filtering the blobs. + + + Specifies a string that filters the results to return only blobs + whose name begins with the specified . + + + Optional to propagate + notifications that the operation should be cancelled. + + + An describing the + blobs in the container. + + + A will be thrown if + a failure occurs. + + + + + The operation returns a + single segment of blobs in this container, starting + from the specified . Use an empty + to start enumeration from the beginning + and the if it's not + empty to make subsequent calls to + to continue enumerating the blobs segment by segment. Blobs are + ordered lexicographically by name. + + For more information, see + + List Blobs. + + + An optional string value that identifies the segment of the list + of blobs to be returned with the next listing operation. The + operation returns a non-empty + if the listing operation did not return all blobs remaining to be + listed with the current segment. The NextMarker value can + be used as the value for the parameter + in a subsequent call to request the next segment of list items. + + + Specifies trait options for shaping the blobs. + + + Specifies state options for filtering the blobs. + + + Specifies a string that filters the results to return only blobs + whose name begins with the specified . + + + Gets or sets a value indicating the size of the page that should be + requested. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing a + segment of the blobs in the container. + + + A will be thrown if + a failure occurs. + + + + + The operation returns + an async collection of blobs in this container. Enumerating the + blobs may make multiple requests to the service while fetching all + the values. Blobs are ordered lexicographically by name. A + can be used to traverse a virtual + hierarchy of blobs as though it were a file system. + + For more information, see + + List Blobs. + + + Specifies trait options for shaping the blobs. + + + Specifies state options for filtering the blobs. + + + A that can be used to traverse a + virtual hierarchy of blobs as though it were a file system. The + delimiter may be a single character or a string. + will be returned + in place of all blobs whose names begin with the same substring up + to the appearance of the delimiter character. The value of a + prefix is substring+delimiter, where substring is the common + substring that begins one or more blob names, and delimiter is the + value of . You can use the value of + prefix to make a subsequent call to list the blobs that begin with + this prefix, by specifying the value of the prefix for the + . + + Note that each BlobPrefix element returned counts toward the + maximum result, just as each Blob element does. + + + Specifies a string that filters the results to return only blobs + whose name begins with the specified . + + + Optional to propagate + notifications that the operation should be cancelled. + + + An of + describing the blobs in the container. + + + A will be thrown if + a failure occurs. + + + + + The operation returns + an async collection of blobs in this container. Enumerating the + blobs may make multiple requests to the service while fetching all + the values. Blobs are ordered lexicographically by name. A + can be used to traverse a virtual + hierarchy of blobs as though it were a file system. + + For more information, see + + List Blobs. + + + Specifies trait options for shaping the blobs. + + + Specifies state options for filtering the blobs. + + + A that can be used to traverse a + virtual hierarchy of blobs as though it were a file system. The + delimiter may be a single character or a string. + will be returned + in place of all blobs whose names begin with the same substring up + to the appearance of the delimiter character. The value of a + prefix is substring+delimiter, where substring is the common + substring that begins one or more blob names, and delimiter is the + value of . You can use the value of + prefix to make a subsequent call to list the blobs that begin with + this prefix, by specifying the value of the prefix for the + . + + Note that each BlobPrefix element returned counts toward the + maximum result, just as each Blob element does. + + + Specifies a string that filters the results to return only blobs + whose name begins with the specified . + + + Optional to propagate + notifications that the operation should be cancelled. + + + An describing the + blobs in the container. + + + A will be thrown if + a failure occurs. + + + + + The operation returns + a single segment of blobs in this container, starting + from the specified . Use an empty + to start enumeration from the beginning + and the if it's not + empty to make subsequent calls to + to continue enumerating the blobs segment by segment. Blobs are + ordered lexicographically by name. A + can be used to traverse a virtual hierarchy of blobs as though + it were a file system. + + For more information, see + + List Blobs. + + + An optional string value that identifies the segment of the list + of blobs to be returned with the next listing operation. The + operation returns a non-empty + if the listing operation did not return all blobs remaining to be + listed with the current segment. The NextMarker value can + be used as the value for the parameter + in a subsequent call to request the next segment of list items. + + + A that can be used to traverse a + virtual hierarchy of blobs as though it were a file system. The + delimiter may be a single character or a string. + will be returned + in place of all blobs whose names begin with the same substring up + to the appearance of the delimiter character. The value of a + prefix is substring+delimiter, where substring is the common + substring that begins one or more blob names, and delimiter is the + value of . You can use the value of + prefix to make a subsequent call to list the blobs that begin with + this prefix, by specifying the value of the prefix for the + . + + Note that each BlobPrefix element returned counts toward the + maximum result, just as each Blob element does. + + + Specifies trait options for shaping the blobs. + + + Specifies state options for filtering the blobs. + + + Specifies a string that filters the results to return only blobs + whose name begins with the specified . + + + Gets or sets a value indicating the size of the page that should be + requested. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing a + segment of the blobs in the container. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new block + blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + The name of the blob to upload. + + A containing the content to upload. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown + if the blob already exists. To overwrite an existing block blob, + get a by calling , + and then call + with the override parameter set to true. + + + + + The operation creates a new block + blob. + + For partial block blob updates and other advanced features, please + see . To create or modify page or + append blobs, please see or + . + + For more information, see + + Put Blob. + + The name of the blob to upload. + + A containing the content to upload. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the + state of the updated block blob. + + + A will be thrown + if the blob already exists. To overwrite an existing block blob, + get a by calling , + and then call + with the override parameter set to true. + + + + + The operation marks the specified + blob or snapshot for deletion. The blob is later deleted during + garbage collection. + + Note that in order to delete a blob, you must delete all of its + snapshots. You can delete both at the same time using + . + + For more information, see + + Delete Blob. + + The name of the blob to delete. + + Specifies options for deleting blob snapshots. + + + Optional to add conditions on + deleting this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully deleting. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified + blob or snapshot for deletion. The blob is later deleted during + garbage collection. + + Note that in order to delete a blob, you must delete all of its + snapshots. You can delete both at the same time using + . + + For more information, see + + Delete Blob. + + The name of the blob to delete. + + Specifies options for deleting blob snapshots. + + + Optional to add conditions on + deleting this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully deleting. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified + blob or snapshot for deletion, if the blob or snapshot exists. The blob + is later deleted during garbage collection. + + Note that in order to delete a blob, you must delete all of its + snapshots. You can delete both at the same time using + . + + For more information, see + + Delete Blob. + + The name of the blob to delete. + + Specifies options for deleting blob snapshots. + + + Optional to add conditions on + deleting this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully deleting. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the specified + blob or snapshot for deletion, if the blob or snapshot exists. The blob + is later deleted during garbage collection. + + Note that in order to delete a blob, you must delete all of its + snapshots. You can delete both at the same time using + . + + For more information, see + + Delete Blob. + + The name of the blob to delete. + + Specifies options for deleting blob snapshots. + + + Optional to add conditions on + deleting this blob. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A on successfully deleting. + + + A will be thrown if + a failure occurs. + + + + + The + returns a that generates a Blob Container Service + Shared Access Signature (SAS) Uri based on the Client properties + and parameters passed. The SAS is signed by the shared key credential + of the client. + + To check if the client is able to sign a Service Sas see + . + + For more information, see + + Constructing a service SAS. + + + Required. Specifies the list of permissions to be associated with the SAS. + See . + + + Required. Specifies the time at which the SAS becomes invalid. This field + must be omitted if it has been specified in an associated stored access policy. + + + A containing the SAS Uri. + + + A will be thrown if a failure occurs. + + + + + The returns a + that generates a Blob Container Service Shared Access Signature (SAS) Uri + based on the Client properties and builder passed. The SAS is signed by + the shared key credential of the client. + + To check if the client is able to sign a Service Sas see + . + + For more information, see + + Constructing a Service SAS. + + + Used to generate a Shared Access Signature (SAS). + + + A containing the SAS Uri. + + + A will be thrown if a failure occurs. + + + + + Create a new that pointing to this 's blob service. + The new + uses the same request policy pipeline as the + . + + A new instance. + + + + Create exceptions for common error cases. + + + + + BlobRestClient response extensions + + + BlockListTypes extensions + + + BlobContainerTraits/BlobContianerStates enum methods. + + + BlobTraits/BlobStates enum methods + + + BlobRestClient response extensions + + + Blob enum extensions + + + Blob enum extensions. + + + Blob enum extensions + + + Blob enum extensions. + + + Blob enum extensions. + + + + + Creates a new BlobProperties object backed by BlobPropertiesInternal. + + + The BlobPropertiesInternal returned with the request. + + + + + Internal. Parses Object Replication Policy ID from Rule ID and sets the Policy ID for source blobs. + + + Unparsed Object Replication headers. + For source blobs, the dictionary will contain keys that contain the policy id and rule id separated + by a underscore (e.g. policyId_ruleId). The value of these keys will be the replication status (e.g. Complete, Failed). + For destination blobs, the dictionary will contain one entry where the key will be "policy-id" + and the value will be the destination policy id. No parsing will be required for this. + + + If the blob has object replication policy(s) applied and is the source blob, this method will return a + List of , which contains the Policy ID and the respective + rule(s) and replication status(s) for each policy. + If the blob has object replication policy applied and is the destination blob, + this method will return default as the policy id should be set in ObjectReplicationDestinationPolicyId + (e.g. ,). + + + + + Internal. Parses Object Replication Policy ID from Rule ID and sets the Policy ID for source blobs. + + + Unparsed Object Replication headers. + For source blobs, the dictionary will contain keys that are prefixed with "or-" and followed by the + policy id and rule id separated by a underscore (e.g. or-policyId_ruleId). + The value of this metadata key will be the replication status (e.g. Complete, Failed). + + + If the blob has object replication policy(s) applied and is the source blob, this method will return a + List of , which contains the Policy ID and the respective + rule(s) and replication status(s) for each policy. + + + + + Convert the internal GetBlockListOperation response into a BlockList. + + The original response. + The BlockList response. + + + + Convert the BlockListTypes into a BlockListType. + + + The BlockList response. + + + + Convert the details into ListContainersIncludeType values. + + ListContainersIncludeType values + + + + Convert the details into ListBlobsIncludeItem values. + + ListBlobsIncludeItem values + + + + Convert the internal BrokenLease response into a Lease. The + LeaseId will be empty. + + The original response. + The Lease response. + + + + Create a permissions string to provide + . + + A permissions string. + + + + Create a permissions string to provide + . + + A permissions string. + + + + Create a permissions string to provide + . + + A permissions string. + + + + Create a permissions string to provide + . + + A permissions string. + + + + Create a permissions string to provide + . + + A permissions string. + + + + QuickQueryStream. + + + + + Underlying stream. + + + + + Avro Reader. + + + + + Buffer to hold bytes we haven't processed yet. + + + + + Current buffer offset. + + + + + The current length of the buffer. + + + + + Progress handler. + + + + + Error handler. + + + + When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source.The zero-based byte offset in at which to begin storing the data read from the current stream.The maximum number of bytes to be read from the current stream.The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.The sum of and is larger than the buffer length. is . or is negative.An I/O error occurs.The stream does not support reading.Methods were called after the stream was closed. + + + + + + When overridden in a derived class, gets a value indicating whether the current stream supports reading. if the stream supports reading; otherwise, . + + + When overridden in a derived class, gets a value indicating whether the current stream supports seeking. if the stream supports seeking; otherwise, . + + + When overridden in a derived class, gets a value indicating whether the current stream supports writing. if the stream supports writing; otherwise, . + + + When overridden in a derived class, gets the length in bytes of the stream.A long value representing the length of the stream in bytes.A class derived from does not support seeking.Methods were called after the stream was closed. + + + When overridden in a derived class, gets or sets the position within the current stream.The current position within the stream.An I/O error occurs.The stream does not support seeking.Methods were called after the stream was closed. + + + When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.An I/O error occurs. + + + When overridden in a derived class, sets the position within the current stream.A byte offset relative to the parameter.A value of type indicating the reference point used to obtain the new position.The new position within the current stream.An I/O error occurs.The stream does not support seeking, such as if the stream is constructed from a pipe or console output.Methods were called after the stream was closed. + + + When overridden in a derived class, sets the length of the current stream.The desired length of the current stream in bytes.An I/O error occurs.The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.Methods were called after the stream was closed. + + + When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.An array of bytes. This method copies bytes from to the current stream.The zero-based byte offset in at which to begin copying bytes to the current stream.The number of bytes to be written to the current stream.The sum of and is greater than the buffer length. is . or is negative.An I/O error occurred, such as the specified file cannot be found.The stream does not support writing. was called after the stream was closed. + + + Releases the unmanaged resources used by the and optionally releases the managed resources. to release both managed and unmanaged resources; to release only unmanaged resources. + + + + The allows you to manipulate Azure + Storage service resources and blob containers. The storage account provides + the top-level namespace for the Blob service. + + + + + Gets the blob service's primary endpoint. + + + + + The transport pipeline used to send + every request. + + + + + The version of the service to use when sending requests. + + + + + The instance used to create diagnostic scopes + every request. + + + + + The to be used when sending requests. + + + + + The to be used when sending requests. + + + + + The to be used when sending/receiving requests. + + + + + The name of the Encryption Scope to be used when sending request. + + + + + The name of the Encryption Scope to be used when sending request. + + + + + Gets the Storage account name corresponding to the service client. + + + + + Gets the The used to authenticate and generate SAS. + + + + + Determines whether the client is able to generate a SAS. + If the client is authenticated with a . + + + + + Initializes a new instance of the + class for mocking. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, Configure Azure Storage connection strings. + + + + + Initializes a new instance of the + class. + + + A connection string includes the authentication information + required for your application to access data in an Azure Storage + account at runtime. + + For more information, + + Configure Azure Storage connection strings. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob service. + This is likely to be similar to "https://{account_name}.blob.core.windows.net". + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob service. + This is likely to be similar to "https://{account_name}.blob.core.windows.net". + + + The shared key credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob service. + This is likely to be similar to "https://{account_name}.blob.core.windows.net". + Must not contain shared access signature, which should be passed in the second parameter. + + + The shared access signature credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + This constructor should only be used when shared access signature needs to be updated during lifespan of this client. + + + + + Initializes a new instance of the + class. + + + A referencing the blob service. + This is likely to be similar to "https://{account_name}.blob.core.windows.net". + + + The token credential used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + + + Initializes a new instance of the + class. + + + A referencing the blob service. + This is likely to be similar to "https://{account_name}.blob.core.windows.net". + + + An optional authentication policy used to sign requests. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + Optional storage shared key credential used to sign requests and generate sas. + + + + + Initializes a new instance of the + class. + + + A referencing the blob service. + This is likely to be similar to "https://{account_name}.blob.core.windows.net". + + + An optional authentication policy used to sign requests. + + + The version of the service to use when sending requests. + + + The instance used to create + diagnostic scopes every request. + + Customer provided key. + Client-side encryption options. + Encryption scope. + + The transport pipeline used to send every request. + + Storage Shared Key Credential + + + + Intended for DataLake to create a backing blob client. + + Initializes a new instance of the + class. + + + A referencing the block blob that includes the + name of the account, the name of the container, and the name of + the blob. + + + Optional client options that define the transport pipeline + policies for authentication, retries, etc., that are applied to + every request. + + + An optional authentication policy used to sign requests. + + + The transport pipeline used to send every request. + + + New instanc of the class. + + + + + Create a new object by appending + to the end of . + The new uses the same request + policy pipeline as the . + + + The name of the blob container to reference. + + + A for the desired container. + + + + + Get a 's + for creating child clients. + + The BlobServiceClient. + The BlobServiceClient's HttpPipeline. + + + + Get a 's authentication + for creating child clients. + + The BlobServiceClient. + The BlobServiceClient's authentication policy. + + + + Get a 's + for creating child clients. + + The BlobServiceClient. + The BlobServiceClient's BlobClientOptions. + + + + The + operation returns an asyncsequence of blob containers in the storage account. Enumerating the + blob containers may make multiple requests to the service while fetching + all the values. Containers are ordered lexicographically by name. + + For more information, + see + List Containers. + + + Specifies trait options for shaping the blob containers. + + + Specifies state options for shaping the blob containers. + + + Specifies a string that filters the results to return only containers + whose name begins with the specified . + + + Optional to propagate + notifications that the operation should be cancelled. + + + An of + describing the blob containers in the storage account. + + + A will be thrown if + a failure occurs. + + + + + The operation returns an async + sequence of blob containers in the storage account. Enumerating the + blob containers may make multiple requests to the service while fetching + all the values. Containers are ordered lexicographically by name. + + For more information, see + + List Containers. + + + Specifies trait options for shaping the blob containers. + + + Specifies a string that filters the results to return only containers + whose name begins with the specified . + + + Optional to propagate + notifications that the operation should be cancelled. + + + An of + describing the blob containers in the storage account. + + + A will be thrown if + a failure occurs. + + + + + The + operation returns an async sequence of blob containers in the storage account. Enumerating the + blob containers may make multiple requests to the service while fetching + all the values. Containers are ordered lexicographically by name. + + For more information, see + + List Containers. + + + Specifies trait options for shaping the blob containers. + + + Specifies states options for shaping the blob containers. + + + Specifies a string that filters the results to return only containers + whose name begins with the specified . + + + Optional to propagate + notifications that the operation should be cancelled. + + + An describing the + containers in the storage account. + + + A will be thrown if + a failure occurs. + + + + + The + operation returns an async sequence of blob containers in the storage account. Enumerating the + blob containers may make multiple requests to the service while fetching + all the values. Containers are ordered lexicographically by name. + + For more information, see + + List Containers. + + + Specifies trait options for shaping the blob containers. + + + Specifies a string that filters the results to return only containers + whose name begins with the specified . + + + Optional to propagate + notifications that the operation should be cancelled. + + + An describing the + containers in the storage account. + + + A will be thrown if + a failure occurs. + + + + + The operation returns a + single segment of blob containers in the storage account, starting + from the specified . Use an empty + to start enumeration from the beginning + and the if it's not + empty to make subsequent calls to + to continue enumerating the containers segment by segment. + Containers are ordered lexicographically by name. + + For more information, see + + List Containers. + + + An optional string value that identifies the segment of the list + of blob containers to be returned with the next listing operation. The + operation returns a non-empty + if the listing operation did not return all blob containers remaining + to be listed with the current segment. The NextMarker value can + be used as the value for the parameter + in a subsequent call to request the next segment of list items. + + + Specifies trait options for shaping the blob containers. + + + Specifies state options for shaping the blob containers. + + + Specifies a string that filters the results to return only containers + whose name begins with the specified . + + + Gets or sets a value indicating the size of the page that should be + requested. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing a + segment of the blob containers in the storage account. + + + A will be thrown if + a failure occurs. + + + + + The operation returns the sku + name and account kind for the specified account. + + For more information, see + + Get Account Information. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the account. + + + A will be thrown if + a failure occurs. + + + + + The operation returns the sku + name and account kind for the specified account. + + For more information, see + + Get Account Information. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing the account. + + + A will be thrown if + a failure occurs. + + + + + The operation gets the properties + of a storage account’s blob service, including properties for + Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. + + For more information, see + + Get Blob Service Properties. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing + the service properties. + + + A will be thrown if + a failure occurs. + + + + + The operation gets the properties + of a storage account’s blob service, including properties for + Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. + + For more information, see + + Get Blob Service Properties. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing + the service properties. + + + A will be thrown if + a failure occurs. + + + + + The operation sets properties for + a storage account’s Blob service endpoint, including properties + for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules + and soft delete settings. You can also use this operation to set + the default request version for all incoming requests to the Blob + service that do not have a version specified. + + For more information, see + + Set Blob Service Properties. + + The blob service properties. + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing + the service properties. + + + A will be thrown if + a failure occurs. + + + + + The operation sets properties for + a storage account’s Blob service endpoint, including properties + for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules + and soft delete settings. You can also use this operation to set + the default request version for all incoming requests to the Blob + service that do not have a version specified. + + For more information, see + + Set Blob Service Properties. + + The blob service properties. + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing + the service properties. + + + A will be thrown if + a failure occurs. + + + + + The operation retrieves + statistics related to replication for the Blob service. It is + only available on the secondary location endpoint when read-access + geo-redundant replication () + is enabled for the storage account. + + For more information, see + + Get Blob Service Stats. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing + the service replication statistics. + + + A will be thrown if + a failure occurs. + + + + + The operation retrieves + statistics related to replication for the Blob service. It is + only available on the secondary location endpoint when read-access + geo-redundant replication () + is enabled for the storage account. + + For more information, see + + Get Blob Service Stats. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing + the service replication statistics. + + + A will be thrown if + a failure occurs. + + + + + The operation retrieves a + key that can be used to delegate Active Directory authorization to + shared access signatures created with . + + + Start time for the key's validity, with null indicating an + immediate start. The time should be specified in UTC. + + + Expiration of the key's validity. The time should be specified + in UTC. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing + the service replication statistics. + + + A will be thrown if + a failure occurs. + + + + + The operation retrieves a + key that can be used to delegate Active Directory authorization to + shared access signatures created with . + + + Start time for the key's validity, with null indicating an + immediate start. The time should be specified in UTC. + + + Expiration of the key's validity. The time should be specified + in UTC. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A describing + the service replication statistics. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new + blob container under the specified account. If the container with the + same name already exists, the operation fails. + + For more information, see + + Create Container. + + + The name of the container to create. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Optional custom metadata to set for this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A referencing the + newly created container. + + + A will be thrown if + a failure occurs. + + + + + The operation creates a new + blob container under the specified account. If the container with the + same name already exists, the operation fails. + + For more information, see + + Create Container. + + + The name of the container to create. + + + Optionally specifies whether data in the container may be accessed + publicly and the level of access. + specifies full public read access for container and blob data. + Clients can enumerate blobs within the container via anonymous + request, but cannot enumerate containers within the storage + account. specifies public + read access for blobs. Blob data within this container can be + read via anonymous request, but container data is not available. + Clients cannot enumerate blobs within the container via anonymous + request. specifies that the + container data is private to the account owner. + + + Optional custom metadata to set for this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A referencing the + newly created container. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the + specified blob container for deletion. The container and any blobs + contained within it are later deleted during garbage collection. + + For more information, see + + Delete Container. + + + The name of the container to delete. + + + Optional to add + conditions on the deletion of this container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A if successful. + + + A will be thrown if + a failure occurs. + + + + + The operation marks the + specified container for deletion. The container and any blobs + contained within it are later deleted during garbage collection. + + For more information, see + + Delete Container. + + + The name of the blob container to delete. + + + Optional to add + conditions on the deletion of this blob container. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A if successful. + + + A will be thrown if + a failure occurs. + + + + + Restores a previously deleted container. + This API is only functional is Container Soft Delete is enabled + for the storage account associated with the container. + + + The name of the previously deleted container. + + + The version of the previously deleted container. + + + Optional. Use this parameter if you would like to restore the container + under a different name. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A pointed at the undeleted container. + + + A will be thrown if + a failure occurs. + + + + + Restores a previously deleted container. + This API is only functional is Container Soft Delete is enabled + for the storage account associated with the container. + + + The name of the previously deleted container. + + + The version of the previously deleted container. + + + Optional. Use this parameter if you would like to restore the container + under a different name. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A pointed at the undeleted container. + + + A will be thrown if + a failure occurs. + + + + + Restores a previously deleted container. + This API is only functional is Container Soft Delete is enabled + for the storage account associated with the container. + + + The name of the previously deleted container. + + + The version of the previously deleted container. + + + Optional. Use this parameter if you would like to restore the container + under a different name. + + + Whether to invoke the operation asynchronously. + + + Optional to propagate + notifications that the operation should be cancelled. + + + A pointed at the undeleted container. + + + A will be thrown if + a failure occurs. + + + + + The Filter Blobs operation enables callers to list blobs across all containers whose tags + match a given search expression. Filter blobs searches across all containers within a + storage account but can be scoped within the expression to a single container. + + For more information, see + + Find Blobs by Tags. + + + The where parameter finds blobs in the storage account whose tags match a given expression. + The expression must evaluate to true for a blob to be returned in the result set. + The storage service supports a subset of the ANSI SQL WHERE clause grammar for the value of the where=expression query parameter. + The following operators are supported: =, >, >=, <, <=, AND. and @container. + Example expression: "tagKey"='tagValue'. + + + Optional to propagate + notifications that the operation should be cancelled. + + + An describing the blobs. + + + A will be thrown if + a failure occurs. + + + + + The Filter Blobs operation enables callers to list blobs across all containers whose tags + match a given search expression. Filter blobs searches across all containers within a + storage account but can be scoped within the expression to a single container. + + For more information, see + + Find Blobs by Tags. + + + The where parameter finds blobs in the storage account whose tags match a given expression. + The expression must evaluate to true for a blob to be returned in the result set. + The storage service supports a subset of the ANSI SQL WHERE clause grammar for the value of the where=expression query parameter. + The following operators are supported: =, >, >=, <, <=, AND. and @container. + Example expression: "tagKey"='tagValue'. + + + Optional to propagate + notifications that the operation should be cancelled. + + + An describing the blobs. + + + A will be thrown if + a failure occurs. + + + + + The + returns a that generates a Blob Account + Shared Access Signature (SAS) based on the Client properties + and parameters passed. The SAS is signed by the + shared key credential of the client. + + To check if the client is able to sign a Service Sas see + . + + For more information, see + + Constructing an Account SAS. + + + Required. Specifies the list of permissions to be associated with the SAS. + See . + + + Required. The time at which the shared access signature becomes invalid. + + + Specifies the resource types associated with the shared access signature. + The user is restricted to operations on the specified resources. + See . + + + A containing the SAS Uri. + + + A will be thrown if a failure occurs. + + + + + The returns a that + generates a Blob Account Shared Access Signature (SAS) based on the + Client properties and builder passed. The SAS is signed by the + shared key credential of the client. + + To check if the client is able to sign a Service Sas see + . + + For more information, see + + Constructing an Account SAS. + + + Used to generate a Shared Access Signature (SAS). + + + A containing the SAS Uri. + + + A will be thrown if a failure occurs. + + + + + The class provides a convenient way to + modify the contents of a instance to point to + different Azure Storage resources like an account, container, or blob. + + For more information, see + + Naming and Referencing Containers, Blobs, and Metadata. + + + + + Gets or sets the scheme name of the URI. + Example: "https" + + + + + Gets or sets the Domain Name System (DNS) host name or IP address + of a server. + + Example: "account.blob.core.windows.net" + + + + + Gets or sets the port number of the URI. + + + + + Gets or sets the Azure Storage account name. + + + + + Gets or sets the name of a blob storage Container. The value + defaults to if not present in the + . + + + + + Gets or sets the name of a blob. The value defaults to + if not present in the . + + + + + Gets or sets the name of a blob snapshot. The value defaults to + if not present in the . + + + + + Gets or sets the name of a blob version. The value defaults to + if not present in the . + + + + + Gets or sets the Shared Access Signature query parameters, or null + if not present in the . + + + + + Gets or sets any query information included in the URI that's not + relevant to addressing Azure storage resources. + + + + + Initializes a new instance of the + class with the specified . + + + The to a storage resource. + + + + + Returns the constructed from the + 's fields. The + property contains the SAS and additional query parameters. + + + + + Returns the display string for the specified + instance. + + + The display string for the specified + instance. + + + + + Azure Blob Storage + + + + + Service operations for Azure Blob Storage + + + + + Sets properties for a storage account's Blob service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The StorageService properties. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response + + + + Create the Service.SetPropertiesAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The StorageService properties. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Service.SetPropertiesAsync Message. + + + + Create the Service.SetPropertiesAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Service.SetPropertiesAsync Azure.Response. + + + + gets the properties of a storage account's Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Storage Service Properties. + + + + Create the Service.GetPropertiesAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Service.GetPropertiesAsync Message. + + + + Create the Service.GetPropertiesAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Service.GetPropertiesAsync Azure.Response{Azure.Storage.Blobs.Models.BlobServiceProperties}. + + + + Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Statistics for the storage service. + + + + Create the Service.GetStatisticsAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Service.GetStatisticsAsync Message. + + + + Create the Service.GetStatisticsAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Service.GetStatisticsAsync Azure.Response{Azure.Storage.Blobs.Models.BlobServiceStatistics}. + + + + The List Containers Segment operation returns a list of the containers under the specified account + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + Filters the results to return only containers whose name begins with the specified prefix. + A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. + Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. + Include this parameter to specify that the container's metadata be returned as part of the response body. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + An enumeration of containers + + + + Create the Service.ListBlobContainersSegmentAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + Filters the results to return only containers whose name begins with the specified prefix. + A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. + Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. + Include this parameter to specify that the container's metadata be returned as part of the response body. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Service.ListBlobContainersSegmentAsync Message. + + + + Create the Service.ListBlobContainersSegmentAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Service.ListBlobContainersSegmentAsync Azure.Response{Azure.Storage.Blobs.Models.BlobContainersSegment}. + + + + Retrieves a user delegation key for the Blob service. This is only a valid operation when using bearer token authentication. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Key information + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + A user delegation key + + + + Create the Service.GetUserDelegationKeyAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Key information + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Service.GetUserDelegationKeyAsync Message. + + + + Create the Service.GetUserDelegationKeyAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Service.GetUserDelegationKeyAsync Azure.Response{Azure.Storage.Blobs.Models.UserDelegationKey}. + + + + Returns the sku name and account kind + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.AccountInfo} + + + + Create the Service.GetAccountInfoAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The Service.GetAccountInfoAsync Message. + + + + Create the Service.GetAccountInfoAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Service.GetAccountInfoAsync Azure.Response{Azure.Storage.Blobs.Models.AccountInfo}. + + + + The Batch operation allows multiple API calls to be embedded into a single HTTP request. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Initial data + The length of the request. + Required. The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_{GUID} + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobBatchResult} + + + + Create the Service.SubmitBatchAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Initial data + The length of the request. + Required. The value of this header must be multipart/mixed with a batch boundary. Example header value: multipart/mixed; boundary=batch_{GUID} + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Service.SubmitBatchAsync Message. + + + + Create the Service.SubmitBatchAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Service.SubmitBatchAsync Azure.Response{Azure.Storage.Blobs.Models.BlobBatchResult}. + + + + The Filter Blobs operation enables callers to list blobs across all containers whose tags match a given search expression. Filter blobs searches across all containers within a storage account but can be scoped within the expression to a single container. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Filters the results to return only to return only blobs whose tags match the specified expression. + A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. + Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + The result of a Filter Blobs API call + + + + Create the Service.FilterBlobsAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Filters the results to return only to return only blobs whose tags match the specified expression. + A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. + Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. + The Service.FilterBlobsAsync Message. + + + + Create the Service.FilterBlobsAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Service.FilterBlobsAsync Azure.Response{Azure.Storage.Blobs.Models.FilterBlobSegment}. + + + + Container operations for Azure Blob Storage + + + + + creates a new container under the specified account. If the container with the same name already exists, the operation fails + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies whether data in the container may be accessed publicly and the level of access + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. Version 2019-07-07 and later. Specifies the default encryption scope to set on the container and use for all future writes. + Optional. Version 2019-07-07 and newer. If true, prevents any request from specifying a different encryption scope than the scope set on the container. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobContainerInfo} + + + + Create the Container.CreateAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies whether data in the container may be accessed publicly and the level of access + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. Version 2019-07-07 and later. Specifies the default encryption scope to set on the container and use for all future writes. + Optional. Version 2019-07-07 and newer. If true, prevents any request from specifying a different encryption scope than the scope set on the container. + The Container.CreateAsync Message. + + + + Create the Container.CreateAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.CreateAsync Azure.Response{Azure.Storage.Blobs.Models.BlobContainerInfo}. + + + + returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.FlattenedContainerItem} + + + + Create the Container.GetPropertiesAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.GetPropertiesAsync Message. + + + + Create the Container.GetPropertiesAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.GetPropertiesAsync Azure.Response{Azure.Storage.Blobs.Models.FlattenedContainerItem}. + + + + operation marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response + + + + Create the Container.DeleteAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.DeleteAsync Message. + + + + Create the Container.DeleteAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.DeleteAsync Azure.Response. + + + + operation sets one or more user-defined name-value pairs for the specified container. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobContainerInfo} + + + + Create the Container.SetMetadataAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.SetMetadataAsync Message. + + + + Create the Container.SetMetadataAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.SetMetadataAsync Azure.Response{Azure.Storage.Blobs.Models.BlobContainerInfo}. + + + + gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobContainerAccessPolicy} + + + + Create the Container.GetAccessPolicyAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.GetAccessPolicyAsync Message. + + + + Create the Container.GetAccessPolicyAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.GetAccessPolicyAsync Azure.Response{Azure.Storage.Blobs.Models.BlobContainerAccessPolicy}. + + + + sets the permissions for the specified container. The permissions indicate whether blobs in a container may be accessed publicly. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies whether data in the container may be accessed publicly and the level of access + Specifies the version of the operation to use for this request. + the acls for the container + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobContainerInfo} + + + + Create the Container.SetAccessPolicyAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies whether data in the container may be accessed publicly and the level of access + Specifies the version of the operation to use for this request. + the acls for the container + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.SetAccessPolicyAsync Message. + + + + Create the Container.SetAccessPolicyAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.SetAccessPolicyAsync Azure.Response{Azure.Storage.Blobs.Models.BlobContainerInfo}. + + + + Restores a previously-deleted container. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. Version 2019-12-12 and later. Specifies the name of the deleted container to restore. + Optional. Version 2019-12-12 and later. Specifies the version of the deleted container to restore. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response + + + + Create the Container.RestoreAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. Version 2019-12-12 and later. Specifies the name of the deleted container to restore. + Optional. Version 2019-12-12 and later. Specifies the version of the deleted container to restore. + The Container.RestoreAsync Message. + + + + Create the Container.RestoreAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.RestoreAsync Azure.Response. + + + + [Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. + Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobLease} + + + + Create the Container.AcquireLeaseAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. + Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.AcquireLeaseAsync Message. + + + + Create the Container.AcquireLeaseAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.AcquireLeaseAsync Azure.Response{Azure.Storage.Blobs.Models.BlobLease}. + + + + [Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobContainerInfo} + + + + Create the Container.ReleaseLeaseAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.ReleaseLeaseAsync Message. + + + + Create the Container.ReleaseLeaseAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.ReleaseLeaseAsync Azure.Response{Azure.Storage.Blobs.Models.BlobContainerInfo}. + + + + [Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobLease} + + + + Create the Container.RenewLeaseAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.RenewLeaseAsync Message. + + + + Create the Container.RenewLeaseAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.RenewLeaseAsync Azure.Response{Azure.Storage.Blobs.Models.BlobLease}. + + + + [Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BrokenLease} + + + + Create the Container.BreakLeaseAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.BreakLeaseAsync Message. + + + + Create the Container.BreakLeaseAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.BreakLeaseAsync Azure.Response{Azure.Storage.Blobs.Models.BrokenLease}. + + + + [Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobLease} + + + + Create the Container.ChangeLeaseAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.ChangeLeaseAsync Message. + + + + Create the Container.ChangeLeaseAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.ChangeLeaseAsync Azure.Response{Azure.Storage.Blobs.Models.BlobLease}. + + + + [Update] The List Blobs operation returns a list of the blobs under the specified container + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + Filters the results to return only containers whose name begins with the specified prefix. + A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. + Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. + Include this parameter to specify one or more datasets to include in the response. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + An enumeration of blobs + + + + Create the Container.ListBlobsFlatSegmentAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + Filters the results to return only containers whose name begins with the specified prefix. + A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. + Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. + Include this parameter to specify one or more datasets to include in the response. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.ListBlobsFlatSegmentAsync Message. + + + + Create the Container.ListBlobsFlatSegmentAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.ListBlobsFlatSegmentAsync Azure.Response{Azure.Storage.Blobs.Models.BlobsFlatSegment}. + + + + [Update] The List Blobs operation returns a list of the blobs under the specified container + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + Filters the results to return only containers whose name begins with the specified prefix. + When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string. + A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. + Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. + Include this parameter to specify one or more datasets to include in the response. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + An enumeration of blobs + + + + Create the Container.ListBlobsHierarchySegmentAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + Filters the results to return only containers whose name begins with the specified prefix. + When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string. + A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. + Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. + Include this parameter to specify one or more datasets to include in the response. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Container.ListBlobsHierarchySegmentAsync Message. + + + + Create the Container.ListBlobsHierarchySegmentAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Container.ListBlobsHierarchySegmentAsync Azure.Response{Azure.Storage.Blobs.Models.BlobsHierarchySegment}. + + + + Blob operations for Azure Blob Storage + + + + + The Download operation reads or downloads a blob from the system, including its metadata and properties. You can also call Download to read a snapshot. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Return only the bytes of the blob in the specified range. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + When set to true and specified together with the Range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. + When set to true and specified together with the Range, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.FlattenedDownloadProperties} + + + + Create the Blob.DownloadAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Return only the bytes of the blob in the specified range. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + When set to true and specified together with the Range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. + When set to true and specified together with the Range, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.DownloadAsync Message. + + + + Create the Blob.DownloadAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.DownloadAsync Azure.Response{Azure.Storage.Blobs.Models.FlattenedDownloadProperties}. + + + + The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobPropertiesInternal} + + + + Create the Blob.GetPropertiesAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.GetPropertiesAsync Message. + + + + Create the Blob.GetPropertiesAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.GetPropertiesAsync Azure.Response{Azure.Storage.Blobs.Models.BlobPropertiesInternal}. + + + + If the storage account's soft delete feature is disabled then, when a blob is deleted, it is permanently removed from the storage account. If the storage account's soft delete feature is enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible immediately. However, the blob service retains the blob or snapshot for the number of days specified by the DeleteRetentionPolicy section of [Storage service properties] (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is permanently removed from the storage account. Note that you continue to be charged for the soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the "include=deleted" query parameter to discover which blobs and snapshots have been soft deleted. You can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a soft-deleted blob or snapshot causes the service to return an HTTP status code of 404 (ResourceNotFound). + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob's snapshots and not the blob itself + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. Only possible value is 'permanent', which specifies to permanently delete a blob if blob soft delete is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response + + + + Create the Blob.DeleteAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob's snapshots and not the blob itself + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. Only possible value is 'permanent', which specifies to permanently delete a blob if blob soft delete is enabled. + The Blob.DeleteAsync Message. + + + + Create the Blob.DeleteAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.DeleteAsync Azure.Response. + + + + Set the owner, group, permissions, or access control list for a blob. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. The owner of the blob or directory. + Optional. The owning group of the blob or directory. + Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. + Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobSetAccessControlResult} + + + + Create the Blob.SetAccessControlAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. The owner of the blob or directory. + Optional. The owning group of the blob or directory. + Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. + Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.SetAccessControlAsync Message. + + + + Create the Blob.SetAccessControlAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.SetAccessControlAsync Azure.Response{Azure.Storage.Blobs.Models.BlobSetAccessControlResult}. + + + + Get the owner, group, permissions, or access control list for a blob. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobGetAccessControlResult} + + + + Create the Blob.GetAccessControlAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.GetAccessControlAsync Message. + + + + Create the Blob.GetAccessControlAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.GetAccessControlAsync Azure.Response{Azure.Storage.Blobs.Models.BlobGetAccessControlResult}. + + + + Rename a blob/file. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: "*". + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The file or directory to be renamed. The value must have the following format: "/{filesysystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Determines the behavior of the rename operation + Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is base64 encoded. + Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. + Only valid if Hierarchical Namespace is enabled for the account. This umask restricts permission settings for file and directory, and will only be applied when default Acl does not exist in parent directory. If the umask bit has set, it means that the corresponding permission will be disabled. Otherwise the corresponding permission will be determined by the permission. A 4-digit octal notation (e.g. 0022) is supported here. If no umask was specified, a default umask - 0027 will be used. + Cache control for given resource + Content type for given resource + Content encoding for given resource + Content language for given resource + Content disposition for given resource + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobRenameResult} + + + + Create the Blob.RenameAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The file or directory to be renamed. The value must have the following format: "/{filesysystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Determines the behavior of the rename operation + Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is base64 encoded. + Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. + Only valid if Hierarchical Namespace is enabled for the account. This umask restricts permission settings for file and directory, and will only be applied when default Acl does not exist in parent directory. If the umask bit has set, it means that the corresponding permission will be disabled. Otherwise the corresponding permission will be determined by the permission. A 4-digit octal notation (e.g. 0022) is supported here. If no umask was specified, a default umask - 0027 will be used. + Cache control for given resource + Content type for given resource + Content encoding for given resource + Content language for given resource + Content disposition for given resource + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.RenameAsync Message. + + + + Create the Blob.RenameAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.RenameAsync Azure.Response{Azure.Storage.Blobs.Models.BlobRenameResult}. + + + + Undelete a blob that was previously soft deleted + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response + + + + Create the Blob.UndeleteAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.UndeleteAsync Message. + + + + Create the Blob.UndeleteAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.UndeleteAsync Azure.Response. + + + + Sets the time a blob will expire and be deleted. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + Required. Indicates mode of the expiry time + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The time to set the blob to expiry + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobSetExpiryInternal} + + + + Create the Blob.SetExpiryAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + Required. Indicates mode of the expiry time + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The time to set the blob to expiry + The Blob.SetExpiryAsync Message. + + + + Create the Blob.SetExpiryAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.SetExpiryAsync Azure.Response{Azure.Storage.Blobs.Models.BlobSetExpiryInternal}. + + + + The Set HTTP Headers operation sets system properties on the blob + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Optional. Sets the blob's Content-Disposition header. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.SetHttpHeadersOperation} + + + + Create the Blob.SetHttpHeadersAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Optional. Sets the blob's Content-Disposition header. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.SetHttpHeadersAsync Message. + + + + Create the Blob.SetHttpHeadersAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.SetHttpHeadersAsync Azure.Response{Azure.Storage.Blobs.Models.SetHttpHeadersOperation}. + + + + The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more name-value pairs + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.SetMetadataOperation} + + + + Create the Blob.SetMetadataAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.SetMetadataAsync Message. + + + + Create the Blob.SetMetadataAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.SetMetadataAsync Azure.Response{Azure.Storage.Blobs.Models.SetMetadataOperation}. + + + + [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. + Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobLease} + + + + Create the Blob.AcquireLeaseAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. + Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.AcquireLeaseAsync Message. + + + + Create the Blob.AcquireLeaseAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.AcquireLeaseAsync Azure.Response{Azure.Storage.Blobs.Models.BlobLease}. + + + + [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobInfo} + + + + Create the Blob.ReleaseLeaseAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.ReleaseLeaseAsync Message. + + + + Create the Blob.ReleaseLeaseAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.ReleaseLeaseAsync Azure.Response{Azure.Storage.Blobs.Models.BlobInfo}. + + + + [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobLease} + + + + Create the Blob.RenewLeaseAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.RenewLeaseAsync Message. + + + + Create the Blob.RenewLeaseAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.RenewLeaseAsync Azure.Response{Azure.Storage.Blobs.Models.BlobLease}. + + + + [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobLease} + + + + Create the Blob.ChangeLeaseAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the current lease ID on the resource. + Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.ChangeLeaseAsync Message. + + + + Create the Blob.ChangeLeaseAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.ChangeLeaseAsync Azure.Response{Azure.Storage.Blobs.Models.BlobLease}. + + + + [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BrokenLease} + + + + Create the Blob.BreakLeaseAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.BreakLeaseAsync Message. + + + + Create the Blob.BreakLeaseAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.BreakLeaseAsync Azure.Response{Azure.Storage.Blobs.Models.BrokenLease}. + + + + The Create Snapshot operation creates a read-only snapshot of a blob + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobSnapshotInfo} + + + + Create the Blob.CreateSnapshotAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.CreateSnapshotAsync Message. + + + + Create the Blob.CreateSnapshotAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.CreateSnapshotAsync Azure.Response{Azure.Storage.Blobs.Models.BlobSnapshotInfo}. + + + + The Start Copy From URL operation copies a blob or an internet resource to a new blob. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + Optional. Indicates the tier to be set on the blob. + Optional: Indicates the priority with which to rehydrate an archived blob. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + Overrides the sealed state of the destination blob. Service version 2019-12-12 and newer. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobCopyInfo} + + + + Create the Blob.StartCopyFromUriAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + Optional. Indicates the tier to be set on the blob. + Optional: Indicates the priority with which to rehydrate an archived blob. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + Overrides the sealed state of the destination blob. Service version 2019-12-12 and newer. + The Blob.StartCopyFromUriAsync Message. + + + + Create the Blob.StartCopyFromUriAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.StartCopyFromUriAsync Azure.Response{Azure.Storage.Blobs.Models.BlobCopyInfo}. + + + + The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return a response until the copy is complete. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + Optional. Indicates the tier to be set on the blob. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Specify the md5 calculated for the range of bytes that must be read from the copy source. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobCopyInfo} + + + + Create the Blob.CopyFromUriAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + Optional. Indicates the tier to be set on the blob. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Specify the md5 calculated for the range of bytes that must be read from the copy source. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + The Blob.CopyFromUriAsync Message. + + + + Create the Blob.CopyFromUriAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.CopyFromUriAsync Azure.Response{Azure.Storage.Blobs.Models.BlobCopyInfo}. + + + + The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination blob with zero length and full metadata. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response + + + + Create the Blob.AbortCopyFromUriAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.AbortCopyFromUriAsync Message. + + + + Create the Blob.AbortCopyFromUriAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.AbortCopyFromUriAsync Azure.Response. + + + + The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Indicates the tier to be set on the blob. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional: Indicates the priority with which to rehydrate an archived blob. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response + + + + Create the Blob.SetAccessTierAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Indicates the tier to be set on the blob. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional: Indicates the priority with which to rehydrate an archived blob. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + The Blob.SetAccessTierAsync Message. + + + + Create the Blob.SetAccessTierAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.SetAccessTierAsync Azure.Response. + + + + The Query operation enables users to select/project on blob data by providing simple query expressions. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + the query request + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobQueryResult} + + + + Create the Blob.QueryAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + the query request + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Blob.QueryAsync Message. + + + + Create the Blob.QueryAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.QueryAsync Azure.Response{Azure.Storage.Blobs.Models.BlobQueryResult}. + + + + The Get Tags operation enables users to get the tags associated with a blob. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Blob tags + + + + Create the Blob.GetTagsAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + The Blob.GetTagsAsync Message. + + + + Create the Blob.GetTagsAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.GetTagsAsync Azure.Response{Azure.Storage.Blobs.Models.BlobTags}. + + + + The Set Tags operation enables users to set tags on a blob. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + Specify the transactional md5 for the body, to be validated by the service. + Specify the transactional crc64 for the body, to be validated by the service. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Blob tags + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response + + + + Create the Blob.SetTagsAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. + Specify the transactional md5 for the body, to be validated by the service. + Specify the transactional crc64 for the body, to be validated by the service. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Blob tags + The Blob.SetTagsAsync Message. + + + + Create the Blob.SetTagsAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Blob.SetTagsAsync Azure.Response. + + + + PageBlob operations for Azure Blob Storage + + + + + The Create operation creates a new page blob. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The length of the request. + This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Indicates the tier to be set on the page blob. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Sets the blob's Content-Disposition header. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobContentInfo} + + + + Create the PageBlob.CreateAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The length of the request. + This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Indicates the tier to be set on the page blob. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Sets the blob's Content-Disposition header. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + The PageBlob.CreateAsync Message. + + + + Create the PageBlob.CreateAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The PageBlob.CreateAsync Azure.Response{Azure.Storage.Blobs.Models.BlobContentInfo}. + + + + The Upload Pages operation writes a range of pages to a page blob + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Initial data + The length of the request. + Specifies the version of the operation to use for this request. + Specify the transactional md5 for the body, to be validated by the service. + Specify the transactional crc64 for the body, to be validated by the service. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Return only the bytes of the blob in the specified range. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified. + Specify this header value to operate only on a blob if it has a sequence number less than the specified. + Specify this header value to operate only on a blob if it has the specified sequence number. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.PageInfo} + + + + Create the PageBlob.UploadPagesAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Initial data + The length of the request. + Specifies the version of the operation to use for this request. + Specify the transactional md5 for the body, to be validated by the service. + Specify the transactional crc64 for the body, to be validated by the service. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Return only the bytes of the blob in the specified range. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified. + Specify this header value to operate only on a blob if it has a sequence number less than the specified. + Specify this header value to operate only on a blob if it has the specified sequence number. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The PageBlob.UploadPagesAsync Message. + + + + Create the PageBlob.UploadPagesAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The PageBlob.UploadPagesAsync Azure.Response{Azure.Storage.Blobs.Models.PageInfo}. + + + + The Clear Pages operation clears a set of pages from a page blob + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The length of the request. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Return only the bytes of the blob in the specified range. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified. + Specify this header value to operate only on a blob if it has a sequence number less than the specified. + Specify this header value to operate only on a blob if it has the specified sequence number. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.PageInfo} + + + + Create the PageBlob.ClearPagesAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The length of the request. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Return only the bytes of the blob in the specified range. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified. + Specify this header value to operate only on a blob if it has a sequence number less than the specified. + Specify this header value to operate only on a blob if it has the specified sequence number. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The PageBlob.ClearPagesAsync Message. + + + + Create the PageBlob.ClearPagesAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The PageBlob.ClearPagesAsync Azure.Response{Azure.Storage.Blobs.Models.PageInfo}. + + + + The Upload Pages operation writes a range of pages to a page blob where the contents are read from a URL + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specify a URL to the copy source. + Bytes of source data in the specified range. The length of this range should match the ContentLength header and x-ms-range/Range destination range header. + The length of the request. + The range of bytes to which the source range would be written. The range should be 512 aligned and range-end is required. + Specifies the version of the operation to use for this request. + Specify the md5 calculated for the range of bytes that must be read from the copy source. + Specify the crc64 calculated for the range of bytes that must be read from the copy source. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified. + Specify this header value to operate only on a blob if it has a sequence number less than the specified. + Specify this header value to operate only on a blob if it has the specified sequence number. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.PageInfo} + + + + Create the PageBlob.UploadPagesFromUriAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specify a URL to the copy source. + Bytes of source data in the specified range. The length of this range should match the ContentLength header and x-ms-range/Range destination range header. + The length of the request. + The range of bytes to which the source range would be written. The range should be 512 aligned and range-end is required. + Specifies the version of the operation to use for this request. + Specify the md5 calculated for the range of bytes that must be read from the copy source. + Specify the crc64 calculated for the range of bytes that must be read from the copy source. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified. + Specify this header value to operate only on a blob if it has a sequence number less than the specified. + Specify this header value to operate only on a blob if it has the specified sequence number. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The PageBlob.UploadPagesFromUriAsync Message. + + + + Create the PageBlob.UploadPagesFromUriAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The PageBlob.UploadPagesFromUriAsync Azure.Response{Azure.Storage.Blobs.Models.PageInfo}. + + + + The Get Page Ranges operation returns the list of valid page ranges for a page blob or snapshot of a page blob + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Return only the bytes of the blob in the specified range. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.PageRangesInfoInternal} + + + + Create the PageBlob.GetPageRangesAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Return only the bytes of the blob in the specified range. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The PageBlob.GetPageRangesAsync Message. + + + + Create the PageBlob.GetPageRangesAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The PageBlob.GetPageRangesAsync Azure.Response{Azure.Storage.Blobs.Models.PageRangesInfoInternal}. + + + + The Get Page Ranges Diff operation returns the list of valid page ranges for a page blob that were changed between target blob and previous snapshot. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional in version 2015-07-08 and newer. The prevsnapshot parameter is a DateTime value that specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, as long as the snapshot specified by prevsnapshot is the older of the two. Note that incremental snapshots are currently supported only for blobs created on or after January 1, 2016. + Optional. This header is only supported in service versions 2019-04-19 and after and specifies the URL of a previous snapshot of the target blob. The response will only contain pages that were changed between the target blob and its previous snapshot. + Return only the bytes of the blob in the specified range. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.PageRangesInfoInternal} + + + + Create the PageBlob.GetPageRangesDiffAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional in version 2015-07-08 and newer. The prevsnapshot parameter is a DateTime value that specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, as long as the snapshot specified by prevsnapshot is the older of the two. Note that incremental snapshots are currently supported only for blobs created on or after January 1, 2016. + Optional. This header is only supported in service versions 2019-04-19 and after and specifies the URL of a previous snapshot of the target blob. The response will only contain pages that were changed between the target blob and its previous snapshot. + Return only the bytes of the blob in the specified range. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The PageBlob.GetPageRangesDiffAsync Message. + + + + Create the PageBlob.GetPageRangesDiffAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The PageBlob.GetPageRangesDiffAsync Azure.Response{Azure.Storage.Blobs.Models.PageRangesInfoInternal}. + + + + Resize the Blob + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.PageBlobInfo} + + + + Create the PageBlob.ResizeAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + This header specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The PageBlob.ResizeAsync Message. + + + + Create the PageBlob.ResizeAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The PageBlob.ResizeAsync Azure.Response{Azure.Storage.Blobs.Models.PageBlobInfo}. + + + + Update the sequence number of the blob + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Required if the x-ms-blob-sequence-number header is set for the request. This property applies to page blobs only. This property indicates how the service should modify the blob's sequence number + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.PageBlobInfo} + + + + Create the PageBlob.UpdateSequenceNumberAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Required if the x-ms-blob-sequence-number header is set for the request. This property applies to page blobs only. This property indicates how the service should modify the blob's sequence number + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The PageBlob.UpdateSequenceNumberAsync Message. + + + + Create the PageBlob.UpdateSequenceNumberAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The PageBlob.UpdateSequenceNumberAsync Azure.Response{Azure.Storage.Blobs.Models.PageBlobInfo}. + + + + The Copy Incremental operation copies a snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. This API is supported since REST version 2016-05-31. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobCopyInfo} + + + + Create the PageBlob.CopyIncrementalAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The PageBlob.CopyIncrementalAsync Message. + + + + Create the PageBlob.CopyIncrementalAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The PageBlob.CopyIncrementalAsync Azure.Response{Azure.Storage.Blobs.Models.BlobCopyInfo}. + + + + AppendBlob operations for Azure Blob Storage + + + + + The Create Append Blob operation creates a new append blob. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The length of the request. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Sets the blob's Content-Disposition header. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobContentInfo} + + + + Create the AppendBlob.CreateAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The length of the request. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Sets the blob's Content-Disposition header. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + The AppendBlob.CreateAsync Message. + + + + Create the AppendBlob.CreateAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The AppendBlob.CreateAsync Azure.Response{Azure.Storage.Blobs.Models.BlobContentInfo}. + + + + The Append Block operation commits a new block of data to the end of an existing append blob. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Initial data + The length of the request. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify the transactional md5 for the body, to be validated by the service. + Specify the transactional crc64 for the body, to be validated by the service. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed). + Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobAppendInfo} + + + + Create the AppendBlob.AppendBlockAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Initial data + The length of the request. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify the transactional md5 for the body, to be validated by the service. + Specify the transactional crc64 for the body, to be validated by the service. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed). + Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The AppendBlob.AppendBlockAsync Message. + + + + Create the AppendBlob.AppendBlockAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The AppendBlob.AppendBlockAsync Azure.Response{Azure.Storage.Blobs.Models.BlobAppendInfo}. + + + + The Append Block operation commits a new block of data to the end of an existing append blob where the contents are read from a source url. The Append Block operation is permitted only if the blob was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version 2015-02-21 version or later. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specify a URL to the copy source. + The length of the request. + Specifies the version of the operation to use for this request. + Bytes of source data in the specified range. + Specify the md5 calculated for the range of bytes that must be read from the copy source. + Specify the crc64 calculated for the range of bytes that must be read from the copy source. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify the transactional md5 for the body, to be validated by the service. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed). + Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobAppendInfo} + + + + Create the AppendBlob.AppendBlockFromUriAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specify a URL to the copy source. + The length of the request. + Specifies the version of the operation to use for this request. + Bytes of source data in the specified range. + Specify the md5 calculated for the range of bytes that must be read from the copy source. + Specify the crc64 calculated for the range of bytes that must be read from the copy source. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify the transactional md5 for the body, to be validated by the service. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed). + Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The AppendBlob.AppendBlockFromUriAsync Message. + + + + Create the AppendBlob.AppendBlockFromUriAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The AppendBlob.AppendBlockFromUriAsync Azure.Response{Azure.Storage.Blobs.Models.BlobAppendInfo}. + + + + The Seal operation seals the Append Blob to make it read-only. Seal is supported only on version 2019-12-12 version or later. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.AppendBlobSealInternal} + + + + Create the AppendBlob.SealAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed). + The AppendBlob.SealAsync Message. + + + + Create the AppendBlob.SealAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The AppendBlob.SealAsync Azure.Response{Azure.Storage.Blobs.Models.AppendBlobSealInternal}. + + + + BlockBlob operations for Azure Blob Storage + + + + + The Upload Block Blob operation updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a partial update of the content of a block blob, use the Put Block List operation. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Initial data + The length of the request. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify the transactional md5 for the body, to be validated by the service. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Sets the blob's Content-Disposition header. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Optional. Indicates the tier to be set on the blob. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobContentInfo} + + + + Create the BlockBlob.UploadAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Initial data + The length of the request. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify the transactional md5 for the body, to be validated by the service. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Sets the blob's Content-Disposition header. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Optional. Indicates the tier to be set on the blob. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + The BlockBlob.UploadAsync Message. + + + + Create the BlockBlob.UploadAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The BlockBlob.UploadAsync Azure.Response{Azure.Storage.Blobs.Models.BlobContentInfo}. + + + + The Put Blob from URL operation creates a new Block Blob where the contents of the blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are not supported with Put Blob from URL; the content of an existing blob is overwritten with the content of the new blob. To perform partial updates to a block blob’s contents using a source URL, use the Put Block from URL API in conjunction with Put Block List. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The length of the request. + Specifies the version of the operation to use for this request. + Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify the transactional md5 for the body, to be validated by the service. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Sets the blob's Content-Disposition header. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Optional. Indicates the tier to be set on the blob. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Specify the md5 calculated for the range of bytes that must be read from the copy source. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + Optional, default is true. Indicates if properties from the source blob should be copied. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobContentInfo} + + + + Create the BlockBlob.PutBlobFromUrlAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The length of the request. + Specifies the version of the operation to use for this request. + Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Specify the transactional md5 for the body, to be validated by the service. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Sets the blob's Content-Disposition header. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Optional. Indicates the tier to be set on the blob. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Specify the md5 calculated for the range of bytes that must be read from the copy source. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + Optional, default is true. Indicates if properties from the source blob should be copied. + The BlockBlob.PutBlobFromUrlAsync Message. + + + + Create the BlockBlob.PutBlobFromUrlAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The BlockBlob.PutBlobFromUrlAsync Azure.Response{Azure.Storage.Blobs.Models.BlobContentInfo}. + + + + The Stage Block operation creates a new block to be committed as part of a blob + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. + The length of the request. + Initial data + Specifies the version of the operation to use for this request. + Specify the transactional md5 for the body, to be validated by the service. + Specify the transactional crc64 for the body, to be validated by the service. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlockInfo} + + + + Create the BlockBlob.StageBlockAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. + The length of the request. + Initial data + Specifies the version of the operation to use for this request. + Specify the transactional md5 for the body, to be validated by the service. + Specify the transactional crc64 for the body, to be validated by the service. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The BlockBlob.StageBlockAsync Message. + + + + Create the BlockBlob.StageBlockAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The BlockBlob.StageBlockAsync Azure.Response{Azure.Storage.Blobs.Models.BlockInfo}. + + + + The Stage Block operation creates a new block to be committed as part of a blob where the contents are read from a URL. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. + The length of the request. + Specify a URL to the copy source. + Specifies the version of the operation to use for this request. + Bytes of source data in the specified range. + Specify the md5 calculated for the range of bytes that must be read from the copy source. + Specify the crc64 calculated for the range of bytes that must be read from the copy source. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlockInfo} + + + + Create the BlockBlob.StageBlockFromUriAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. + The length of the request. + Specify a URL to the copy source. + Specifies the version of the operation to use for this request. + Bytes of source data in the specified range. + Specify the md5 calculated for the range of bytes that must be read from the copy source. + Specify the crc64 calculated for the range of bytes that must be read from the copy source. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The BlockBlob.StageBlockFromUriAsync Message. + + + + Create the BlockBlob.StageBlockFromUriAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The BlockBlob.StageBlockFromUriAsync Azure.Response{Azure.Storage.Blobs.Models.BlockInfo}. + + + + The Commit Block List operation writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior Put Block operation. You can call Put Block List to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + A list of block IDs split between the committed block list, in the uncommitted block list, or in the uncommitted block list first and then in the committed block list. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Specify the transactional md5 for the body, to be validated by the service. + Specify the transactional crc64 for the body, to be validated by the service. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Sets the blob's Content-Disposition header. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Optional. Indicates the tier to be set on the blob. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.BlobContentInfo} + + + + Create the BlockBlob.CommitBlockListAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + A list of block IDs split between the committed block list, in the uncommitted block list, or in the uncommitted block list first and then in the committed block list. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request. + Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request. + Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request. + Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded. + Specify the transactional md5 for the body, to be validated by the service. + Specify the transactional crc64 for the body, to be validated by the service. + Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. Sets the blob's Content-Disposition header. + Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services. + The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. + Optional. Indicates the tier to be set on the blob. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Optional. A URL encoded query param string which specifies the tags to be created with the Blob object. e.g. TagName1=TagValue1&TagName2=TagValue2. The x-ms-tags header may contain up to 2kb of tags. + The BlockBlob.CommitBlockListAsync Message. + + + + Create the BlockBlob.CommitBlockListAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The BlockBlob.CommitBlockListAsync Azure.Response{Azure.Storage.Blobs.Models.BlobContentInfo}. + + + + The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block blob + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.GetBlockListOperation} + + + + Create the BlockBlob.GetBlockListAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together. + Specifies the version of the operation to use for this request. + The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify a SQL where clause on blob tags to operate only on blobs with a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The BlockBlob.GetBlockListAsync Message. + + + + Create the BlockBlob.GetBlockListAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The BlockBlob.GetBlockListAsync Azure.Response{Azure.Storage.Blobs.Models.GetBlockListOperation}. + + + + Directory operations for Azure Blob Storage + + + + + Create a directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: "*". + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is base64 encoded. + Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. + Only valid if Hierarchical Namespace is enabled for the account. This umask restricts permission settings for file and directory, and will only be applied when default Acl does not exist in parent directory. If the umask bit has set, it means that the corresponding permission will be disabled. Otherwise the corresponding permission will be determined by the permission. A 4-digit octal notation (e.g. 0022) is supported here. If no umask was specified, a default umask - 0027 will be used. + Cache control for given resource + Content type for given resource + Content encoding for given resource + Content language for given resource + Content disposition for given resource + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.DirectoryCreateResult} + + + + Create the Directory.CreateAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is base64 encoded. + Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. + Only valid if Hierarchical Namespace is enabled for the account. This umask restricts permission settings for file and directory, and will only be applied when default Acl does not exist in parent directory. If the umask bit has set, it means that the corresponding permission will be disabled. Otherwise the corresponding permission will be determined by the permission. A 4-digit octal notation (e.g. 0022) is supported here. If no umask was specified, a default umask - 0027 will be used. + Cache control for given resource + Content type for given resource + Content encoding for given resource + Content language for given resource + Content disposition for given resource + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Directory.CreateAsync Message. + + + + Create the Directory.CreateAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Directory.CreateAsync Azure.Response{Azure.Storage.Blobs.Models.DirectoryCreateResult}. + + + + Rename a directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: "*". + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The file or directory to be renamed. The value must have the following format: "/{filesysystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory. + Determines the behavior of the rename operation + Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is base64 encoded. + Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. + Only valid if Hierarchical Namespace is enabled for the account. This umask restricts permission settings for file and directory, and will only be applied when default Acl does not exist in parent directory. If the umask bit has set, it means that the corresponding permission will be disabled. Otherwise the corresponding permission will be determined by the permission. A 4-digit octal notation (e.g. 0022) is supported here. If no umask was specified, a default umask - 0027 will be used. + Cache control for given resource + Content type for given resource + Content encoding for given resource + Content language for given resource + Content disposition for given resource + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.DirectoryRenameResult} + + + + Create the Directory.RenameAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + The file or directory to be renamed. The value must have the following format: "/{filesysystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory. + Determines the behavior of the rename operation + Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is base64 encoded. + Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. + Only valid if Hierarchical Namespace is enabled for the account. This umask restricts permission settings for file and directory, and will only be applied when default Acl does not exist in parent directory. If the umask bit has set, it means that the corresponding permission will be disabled. Otherwise the corresponding permission will be determined by the permission. A 4-digit octal notation (e.g. 0022) is supported here. If no umask was specified, a default umask - 0027 will be used. + Cache control for given resource + Content type for given resource + Content encoding for given resource + Content language for given resource + Content disposition for given resource + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Directory.RenameAsync Message. + + + + Create the Directory.RenameAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Directory.RenameAsync Azure.Response{Azure.Storage.Blobs.Models.DirectoryRenameResult}. + + + + Deletes the directory + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + If "true", all paths beneath the directory will be deleted. If "false" and the directory is non-empty, an error occurs. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.DirectoryDeleteResult} + + + + Create the Directory.DeleteAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + If "true", all paths beneath the directory will be deleted. If "false" and the directory is non-empty, an error occurs. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Directory.DeleteAsync Message. + + + + Create the Directory.DeleteAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Directory.DeleteAsync Azure.Response{Azure.Storage.Blobs.Models.DirectoryDeleteResult}. + + + + Set the owner, group, permissions, or access control list for a directory. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. The owner of the blob or directory. + Optional. The owning group of the blob or directory. + Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. + Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.DirectorySetAccessControlResult} + + + + Create the Directory.SetAccessControlAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Optional. The owner of the blob or directory. + Optional. The owning group of the blob or directory. + Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. + Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Directory.SetAccessControlAsync Message. + + + + Create the Directory.SetAccessControlAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Directory.SetAccessControlAsync Azure.Response{Azure.Storage.Blobs.Models.DirectorySetAccessControlResult}. + + + + Get the owner, group, permissions, or access control list for a directory. + + The ClientDiagnostics instance used for operation reporting. + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + Whether to invoke the operation asynchronously. The default value is true. + Operation name. + Cancellation token. + Azure.Response{Azure.Storage.Blobs.Models.DirectoryGetAccessControlResult} + + + + Create the Directory.GetAccessControlAsync request. + + The pipeline used for sending requests. + The URL of the service account, container, or blob that is the targe of the desired operation. + Specifies the version of the operation to use for this request. + The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. + Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. + If specified, the operation only succeeds if the resource's lease is active and matches this ID. + Specify an ETag value to operate only on blobs with a matching value. + Specify an ETag value to operate only on blobs without a matching value. + Specify this header value to operate only on a blob if it has been modified since the specified date/time. + Specify this header value to operate only on a blob if it has not been modified since the specified date/time. + Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. + The Directory.GetAccessControlAsync Message. + + + + Create the Directory.GetAccessControlAsync response or throw a failure exception. + + The ClientDiagnostics instance to use. + The raw Response. + The Directory.GetAccessControlAsync Azure.Response{Azure.Storage.Blobs.Models.DirectoryGetAccessControlResult}. + + + + Indicates the tier to be set on the blob. + + + + + Initializes a new instance of the structure. + + The string value of the instance. + + + + P4 + + + + + P6 + + + + + P10 + + + + + P15 + + + + + P20 + + + + + P30 + + + + + P40 + + + + + P50 + + + + + P60 + + + + + P70 + + + + + P80 + + + + + Hot + + + + + Cool + + + + + Archive + + + + + Determines if two values are the same. + + The first to compare. + The second to compare. + True if and are the same; otherwise, false. + + + + Determines if two values are different. + + The first to compare. + The second to compare. + True if and are different; otherwise, false. + + + + Converts a string to a . + + The string value to convert. + The AccessTier value. + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the . + + Hash code for the AccessTier. + + + + Convert the to a string. + + String representation of the AccessTier. + + + + AccountInfo + + + + + Identifies the sku name of the account + + + + + Identifies the account kind + + + + + Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled. + + + + + Prevent direct instantiation of AccountInfo instances. + You can use BlobsModelFactory.AccountInfo instead. + + + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + BlobsModelFactory provides utilities for mocking. + + + This class holds BlobModelFactory overloads we need for backwards compatibility. + + + BlobsModelFactory provides utilities for mocking. + + + + + Creates a new AccountInfo instance for mocking. + + + + + Creates a new BlobAppendInfo instance for mocking. + + + + + Creates a new BlobBlock instance for mocking. + + + + + Creates a new BlobContainerAccessPolicy instance for mocking. + + + + + Creates a new BlobContainerInfo instance for mocking. + + + + + Creates a new BlobContainerItem instance for mocking. + + + + + Creates a new BlobContainerProperties instance for mocking. + + + + + Creates a new BlobContentInfo instance for mocking. + + + + + Creates a new BlobCopyInfo instance for mocking. + + + + + Creates a new BlobGeoReplication instance for mocking. + + + + + Creates a new BlobInfo instance for mocking. + + + + + Creates a new BlobItemProperties instance for mocking. + + + + + Creates a new BlobLease instance for mocking. + + + + + Creates a new BlobServiceStatistics instance for mocking. + + + + + Creates a new BlobSnapshotInfo instance for mocking. + + + + + Creates a new BlockInfo instance for mocking. + + + + + Creates a new BlockList instance for mocking. + + + + + Creates a new PageBlobInfo instance for mocking. + + + + + Creates a new PageInfo instance for mocking. + + + + + Creates a new UserDelegationKey instance for mocking. + + + + + Creates a new BlobHierarchyItem instance for mocking. + + + + + Creates a new BlobDownloadInfo instance for mocking. + + + + + Creates a new BlobDownloadInfo instance for mocking. + + + + + Creates a new BlobDownloadInfo instance for mocking. + + + + + Creates a new BlobDownloadInfo instance for mocking. + + + + + Creates a new BlobAppendInfo instance for mocking. + + + + + Creates a new BlobContentInfo instance for mocking. + + + + + Creates a new BlobContentInfo instance for mocking. + + + + + Creates a new BlobProperties instance for mocking. + + + + + Creates a new BlobItemProperties instance for mocking. + + + + + Creates a new BlobItemProperties instance for mocking. + + + + + Creates a new BlobItemProperties instance for mocking. + + + + + Creates a new BlobProperties instance for mocking. + + + + + Creates a new BlobProperties instance for mocking. + + + + + Creates a new BlobProperties instance for mocking. + + + + + Creates a new BlockInfo instance for mocking. + + + + + Creates a new PageInfo instance for mocking. + + + + + Creates a new BlobContainerProperties instance for mocking. + + + + + Creates a new BlobCopyInfo instance for mocking. + + + + + Creates a new BlobItem instance for mocking. + + + + + Creates a new BlobItem instance for mocking. + + + + + Creates a new BlobSnapshotInfo instance for mocking. + + + + + Creates a new BlobInfo instance for mocking. + + + + + Creates a new BlobContainerItem instance for mocking. + + + + + Creates a new BlobContainerProperties instance for mocking. + + + + + Creates a new BlobQueryError instance for mocking. + + + + + Creates a new GetBlobTagResult instance for mocking. + + + + + Creates a new BlobTagItem instance for mocking. + + + + + Creates a new BlobTagItem instance for mocking. + + + + + Creates a new ObjectReplicationPolicy instance for mocking. + + + + + Creates a new ObjectReplicationRule instance for mocking. + + + + + Creates a new BlobDownloadDetails instance for mocking. + + + + + Creates a new BlobContainerProperties instance for mocking. + + + + + Creates a new AccountInfo instance for mocking. + + + + + Creates a new PageRangesInfo instance for mocking. + + + + + Identifies the account kind + + + + + Storage + + + + + BlobStorage + + + + + StorageV2 + + + + + FileStorage + + + + + BlockBlobStorage + + + + + AppendBlobSealInternal + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + If this blob has been sealed + + + + + Prevent direct instantiation of AppendBlobSealInternal instances. + You can use BlobsModelFactory.AppendBlobSealInternal instead. + + + + + ArchiveStatus values + + + + + rehydrate-pending-to-hot + + + + + rehydrate-pending-to-cool + + + + + field of an arrow schema + + + + + Type + + + + + Name + + + + + Precision + + + + + Scale + + + + + Creates a new ArrowFieldInternal instance + + + + + Serialize a ArrowFieldInternal instance as XML. + + The ArrowFieldInternal instance to serialize. + An optional name to use for the root element instead of "Field". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + arrow configuration + + + + + Schema + + + + + Creates a new ArrowTextConfigurationInternal instance + + + + + Serialize a ArrowTextConfigurationInternal instance as XML. + + The ArrowTextConfigurationInternal instance to serialize. + An optional name to use for the root element instead of "ArrowConfiguration". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Blob GetAccessControlResult + + + + + An HTTP entity tag associated with the file or directory. + + + + + The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. + + + + + The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account. + + + + + The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account. + + + + + The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account. + + + + + The POSIX access control list for the file or directory. Included in the response only if the action is "getAccessControl" and Hierarchical Namespace is enabled for the account. + + + + + Prevent direct instantiation of BlobGetAccessControlResult instances. + You can use BlobsModelFactory.BlobGetAccessControlResult instead. + + + + + Blob QueryResult + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + x-ms-meta + + + + + The number of bytes present in the response body. + + + + + The media type of the body of the response. For Download Blob this is 'application/octet-stream' + + + + + Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header. + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. + + + + + This header returns the value that was specified for the Content-Encoding request header + + + + + This header is returned if it was previously specified for the blob. + + + + + This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. + + + + + This header returns the value that was specified for the Content-Language request header. + + + + + The current sequence number for a page blob. This header is not returned for block blobs or append blobs + + + + + The blob's type. + + + + + If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 and x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request) + + + + + Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. + + + + + Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List + + + + + String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. + + + + + Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List + + + + + URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. + + + + + State of the copy operation identified by x-ms-copy-id. + + + + + When a blob is leased, specifies whether the lease is of infinite or fixed duration. + + + + + Lease state of the blob. + + + + + The current lease status of the blob. + + + + + Indicates that the service supports requests for partial blob content. + + + + + The number of committed blocks present in the blob. This header is returned only for append blobs. + + + + + The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). + + + + + The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. + + + + + Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. + + + + + If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range + + + + + Body + + + + + Creates a new BlobQueryResult instance + + + + + Blob RenameResult + + + + + An HTTP entity tag associated with the file or directory. + + + + + The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. + + + + + The size of the resource in bytes. + + + + + Prevent direct instantiation of BlobRenameResult instances. + You can use BlobsModelFactory.BlobRenameResult instead. + + + + + Blob SetAccessControlResult + + + + + An HTTP entity tag associated with the file or directory. + + + + + The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. + + + + + Prevent direct instantiation of BlobSetAccessControlResult instances. + You can use BlobsModelFactory.BlobSetAccessControlResult instead. + + + + + An Access policy + + + An Access policy for Blob Containers + + + + + the date-time the policy is active + + + + + the date-time the policy expires + + + + + the permissions for the acl policy + + + + + Creates a new BlobAccessPolicy instance + + + + + Serialize a BlobAccessPolicy instance as XML. + + The BlobAccessPolicy instance to serialize. + An optional name to use for the root element instead of "AccessPolicy". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Deserializes XML into a new BlobAccessPolicy instance. + + The XML element to deserialize. + A deserialized BlobAccessPolicy instance. + + + + The date-time the policy is active. + This value is non-nullable, please use . + + + + + The date-time the policy expires. + This value is non-nullable, please use . + + + + + Azure Analytics Logging settings. + + + + + The version of Storage Analytics to configure. + + + + + Indicates whether all delete requests should be logged. + + + + + Indicates whether all read requests should be logged. + + + + + Indicates whether all write requests should be logged. + + + + + the retention policy which determines how long the associated data should persist + + + + + Creates a new BlobAnalyticsLogging instance + + + + + Creates a new BlobAnalyticsLogging instance + + Whether to skip initializing nested objects. + + + + Serialize a BlobAnalyticsLogging instance as XML. + + The BlobAnalyticsLogging instance to serialize. + An optional name to use for the root element instead of "Logging". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Deserializes XML into a new BlobAnalyticsLogging instance. + + The XML element to deserialize. + A deserialized BlobAnalyticsLogging instance. + + + + BlobAppendInfo + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. + + + + + This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. + + + + + This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes. + + + + + The number of committed blocks present in the blob. This header is returned only for append blobs. + + + + + The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. + + + + + The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key. + + + + + Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. + + + + + Prevent direct instantiation of BlobAppendInfo instances. + You can use BlobsModelFactory.BlobAppendInfo instead. + + + + + BlobBatchResult + + + + + The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID + + + + + Content + + + + + Prevent direct instantiation of BlobBatchResult instances. + You can use BlobsModelFactory.BlobBatchResult instead. + + + + + Represents a single block in a block blob. It describes the block's ID and size. + + + + + The base64 encoded block ID. + + + + + The block size in bytes. + + + + + Prevent direct instantiation of BlobBlock instances. + You can use BlobsModelFactory.BlobBlock instead. + + + + + Check if two BlobBlock instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Check if two BlobBlock instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the BlobBlock. + + + + + Deserializes XML into a new BlobBlock instance. + + The XML element to deserialize. + A deserialized BlobBlock instance. + + + + BlobContainerAccessPolicy + + + + + Indicated whether data in the container may be accessed publicly and the level of access + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + a collection of signed identifiers + + + + + Creates a new BlobContainerAccessPolicy instance + + + + + BlobContainerInfo + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + Prevent direct instantiation of BlobContainerInfo instances. + You can use BlobsModelFactory.BlobContainerInfo instead. + + + + + An Azure Storage container + + + + + Name + + + + + Deleted + + + + + Version + + + + + Properties of a container + + + + + Creates a new BlobContainerItem instance + + + + + Creates a new BlobContainerItem instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new BlobContainerItem instance. + + The XML element to deserialize. + A deserialized BlobContainerItem instance. + + + + Properties of a container + + + + + Last-Modified + + + + + LeaseStatus + + + + + LeaseState + + + + + LeaseDuration + + + + + PublicAccess + + + + + HasImmutabilityPolicy + + + + + HasLegalHold + + + + + DefaultEncryptionScope + + + + + DenyEncryptionScopeOverride + + + + + DeletedTime + + + + + RemainingRetentionDays + + + + + ETag + + + + + Metadata + + + + + Creates a new BlobContainerProperties instance + + + + + Creates a new BlobContainerProperties instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new BlobContainerProperties instance. + + The XML element to deserialize. + A deserialized BlobContainerProperties instance. + + + + An enumeration of containers + + + + + ServiceEndpoint + + + + + Prefix + + + + + Marker + + + + + MaxResults + + + + + NextMarker + + + + + BlobContainerItems + + + + + Creates a new BlobContainersSegment instance + + + + + Creates a new BlobContainersSegment instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new BlobContainersSegment instance. + + The XML element to deserialize. + A deserialized BlobContainersSegment instance. + + + + BlobContentInfo + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. + + + + + A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. + + + + + The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. + + + + + Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. + + + + + The current sequence number for the page blob. This is only returned for page blobs. + + + + + Prevent direct instantiation of BlobContentInfo instances. + You can use BlobsModelFactory.BlobContentInfo instead. + + + + + BlobCopyInfo + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. + + + + + String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. + + + + + State of the copy operation identified by x-ms-copy-id. + + + + + Prevent direct instantiation of BlobCopyInfo instances. + You can use BlobsModelFactory.BlobCopyInfo instead. + + + + + CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain + + + + + The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS. + + + + + The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated) + + + + + the request headers that the origin domain may specify on the CORS request. + + + + + The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer + + + + + The maximum amount time that a browser should cache the preflight OPTIONS request. + + + + + Creates a new BlobCorsRule instance + + + + + Serialize a BlobCorsRule instance as XML. + + The BlobCorsRule instance to serialize. + An optional name to use for the root element instead of "CorsRule". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Deserializes XML into a new BlobCorsRule instance. + + The XML element to deserialize. + A deserialized BlobCorsRule instance. + + + + Optional. Only possible value is 'permanent', which specifies to permanently delete a blob if blob soft delete is enabled. + + + + + Permanent + + + + + Error codes returned by the service + + + + + Initializes a new instance of the structure. + + The string value of the instance. + + + + AccountAlreadyExists + + + + + AccountBeingCreated + + + + + AccountIsDisabled + + + + + AuthenticationFailed + + + + + AuthorizationFailure + + + + + ConditionHeadersNotSupported + + + + + ConditionNotMet + + + + + EmptyMetadataKey + + + + + InsufficientAccountPermissions + + + + + InternalError + + + + + InvalidAuthenticationInfo + + + + + InvalidHeaderValue + + + + + InvalidHttpVerb + + + + + InvalidInput + + + + + InvalidMd5 + + + + + InvalidMetadata + + + + + InvalidQueryParameterValue + + + + + InvalidRange + + + + + InvalidResourceName + + + + + InvalidUri + + + + + InvalidXmlDocument + + + + + InvalidXmlNodeValue + + + + + Md5Mismatch + + + + + MetadataTooLarge + + + + + MissingContentLengthHeader + + + + + MissingRequiredQueryParameter + + + + + MissingRequiredHeader + + + + + MissingRequiredXmlNode + + + + + MultipleConditionHeadersNotSupported + + + + + OperationTimedOut + + + + + OutOfRangeInput + + + + + OutOfRangeQueryParameterValue + + + + + RequestBodyTooLarge + + + + + ResourceTypeMismatch + + + + + RequestUrlFailedToParse + + + + + ResourceAlreadyExists + + + + + ResourceNotFound + + + + + ServerBusy + + + + + UnsupportedHeader + + + + + UnsupportedXmlNode + + + + + UnsupportedQueryParameter + + + + + UnsupportedHttpVerb + + + + + AppendPositionConditionNotMet + + + + + BlobAlreadyExists + + + + + BlobImmutableDueToPolicy + + + + + BlobNotFound + + + + + BlobOverwritten + + + + + BlobTierInadequateForContentLength + + + + + BlockCountExceedsLimit + + + + + BlockListTooLong + + + + + CannotChangeToLowerTier + + + + + CannotVerifyCopySource + + + + + ContainerAlreadyExists + + + + + ContainerBeingDeleted + + + + + ContainerDisabled + + + + + ContainerNotFound + + + + + ContentLengthLargerThanTierLimit + + + + + CopyAcrossAccountsNotSupported + + + + + CopyIdMismatch + + + + + FeatureVersionMismatch + + + + + IncrementalCopyBlobMismatch + + + + + IncrementalCopyOfEralierVersionSnapshotNotAllowed + + + + + IncrementalCopySourceMustBeSnapshot + + + + + InfiniteLeaseDurationRequired + + + + + InvalidBlobOrBlock + + + + + InvalidBlobTier + + + + + InvalidBlobType + + + + + InvalidBlockId + + + + + InvalidBlockList + + + + + InvalidOperation + + + + + InvalidPageRange + + + + + InvalidSourceBlobType + + + + + InvalidSourceBlobUrl + + + + + InvalidVersionForPageBlobOperation + + + + + LeaseAlreadyPresent + + + + + LeaseAlreadyBroken + + + + + LeaseIdMismatchWithBlobOperation + + + + + LeaseIdMismatchWithContainerOperation + + + + + LeaseIdMismatchWithLeaseOperation + + + + + LeaseIdMissing + + + + + LeaseIsBreakingAndCannotBeAcquired + + + + + LeaseIsBreakingAndCannotBeChanged + + + + + LeaseIsBrokenAndCannotBeRenewed + + + + + LeaseLost + + + + + LeaseNotPresentWithBlobOperation + + + + + LeaseNotPresentWithContainerOperation + + + + + LeaseNotPresentWithLeaseOperation + + + + + MaxBlobSizeConditionNotMet + + + + + NoAuthenticationInformation + + + + + NoPendingCopyOperation + + + + + OperationNotAllowedOnIncrementalCopyBlob + + + + + PendingCopyOperation + + + + + PreviousSnapshotCannotBeNewer + + + + + PreviousSnapshotNotFound + + + + + PreviousSnapshotOperationNotSupported + + + + + SequenceNumberConditionNotMet + + + + + SequenceNumberIncrementTooLarge + + + + + SnapshotCountExceeded + + + + + SnaphotOperationRateExceeded + + + + + SnapshotsPresent + + + + + SourceConditionNotMet + + + + + SystemInUse + + + + + TargetConditionNotMet + + + + + UnauthorizedBlobOverwrite + + + + + BlobBeingRehydrated + + + + + BlobArchived + + + + + BlobNotArchived + + + + + AuthorizationSourceIPMismatch + + + + + AuthorizationProtocolMismatch + + + + + AuthorizationPermissionMismatch + + + + + AuthorizationServiceMismatch + + + + + AuthorizationResourceTypeMismatch + + + + + Determines if two values are the same. + + The first to compare. + The second to compare. + True if and are the same; otherwise, false. + + + + Determines if two values are different. + + The first to compare. + The second to compare. + True if and are different; otherwise, false. + + + + Converts a string to a . + + The string value to convert. + The BlobErrorCode value. + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the . + + Hash code for the BlobErrorCode. + + + + Convert the to a string. + + String representation of the BlobErrorCode. + + + + Required. Indicates mode of the expiry time + + + + + Initializes a new instance of the structure. + + The string value of the instance. + + + + NeverExpire + + + + + RelativeToCreation + + + + + RelativeToNow + + + + + Absolute + + + + + Determines if two values are the same. + + The first to compare. + The second to compare. + True if and are the same; otherwise, false. + + + + Determines if two values are different. + + The first to compare. + The second to compare. + True if and are different; otherwise, false. + + + + Converts a string to a . + + The string value to convert. + The BlobExpiryOptions value. + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the . + + Hash code for the BlobExpiryOptions. + + + + Convert the to a string. + + String representation of the BlobExpiryOptions. + + + + Geo-Replication information for the Secondary Storage Service + + + + + The status of the secondary location + + + + + A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads. + + + + + Prevent direct instantiation of BlobGeoReplication instances. + You can use BlobsModelFactory.BlobGeoReplication instead. + + + + + Deserializes XML into a new BlobGeoReplication instance. + + The XML element to deserialize. + A deserialized BlobGeoReplication instance. + + + + The status of the secondary location + + + + + live + + + + + bootstrap + + + + + unavailable + + + + + BlobInfo + + + BlobInfo + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + Prevent direct instantiation of BlobInfo instances. + You can use BlobsModelFactory.BlobInfo instead. + + + + + The current sequence number for a page blob. This header is not + returned for block blobs or append blobs. + + + + + The versionId of the blob version that was created. + If null, a new blob version was not created. + + + + + An Azure Storage blob + + + + + Name + + + + + Deleted + + + + + Snapshot + + + + + VersionId + + + + + IsCurrentVersion + + + + + Properties of a blob + + + + + Metadata + + + + + Blob tags + + + + + ObjectReplicationMetadata + + + + + Creates a new BlobItemInternal instance + + + + + Creates a new BlobItemInternal instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new BlobItemInternal instance. + + The XML element to deserialize. + A deserialized BlobItemInternal instance. + + + + Properties of a blob + + + + + Last-Modified + + + + + Size in bytes + + + + + Content-Type + + + + + Content-Encoding + + + + + Content-Language + + + + + Content-MD5 + + + + + Content-Disposition + + + + + Cache-Control + + + + + x-ms-blob-sequence-number + + + + + BlobType + + + + + LeaseStatus + + + + + LeaseState + + + + + LeaseDuration + + + + + CopyId + + + + + CopyStatus + + + + + CopySource + + + + + CopyProgress + + + + + CopyStatusDescription + + + + + ServerEncrypted + + + + + IncrementalCopy + + + + + DestinationSnapshot + + + + + RemainingRetentionDays + + + + + AccessTier + + + + + AccessTierInferred + + + + + ArchiveStatus + + + + + CustomerProvidedKeySha256 + + + + + The name of the encryption scope under which the blob is encrypted. + + + + + TagCount + + + + + Expiry-Time + + + + + Sealed + + + + + If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard. + + + + + LastAccessTime + + + + + ETag + + + + + CreatedOn + + + + + CopyCompletedOn + + + + + DeletedOn + + + + + AccessTierChangedOn + + + + + Prevent direct instantiation of BlobItemProperties instances. + You can use BlobsModelFactory.BlobItemProperties instead. + + + + + Deserializes XML into a new BlobItemProperties instance. + + The XML element to deserialize. + A deserialized BlobItemProperties instance. + + + + BlobLease + + + Lease + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + Uniquely identifies a container's or blob's lease + + + + + Prevent direct instantiation of BlobLease instances. + You can use BlobsModelFactory.BlobLease instead. + + + + + Gets the approximate time remaining in the lease period, in + seconds. This is only provided when breaking a lease. + + + + + a summary of request statistics grouped by API in hour or minute aggregates for blobs + + + + + The version of Storage Analytics to configure. + + + + + Indicates whether metrics are enabled for the Blob service. + + + + + the retention policy which determines how long the associated data should persist + + + + + Indicates whether metrics should generate summary statistics for called API operations. + + + + + Creates a new BlobMetrics instance + + + + + Creates a new BlobMetrics instance + + Whether to skip initializing nested objects. + + + + Serialize a BlobMetrics instance as XML. + + The BlobMetrics instance to serialize. + An optional name to use for the root element instead of "Metrics". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Deserializes XML into a new BlobMetrics instance. + + The XML element to deserialize. + A deserialized BlobMetrics instance. + + + + BlobPrefix + + + + + Name + + + + + Prevent direct instantiation of BlobPrefix instances. + You can use BlobsModelFactory.BlobPrefix instead. + + + + + Deserializes XML into a new BlobPrefix instance. + + The XML element to deserialize. + A deserialized BlobPrefix instance. + + + + BlobPropertiesInternal + + + + + Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + Returns the date and time the blob was created. + + + + + x-ms-meta + + + + + Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication. + + + + + Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed). + + + + + The blob's type. + + + + + Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. + + + + + Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List + + + + + String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. + + + + + Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List + + + + + URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. + + + + + State of the copy operation identified by x-ms-copy-id. + + + + + Included if the blob is incremental copy blob. + + + + + Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob. + + + + + When a blob is leased, specifies whether the lease is of infinite or fixed duration. + + + + + Lease state of the blob. + + + + + The current lease status of the blob. + + + + + The number of bytes present in the response body. + + + + + The content type specified for the blob. The default content type is 'application/octet-stream' + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. + + + + + This header returns the value that was specified for the Content-Encoding request header + + + + + This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. + + + + + This header returns the value that was specified for the Content-Language request header. + + + + + This header is returned if it was previously specified for the blob. + + + + + The current sequence number for a page blob. This header is not returned for block blobs or append blobs + + + + + Indicates that the service supports requests for partial blob content. + + + + + The number of committed blocks present in the blob. This header is returned only for append blobs. + + + + + The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). + + + + + The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key. + + + + + Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. + + + + + The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. For a list of allowed premium page blob tiers, see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. For blob storage LRS accounts, valid values are Hot/Cool/Archive. + + + + + For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, the tier is inferred based on its content length and this header will be returned with true value. + + + + + For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier. + + + + + The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set. + + + + + A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. + + + + + The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header. + + + + + The number of tags associated with the blob + + + + + The time this blob will expire. + + + + + If this blob has been sealed + + + + + If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard. + + + + + UTC date/time value generated by the service that indicates the time at which the blob was last read or written to + + + + + Creates a new BlobPropertiesInternal instance + + + + + the retention policy which determines how long the associated data should persist + + + + + Indicates whether a retention policy is enabled for the storage service + + + + + Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted + + + + + Creates a new BlobRetentionPolicy instance + + + + + Serialize a BlobRetentionPolicy instance as XML. + + The BlobRetentionPolicy instance to serialize. + An optional name to use for the root element instead of "RetentionPolicy". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Deserializes XML into a new BlobRetentionPolicy instance. + + The XML element to deserialize. + A deserialized BlobRetentionPolicy instance. + + + + Storage Service Properties. + + + + + Azure Analytics Logging settings. + + + + + a summary of request statistics grouped by API in hour or minute aggregates for blobs + + + + + a summary of request statistics grouped by API in hour or minute aggregates for blobs + + + + + The set of CORS rules. + + + + + The default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions + + + + + the retention policy which determines how long the associated data should persist + + + + + The properties that enable an account to host a static website + + + + + Creates a new BlobServiceProperties instance + + + + + Creates a new BlobServiceProperties instance + + Whether to skip initializing nested objects. + + + + Serialize a BlobServiceProperties instance as XML. + + The BlobServiceProperties instance to serialize. + An optional name to use for the root element instead of "StorageServiceProperties". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Deserializes XML into a new BlobServiceProperties instance. + + The XML element to deserialize. + A deserialized BlobServiceProperties instance. + + + + Statistics for the storage service. + + + + + Geo-Replication information for the Secondary Storage Service + + + + + Creates a new BlobServiceStatistics instance + + + + + Creates a new BlobServiceStatistics instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new BlobServiceStatistics instance. + + The XML element to deserialize. + A deserialized BlobServiceStatistics instance. + + + + BlobSetExpiryInternal + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + Prevent direct instantiation of BlobSetExpiryInternal instances. + You can use BlobsModelFactory.BlobSetExpiryInternal instead. + + + + + signed identifier + + + + + a unique id + + + + + An Access policy + + + + + Creates a new BlobSignedIdentifier instance + + + + + Creates a new BlobSignedIdentifier instance + + Whether to skip initializing nested objects. + + + + Serialize a BlobSignedIdentifier instance as XML. + + The BlobSignedIdentifier instance to serialize. + An optional name to use for the root element instead of "SignedIdentifier". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Deserializes XML into a new BlobSignedIdentifier instance. + + The XML element to deserialize. + A deserialized BlobSignedIdentifier instance. + + + + BlobSnapshotInfo + + + + + Uniquely identifies the snapshot and indicates the snapshot version. It may be used in subsequent requests to access the snapshot + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. + + + + + True if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. For a snapshot request, this header is set to true when metadata was provided in the request and encrypted with a customer-provided key. + + + + + Prevent direct instantiation of BlobSnapshotInfo instances. + You can use BlobsModelFactory.BlobSnapshotInfo instead. + + + + + The properties that enable an account to host a static website + + + + + Indicates whether this account is hosting a static website + + + + + The default name of the index page under each directory + + + + + The absolute path of the custom 404 page + + + + + Absolute path of the default index page + + + + + Creates a new BlobStaticWebsite instance + + + + + Serialize a BlobStaticWebsite instance as XML. + + The BlobStaticWebsite instance to serialize. + An optional name to use for the root element instead of "StaticWebsite". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Deserializes XML into a new BlobStaticWebsite instance. + + The XML element to deserialize. + A deserialized BlobStaticWebsite instance. + + + + BlobTag + + + + + Key + + + + + Value + + + + + Creates a new BlobTag instance + + + + + Serialize a BlobTag instance as XML. + + The BlobTag instance to serialize. + An optional name to use for the root element instead of "Tag". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Deserializes XML into a new BlobTag instance. + + The XML element to deserialize. + A deserialized BlobTag instance. + + + + Blob tags + + + + + BlobTagSet + + + + + Creates a new BlobTags instance + + + + + Creates a new BlobTags instance + + Whether to skip initializing nested objects. + + + + Serialize a BlobTags instance as XML. + + The BlobTags instance to serialize. + An optional name to use for the root element instead of "Tags". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Deserializes XML into a new BlobTags instance. + + The XML element to deserialize. + A deserialized BlobTags instance. + + + + BlobType values + + + + + BlockBlob + + + + + PageBlob + + + + + AppendBlob + + + + + An enumeration of blobs + + + + + ServiceEndpoint + + + + + ContainerName + + + + + Prefix + + + + + Marker + + + + + MaxResults + + + + + NextMarker + + + + + BlobItems + + + + + Creates a new BlobsFlatSegment instance + + + + + Creates a new BlobsFlatSegment instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new BlobsFlatSegment instance. + + The XML element to deserialize. + A deserialized BlobsFlatSegment instance. + + + + An enumeration of blobs + + + + + ServiceEndpoint + + + + + ContainerName + + + + + Prefix + + + + + Marker + + + + + MaxResults + + + + + Delimiter + + + + + NextMarker + + + + + BlobItems + + + + + BlobPrefixes + + + + + Creates a new BlobsHierarchySegment instance + + + + + Creates a new BlobsHierarchySegment instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new BlobsHierarchySegment instance. + + The XML element to deserialize. + A deserialized BlobsHierarchySegment instance. + + + + BlockInfo + + + + + This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. + + + + + This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. + + + + + The SHA-256 hash of the encryption key used to encrypt the block. This header is only returned when the block was encrypted with a customer-provided key. + + + + + Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. + + + + + Prevent direct instantiation of BlockInfo instances. + You can use BlobsModelFactory.BlockInfo instead. + + + + + BlockList + + + A block blob's returned from + . + + + + + CommittedBlocks + + + + + UncommittedBlocks + + + + + Creates a new BlockList instance + + + + + Creates a new BlockList instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new BlockList instance. + + The XML element to deserialize. + A deserialized BlockList instance. + + + + Gets the date and time the container was last modified. Any + operation that modifies the blob, including an update of the + blob's metadata or properties, changes the last-modified time of + the blob. + + + + + The contains a value that you can use to + perform operations conditionally. If the request version is + 2011-08-18 or newer, the ETag value will be in quotes. + + + + + The media type of the body of the response. For the + + operation this is 'application/xml'. + + + + + The size of the blob, in bytes. + + + + + Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together. + + + + + committed + + + + + uncommitted + + + + + all + + + + + A list of block IDs split between the committed block list, in the uncommitted block list, or in the uncommitted block list first and then in the committed block list. + + + + + Committed + + + + + Uncommitted + + + + + Latest + + + + + Creates a new BlockLookupList instance + + + + + Serialize a BlockLookupList instance as XML. + + The BlockLookupList instance to serialize. + An optional name to use for the root element instead of "BlockList". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + BrokenLease + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + Approximate time remaining in the lease period, in seconds. + + + + + Prevent direct instantiation of BrokenLease instances. + You can use BlobsModelFactory.BrokenLease instead. + + + + + ClearRange + + + + + Start + + + + + End + + + + + Prevent direct instantiation of ClearRange instances. + You can use BlobsModelFactory.ClearRange instead. + + + + + Deserializes XML into a new ClearRange instance. + + The XML element to deserialize. + A deserialized ClearRange instance. + + + + ConditionNotMetError + + + Convert ConditionNotMetErrors into StorageRequestFailedExceptions. + + + + + x-ms-error-code + + + + + Prevent direct instantiation of ConditionNotMetError instances. + You can use BlobsModelFactory.ConditionNotMetError instead. + + + + + Create an exception corresponding to the ConditionNotMetError. + + The instance to use. + The failed response. + A RequestFailedException. + + + + CopyStatus values + + + + + pending + + + + + success + + + + + aborted + + + + + failed + + + + + DataLakeStorageError + + + Convert DataLakeStorageError into StorageRequestFailedExceptions. + + + + + The service error response object. + + + + + Creates a new DataLakeStorageError instance + + + + + Creates a new DataLakeStorageError instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new DataLakeStorageError instance. + + The XML element to deserialize. + A deserialized DataLakeStorageError instance. + + + + Create an exception corresponding to the DataLakeStorageError. + + The instance to use. + The failed response. + A RequestFailedException. + + + + The service error response object. + + + + + The service error code. + + + + + The service error message. + + + + + Prevent direct instantiation of DataLakeStorageErrorDetails instances. + You can use BlobsModelFactory.DataLakeStorageErrorDetails instead. + + + + + Deserializes XML into a new DataLakeStorageErrorDetails instance. + + The XML element to deserialize. + A deserialized DataLakeStorageErrorDetails instance. + + + + Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob's snapshots and not the blob itself + + + + + none + + + + + include + + + + + only + + + + + delimited text configuration + + + + + column separator + + + + + field quote + + + + + record separator + + + + + escape char + + + + + has headers + + + + + Creates a new DelimitedTextConfigurationInternal instance + + + + + Serialize a DelimitedTextConfigurationInternal instance as XML. + + The DelimitedTextConfigurationInternal instance to serialize. + An optional name to use for the root element instead of "DelimitedTextConfiguration". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Directory CreateResult + + + + + An HTTP entity tag associated with the file or directory. + + + + + The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. + + + + + The size of the resource in bytes. + + + + + Prevent direct instantiation of DirectoryCreateResult instances. + You can use BlobsModelFactory.DirectoryCreateResult instead. + + + + + Directory DeleteResult + + + + + When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory. + + + + + Prevent direct instantiation of DirectoryDeleteResult instances. + You can use BlobsModelFactory.DirectoryDeleteResult instead. + + + + + Directory GetAccessControlResult + + + + + An HTTP entity tag associated with the file or directory. + + + + + The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. + + + + + The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account. + + + + + The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account. + + + + + The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account. + + + + + The POSIX access control list for the file or directory. Included in the response only if the action is "getAccessControl" and Hierarchical Namespace is enabled for the account. + + + + + Prevent direct instantiation of DirectoryGetAccessControlResult instances. + You can use BlobsModelFactory.DirectoryGetAccessControlResult instead. + + + + + Directory RenameResult + + + + + When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory. + + + + + An HTTP entity tag associated with the file or directory. + + + + + The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. + + + + + The size of the resource in bytes. + + + + + Prevent direct instantiation of DirectoryRenameResult instances. + You can use BlobsModelFactory.DirectoryRenameResult instead. + + + + + Directory SetAccessControlResult + + + + + An HTTP entity tag associated with the file or directory. + + + + + The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time. + + + + + Prevent direct instantiation of DirectorySetAccessControlResult instances. + You can use BlobsModelFactory.DirectorySetAccessControlResult instead. + + + + + The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. + + + + + AES256 + + + + + FailureNoContent + + + Convert FailureNoContent into StorageRequestFailedExceptions. + + + + + x-ms-error-code + + + + + Prevent direct instantiation of FailureNoContent instances. + You can use BlobsModelFactory.FailureNoContent instead. + + + + + Create an exception corresponding to the FailureNoContent. + + The instance to use. + The failed response. + A RequestFailedException. + + + + Blob info from a Filter Blobs API call + + + + + Name + + + + + ContainerName + + + + + Blob tags + + + + + Creates a new FilterBlobItem instance + + + + + Creates a new FilterBlobItem instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new FilterBlobItem instance. + + The XML element to deserialize. + A deserialized FilterBlobItem instance. + + + + The result of a Filter Blobs API call + + + + + ServiceEndpoint + + + + + Where + + + + + Blobs + + + + + NextMarker + + + + + Creates a new FilterBlobSegment instance + + + + + Creates a new FilterBlobSegment instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new FilterBlobSegment instance. + + The XML element to deserialize. + A deserialized FilterBlobSegment instance. + + + + FlattenedContainerItem + + + + + x-ms-meta + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + When a blob is leased, specifies whether the lease is of infinite or fixed duration. + + + + + Lease state of the blob. + + + + + The current lease status of the blob. + + + + + Indicated whether data in the container may be accessed publicly and the level of access + + + + + Indicates whether the container has an immutability policy set on it. + + + + + Indicates whether the container has a legal hold. + + + + + The default encryption scope for the container. + + + + + Indicates whether the container's default encryption scope can be overriden. + + + + + Creates a new FlattenedContainerItem instance + + + + + FlattenedDownloadProperties + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + x-ms-meta + + + + + Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication. + + + + + Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed). + + + + + The number of bytes present in the response body. + + + + + The media type of the body of the response. For Download Blob this is 'application/octet-stream' + + + + + Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header. + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. + + + + + This header returns the value that was specified for the Content-Encoding request header + + + + + This header is returned if it was previously specified for the blob. + + + + + This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. + + + + + This header returns the value that was specified for the Content-Language request header. + + + + + The current sequence number for a page blob. This header is not returned for block blobs or append blobs + + + + + The blob's type. + + + + + If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 and x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request) + + + + + Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. + + + + + Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List + + + + + String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. + + + + + Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List + + + + + URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. + + + + + State of the copy operation identified by x-ms-copy-id. + + + + + When a blob is leased, specifies whether the lease is of infinite or fixed duration. + + + + + Lease state of the blob. + + + + + The current lease status of the blob. + + + + + Indicates that the service supports requests for partial blob content. + + + + + The number of committed blocks present in the blob. This header is returned only for append blobs. + + + + + The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). + + + + + The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. + + + + + Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. + + + + + If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range + + + + + The number of tags associated with the blob + + + + + If this blob has been sealed + + + + + UTC date/time value generated by the service that indicates the time at which the blob was last read or written to + + + + + A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. + + + + + Content + + + + + Creates a new FlattenedDownloadProperties instance + + + + + GetBlockListOperation + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + The media type of the body of the response. For Get Block List this is 'application/xml' + + + + + The size of the blob in bytes. + + + + + Body + + + + + Creates a new GetBlockListOperation instance + + + + + json text configuration + + + + + record separator + + + + + Creates a new JsonTextConfigurationInternal instance + + + + + Serialize a JsonTextConfigurationInternal instance as XML. + + The JsonTextConfigurationInternal instance to serialize. + An optional name to use for the root element instead of "JsonTextConfiguration". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Key information + + + + + The date-time the key is active in ISO 8601 UTC time + + + + + The date-time the key expires in ISO 8601 UTC time + + + + + Creates a new KeyInfo instance + + + + + Serialize a KeyInfo instance as XML. + + The KeyInfo instance to serialize. + An optional name to use for the root element instead of "KeyInfo". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + LeaseDurationType values + + + + + infinite + + + + + fixed + + + + + LeaseState values + + + + + available + + + + + leased + + + + + expired + + + + + breaking + + + + + broken + + + + + LeaseStatus values + + + + + locked + + + + + unlocked + + + + + ListBlobsIncludeItem values + + + + + copy + + + + + deleted + + + + + metadata + + + + + snapshots + + + + + uncommittedblobs + + + + + versions + + + + + tags + + + + + ListContainersIncludeType values + + + + + metadata + + + + + deleted + + + + + PageBlobInfo + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + The current sequence number for the page blob. This is only returned for page blobs. + + + + + Prevent direct instantiation of PageBlobInfo instances. + You can use BlobsModelFactory.PageBlobInfo instead. + + + + + PageInfo + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. + + + + + This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. + + + + + The current sequence number for the page blob. This is only returned for page blobs. + + + + + The SHA-256 hash of the encryption key used to encrypt the pages. This header is only returned when the pages were encrypted with a customer-provided key. + + + + + Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. + + + + + Prevent direct instantiation of PageInfo instances. + You can use BlobsModelFactory.PageInfo instead. + + + + + the list of pages + + + + + PageRange + + + + + ClearRange + + + + + Creates a new PageList instance + + + + + Creates a new PageList instance + + Whether to skip initializing nested objects. + + + + Deserializes XML into a new PageList instance. + + The XML element to deserialize. + A deserialized PageList instance. + + + + PageRange + + + + + Start + + + + + End + + + + + Prevent direct instantiation of PageRange instances. + You can use BlobsModelFactory.PageRange instead. + + + + + Check if two PageRange instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Check if two PageRange instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the PageRange. + + + + + Deserializes XML into a new PageRange instance. + + The XML element to deserialize. + A deserialized PageRange instance. + + + + PageRangesInfoInternal + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + The size of the blob in bytes. + + + + + the list of pages + + + + + Creates a new PageRangesInfoInternal instance + + + + + Determines the behavior of the rename operation + + + + + legacy + + + + + posix + + + + + Specifies whether data in the container may be accessed publicly and the level of access + + + + + none + + + + + container + + + + + blob + + + + + QueryFormat + + + + + The quick query format type. + + + + + delimited text configuration + + + + + json text configuration + + + + + arrow configuration + + + + + Creates a new QueryFormat instance + + + + + Serialize a QueryFormat instance as XML. + + The QueryFormat instance to serialize. + An optional name to use for the root element instead of "QueryFormat". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + The quick query format type. + + + + + delimited + + + + + json + + + + + arrow + + + + + the quick query body + + + + + the query type + + + + + a query statement + + + + + InputSerialization + + + + + OutputSerialization + + + + + Creates a new QueryRequest instance + + + + + Serialize a QueryRequest instance as XML. + + The QueryRequest instance to serialize. + An optional name to use for the root element instead of "QueryRequest". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + QuerySerialization + + + + + Format + + + + + Creates a new QuerySerialization instance + + + + + Serialize a QuerySerialization instance as XML. + + The QuerySerialization instance to serialize. + An optional name to use for the root element instead of "QuerySerialization". + An optional namespace to use for the root element instead of "". + The serialized XML element. + + + + Optional: Indicates the priority with which to rehydrate an archived blob. + + + + + High + + + + + Standard + + + + + Required if the x-ms-blob-sequence-number header is set for the request. This property applies to page blobs only. This property indicates how the service should modify the blob's sequence number + + + + + max + + + + + update + + + + + increment + + + + + SetHttpHeadersOperation + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + The current sequence number for a page blob. This header is not returned for block blobs or append blobs + + + + + Prevent direct instantiation of SetHttpHeadersOperation instances. + You can use BlobsModelFactory.SetHttpHeadersOperation instead. + + + + + SetMetadataOperation + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. + + + + + The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. + + + + + The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key. + + + + + Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. + + + + + Prevent direct instantiation of SetMetadataOperation instances. + You can use BlobsModelFactory.SetMetadataOperation instead. + + + + + Identifies the sku name of the account + + + + + Standard_LRS + + + + + Standard_GRS + + + + + Standard_RAGRS + + + + + Standard_ZRS + + + + + Premium_LRS + + + + + StorageError + + + Convert StorageErrors into StorageRequestFailedExceptions. + + + + + Message + + + + + Code + + + + + Prevent direct instantiation of StorageError instances. + You can use BlobsModelFactory.StorageError instead. + + + + + Deserializes XML into a new StorageError instance. + + The XML element to deserialize. + A deserialized StorageError instance. + + + + Additional error information. + + + + + Create an exception corresponding to the StorageError. + + The instance to use. + The failed response. + A RequestFailedException. + + + + A user delegation key + + + + + The Azure Active Directory object ID in GUID format. + + + + + The Azure Active Directory tenant ID in GUID format + + + + + Abbreviation of the Azure Storage service that accepts the key + + + + + The service version that created the key + + + + + The key as a base64 string + + + + + The date-time the key expires + + + + + The date-time the key is active + + + + + Prevent direct instantiation of UserDelegationKey instances. + You can use BlobsModelFactory.UserDelegationKey instead. + + + + + Deserializes XML into a new UserDelegationKey instance. + + The XML element to deserialize. + A deserialized UserDelegationKey instance. + + + + Optional parameters for creating an Append Blob. + + + + + Optional standard HTTP header properties that can be set for the + new append blob. + + + + + Optional custom metadata to set for this append blob. + + + + + Options tags to set for this append blob. + + + + + Optional to add + conditions on the creation of this new append blob. + + + + + Optional parameters for Append Blob Open Write. + + + + + The size of the buffer to use. Default is 4 MB, + max is 4 MB. See . + + + + + Access conditions used to open the write stream. + + + + + Optional to provide + progress updates about data transfers. + + + + + Specifies append blob specific access conditions. + + + + + IfAppendPositionEqual ensures that the AppendBlock operation + succeeds only if the append position is equal to a value. + + + + + IfMaxSizeLessThanOrEqual ensures that the AppendBlock operation + succeeds only if the append blob's size is less than or equal to + a value. + + + + + Collect any request conditions. Conditions should be separated by + a semicolon. + + The collected conditions. + + + + Encryption scope options to be used when creating a container. + + + + + Specifies the default encryption scope to set on the container and use for all future writes. + + + + + If true, prevents any request from specifying a different encryption scope than the scope set on the container. + + + + + Specifies options for listing blob containers with the + + operation. + + + + + Default flag specifying that no flags are set in . + + + + + Flag specifying that deleted containers should be included. + + + + + Specifies options for listing blob containers with the + + operation. + + + + + Default flag specifying that no flags are set in . + + + + + Flag specifying that the container's metadata should + be included. + + + + + Optional parameters for Start Copy from URL. + + + + + Optional custom metadata to set for this append blob. + + + + + Options tags to set for this append blob. + + + + + Optional + Indicates the tier to be set on the blob. + + + + + Optional to add + conditions on the copying of data from this source blob. + + + + + Optional to add conditions on + the copying of data to this blob. + + + + + Optional + Indicates the priority with which to rehydrate an archived blob. + + This parameter is not valid for synchronous copies. + + + + + If the destination blob should be sealed. + Only applicable for Append Blobs. + + This parameter is not valid for synchronous copies. + + + + + Either a or returned from + . + + + + + Gets a prefix, relative to the delimiter used to get the blobs. + + + + + Gets a blob. + + + + + Gets a value indicating if this item represents a . + + + + + Gets a value indicating if this item represents a . + + + + + Initialies a new instance of the BlobHierarchyItem class. + + + A prefix, relative to the delimiter used to get the blobs. + + + A blob. + + + + + Standard HTTP properties supported by containers and blobs. + These properties are represented as standard HTTP headers use standard + names, as specified in the Header Field Definitions section 14 of the + HTTP/1.1 protocol specification. + + For more information, see + + Setting and retrieving properties and metadata for Blob service resources. + + + + + The MIME content type of the blob. + + + + + An MD5 hash of the blob content. This hash is used to verify the + integrity of the blob during transport. When this header is + specified, the storage service checks the hash that has arrived + with the one that was sent. If the two hashes do not match, the + operation will fail with error code 400 (Bad Request). + + + + + Specifies which content encodings have been applied to the blob. + This value is returned to the client when the Get Blob operation + is performed on the blob resource. The client can use this value + when returned to decode the blob content. + + + + + Specifies the natural languages used by this resource. + + + + + Conveys additional information about how to process the response + payload, and also can be used to attach additional metadata. For + example, if set to attachment, it indicates that the user-agent + should not display the response, but instead show a Save As dialog + with a filename other than the blob name specified. + + + + + Specify directives for caching mechanisms. + + + + + Creates a string representation of a + . + + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the . + + Hash code for the . + + + + The details and Content returned from downloading a blob + + + + + Internal flattened property representation + + + + + The blob's type. + + + + + The number of bytes present in the response body. + + + + + Content + + + + + The media type of the body of the response. For Download Blob this is 'application/octet-stream' + + + + + If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity. + + + + + Details returned when downloading a Blob + + + + + Creates a new DownloadInfo backed by FlattenedDownloadProperties + + The FlattenedDownloadProperties returned with the request + + + + Disposes the BlobDownloadInfo by calling Dispose on the underlying Content stream. + + + + + Details returned when downloading a Blob + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + x-ms-meta + + + + + Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header. + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + This header returns the value that was specified for the Content-Encoding request header + + + + + This header is returned if it was previously specified for the blob. + + + + + This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified. + + + + + This header returns the value that was specified for the Content-Language request header. + + + + + The current sequence number for a page blob. This header is not returned for block blobs or append blobs + + + + + Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. + + + + + Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List + + + + + String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy. + + + + + Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List + + + + + URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. + + + + + State of the copy operation identified by x-ms-copy-id. + + + + + When a blob is leased, specifies whether the lease is of infinite or fixed duration. + + + + + Lease state of the blob. + + + + + The current lease status of the blob. + + + + + Indicates that the service supports requests for partial blob content. + + + + + The number of committed blocks present in the blob. This header is returned only for append blobs. + + + + + The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted). + + + + + The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key. + + + + + The encryption scope used to encrypt the blob. + + + + + If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range + + + + + The number of tags associated with the blob. + + + + + A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. + + + + + If this blob is sealed. + + + + + x-ms-or + + + + + Object Replication Policy Id. This value is only set when the policy id + + + + + Returns the date and time the blob was read or written to. + + + + + An Azure Storage blob. + + + + + Name. + + + + + Deleted. + + + + + Snapshot. + + + + + VersionId. + + + + + IsCurrentVersion. + + + + + Properties of a blob. + + + + + Metadata. + + + + + Tags. + + + + + Object Replication Metadata (OrMetadata) + + + + + Specifies access conditions for leasing operations on a container or blob. + + + + + Optional SQL statement to apply to the Tags of the Blob. + + + + + Optional parameters for + + + + + The position within the blob to begin the stream. + Defaults to the beginning of the blob. + + + + + The buffer size to use when the stream downloads parts + of the blob. Defaults to 4 MB. + + + + + Optional to add conditions on + the download of the blob. + + + + + Constructor. + + + If false, a will be thrown if the blob is modified while + it is being read from. + + + + + Propeties of a Blob + + + + + Returns the date and time the blob was last modified. Any operation that modifies the blob, + including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + Returns the date and time the blob was created. + + + + + Metadata. + + + + + Object Replication Policy Id of the destination blob. + + + + + Parsed Object Replication Policy Id, Rule Id(s) and status of the source blob. + + + + + The blob's type. + + + + + Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. + This value can specify the time of a completed, aborted, or failed copy attempt. This header does + not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, + or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, + Put Blob, or Put Block List. + + + + + Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or + non-fatal copy operation failure. This header does not appear if this blob has never been the destination + in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using + Set Blob Properties, Put Blob, or Put Block List + + + + + String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy + operation, or pass to Abort Copy Blob to abort a pending copy. + + + + + Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob + operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. + This header does not appear if this blob has never been the destination in a Copy Blob operation, or + if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put + Blob, or Put Block List. + + + + + URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob + operation where this blob was the destination blob. This header does not appear if this blob has never + been the destination in a Copy Blob operation, or if this blob has been modified after a concluded + Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List. + + + + + State of the copy operation identified by x-ms-copy-id. + + + + + Included if the blob is incremental copy blob. + + + + + Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. + Snapshot time of the last successful incremental copy snapshot for this blob. + + + + + When a blob is leased, specifies whether the lease is of infinite or fixed duration. + + + + + Lease state of the blob. + + + + + The current lease status of the blob. + + + + + The number of bytes present in the response body. + + + + + The content type specified for the blob. The default content type is 'application/octet-stream'. + + + + + The ETag contains a value that you can use to perform operations conditionally. + If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + If the blob has an MD5 hash and this operation is to read the full blob, this response header is + returned so that the client can check for message content integrity. + + + + + This header returns the value that was specified for the Content-Encoding request header. + + + + + This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. + The Content-Disposition response header field conveys additional information about how to process + the response payload, and also can be used to attach additional metadata. For example, if set to + attachment, it indicates that the user-agent should not display the response, but instead show a + Save As dialog with a filename other than the blob name specified. + + + + + This header returns the value that was specified for the Content-Language request header. + + + + + This header is returned if it was previously specified for the blob. + + + + + The current sequence number for a page blob. This header is not returned for block blobs or append blobs. + + + + + Indicates that the service supports requests for partial blob content. + + + + + The number of committed blocks present in the blob. This header is returned only for append blobs. + + + + + The value of this header is set to true if the blob data and application metadata are completely encrypted + using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if + only parts of the blob/application metadata are encrypted). + + + + + The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the + metadata was encrypted with a customer-provided key. + + + + + Returns the name of the encryption scope used to encrypt the blob contents and application metadata. + Note that the absence of this header implies use of the default account encryption scope. + + + + + The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. + For a list of allowed premium page blob tiers, see + https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. For blob + storage LRS accounts, valid values are Hot/Cool/Archive. + + + + + For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, + the tier is inferred based on its content length and this header will be returned with true value. + + + + + For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. + If the blob is being rehydrated and is not complete then this header is returned indicating that + rehydrate is pending and also tells the destination tier. + + + + + The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set. + + + + + A DateTime value returned by the service that uniquely identifies the blob. The value of this header + indicates the blob version, and may be used in subsequent requests to access this version of the blob. + + + + + The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header. + + + + + The number of tags associated with the blob. + + + + + The time this blob will expire. + + + + + If this blob has been sealed. + + + + + If this blob is in rehydrate pending state, this indicates the rehydrate priority. + + + + + Returns the date and time the blob was read or written to. + + + + + Constructor. + + + + + Describe a field in . + + + + + The type of the field. Required. + + + + + The name of the field. Optional. + + + + + The precision of the field. Required if Type is . + + + + + The scale of the field. Required if Type is . + + + + + The type of a . + + + + + Int64. + + + + + Bool. + + + + + Timestamp in milliseconds. + + + + + String. + + + + + Double. + + + + + Decimal. + + + + + Arrow configuration. Only valid for . + + + + + List of describing the schema of the data. + + + + + CSV text configuration. + + + + + Record Separator. + + + + + Column separator. + + + + + Field quote. + + + + + Escape character. + + + + + Has headers. + + + + + Blob query error. + + + + + Name. + + + + + Description. + + + + + If the error is a fatal error. + + + + + The position of the error. + + + + + JSON text configuration. + + + + + Record Separator. + + + + + Optional parameters for . + + + + + Optional input text configuration. + + + + + Optional output text configuration. + + + + + Optional callback for error handling. + + + + + Internal error handler. + + + + + Optional to add conditions on the query. + + + + + Optional progress handler. + + + + + Blob Query Text Configuration. + See and . + + + + + Specifies blob lease access conditions for a container or blob. + + + + + Optionally limit requests to resources with an active lease + matching this Id. + + + + + Converts the value of the current RequestConditions object to + its equivalent string representation. + + + A string representation of the RequestConditions. + + + + + Collect any request conditions. Conditions should be separated by + a semicolon. + + The collected conditions. + + + + Specifies states to be used to determine the blobs that will be included + when using the and + + operations. + + + + + Default flag specifying that no flags are set in . + + + + + Flag specifying that the blob's snapshots should be + included. Snapshots are listed from oldest to newest. + + + + + Flag specifying that blobs for which blocks have + been uploaded, but which have not been committed using + should be + included. + + + + + Flag specifying that soft deleted blobs should be + included in the response. + + + + + Flag specifying that the blob's version should be + included. Versions are listed from oldest to newest. + + + + + Flag specifying that blobs of all states should be included. + + + + + Optional parameters for . + + + + + The copy source blob properties behavior. If true, the properties + of the source blob will be copied to the new blob. Default is true. + + + + + Optional standard HTTP header properties that can be set for the + new append blob. + + + + + Options tags to set for this block blob. + + + + + Optional to add + conditions on the copyig of data to this Block Blob. + + + + + Optional to add + conditions on the copying of data from this source blob. + + + + + Optional to set on the + Block Blob. + + + + + Optional. An MD5 hash of the content. This hash is used to verify the integrity of the content during + transport. When this header is specified, the storage service compares the hash of the content that has arrived + with this header value. Note that this MD5 hash is not stored with the blob.If the two hashes do not match, the + operation will fail. + + + + + Specifies trait information to be included when listing blobs with the + and + + operations. + + + + + Flag specifying only the default information for blobs + should be included. + + + + + Flag specifying that metadata related to any current + or previous copy operation should be included. + + + + + Flag specifying that the blob's metadata should be + included. + + + + + Flat specifying that the blob's tags should be included. + + + + + Flag specifying that all traits should be included. + + + + + Optional paratmers for uploading to a Blob. + + + + + Optional standard HTTP header properties that can be set for the + new append blob. + + + + + Optional custom metadata to set for this append blob. + + + + + Options tags to set for this block blob. + + + + + Optional to add + conditions on the upload of this Block Blob. + + + + + Optional to provide + progress updates about data transfers. + + + + + Optional to set on the + Block Blob. + + + + + Optional to configure + parallel transfer behavior. + + + + + Optional parameters for Page Blob Open Write. + + + + + The size of the buffer to use. Default is 4 MB, + max is 4000 MB. See . + + + + + Access conditions used to open the write stream. + + + + + Optional to provide + progress updates about data transfers. + + + + + Optional standard HTTP header properties that can be set for this block blob. + + + + + Optional custom metadata to set for this block blob. + + + + + Options tags to set for this block blob. + + + + + Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together. + + + + + Flag to specify returning both committed and uncommitted blocks. + + + + + Flag to specify returning the list of committed blocks. + + + + + Flag to specify returning the list of uncommitted blocks. + + + + + Optional paraters for commiting a block list to a + Block Blob. + + + + + Optional standard HTTP header properties that can be set for the + new block blob. + + + + + Optional custom metadata to set for this block blob. + + + + + Options tags to set for this block blob. + + + + + Optional to add + conditions on the upload of this Block Blob. + + + + + Optional to set on the + Block Blob. + + + + + Initializes a new instance of the structure. + + The string value of the instance. + + + + Label for bytes as the measurement of content range. + + + + + Determines if two values are the same. + + The first to compare. + The second to compare. + True if and are the same; otherwise, false. + + + + Determines if two values are different. + + The first to compare. + The second to compare. + True if and are different; otherwise, false. + + + + Converts a string to a . + + The string value to convert. + + + Indicates whether this instance and a specified object are equal.The object to compare with the current instance. if and this instance are the same type and represent the same value; otherwise, . + + + + + + Returns the hash code for this instance.A 32-bit signed integer that is the hash code for this instance. + + + Returns the fully qualified type name of this instance.The fully qualified type name. + + + + Inclusive index where the range starts, measured in this instance's . + + + + + Inclusive index where the range ends, measured in this instance's . + + + + + Size of this range, measured in this instance's . + + + + + Unit this range is measured in. Generally "bytes". + + + + + An for tracking the status of a + + request. Its upon successful + completion will be the number of bytes copied. + + + + + Gets a value indicating whether the operation has completed. + + + + + Gets a value indicating whether the operation completed and + successfully produced a value. The + property is the number of bytes copied by the operation. + + + + + Gets an ID representing the operation that can be used to poll for + the status of the long-running operation. + + + + + Gets the number of bytes copied by the operation. + + + + + The last HTTP response received from the server. + + The last response returned from the server during the lifecycle of this instance. + An instance of Operation sends requests to a server in UpdateStatusAsync, UpdateStatus, and other methods. + Responses from these requests can be accessed using GetRawResponse. + + + + + Periodically calls the server till the long-running operation completes. + A used for the periodical service calls.The last HTTP response received from the server. + This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation. + + + + + Periodically calls the server till the long-running operation completes. + + The interval between status requests to the server. + The interval can change based on information returned from the server. + For example, the server might communicate to the client that there is not reason to poll for status change sooner than some time. + A used for the periodical service calls.The last HTTP response received from the server. + This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation. + + + + + Initializes a new instance for + mocking. + + + + + Initializes a new instance + + + The client used to check for completion. + + The ID of this operation. + + + + Initializes a new instance + + + The client used to check for completion. + + The ID of this operation. + + Either the response from initiating the operation or getting the + status if we're creating an operation from an existing ID. + + + Optional to propagate + notifications that the operation should be cancelled. + + + + + Check for the latest status of the copy operation. + + + Optional to propagate + notifications that the operation should be cancelled. + + The with the status update. + + + + Check for the latest status of the copy operation. + + + Optional to propagate + notifications that the operation should be cancelled. + + The with the status update. + + + + Wrapper for an encryption key to be used with client provided key server-side encryption. + + + + + Base64 encoded string of the AES256 encryption key. + + + + + Base64 encoded string of the AES256 encryption key's SHA256 hash. + + + + + The algorithm for Azure Blob Storage to encrypt with. + Azure Blob Storage only offers AES256 encryption. + + + + + Creates a new CustomerProvidedKey for use in server-side encryption. + + The encryption key encoded as a base64 string. + + + + Creates a new CustomerProvidedKey for use in server-side encryption. + + The encryption key bytes. + + + + Checks if two CustomerProvidedKeyInfo are equal to each other. + + The other instance to compare to. + + + + Get a hash code for the CustomerProvidedKeyInfo. + + Hash code for the CustomerProvidedKeyInfo. + + + + Check if two CustomerProvidedKeyInfo instances are equal. + + The first instance to compare. + The second instance to compare. + True if they're equal, false otherwise. + + + + Check if two CustomerProvidedKeyInfo instances are not equal. + + The first instance to compare. + The second instance to compare. + True if they're not equal, false otherwise. + + + + Checks if two CustomerProvidedKeyInfo are equal to each other. + + The other instance to compare to. + + + + + ToString + + string + + + + The result of BlobBaseClient.GetTags() call. + + + + + Blob Tags. + + + + + Contains Object Replication Policy ID and the respective list of + (s). This is used when retrieving the + Object Replication Properties on the source blob. The policy id for the + destination blob is set in ObjectReplicationDestinationPolicyId of the respective + method responses. (e.g. , + ). + + + + + The Object Replication Policy ID. + + + + + The Rule ID(s) and respective Replication Status(s) that are under + the Policy ID. + + + + + Contains the Object Replication Rule ID and Replication Status( + ) of a blob. + There can be more than one under a + . Object Replication Rule IDs + + + + + The Object Replication Rule ID. + + + + + The Replication Status. See . + + + + + Specifies the Replication Status of a blob. This is used when a storage account + has Object Replication Policy(s) applied. See + and . + + + + + Object Replication to the + destination completed. + + + + + Object Replication to the + destination container failed. + + + + + Optional parameters for creating an Page Blob. + + + + + Optional user-controlled value that you can use to track requests. + The value of the SequenceNumber must be between + 0 and 2^63 - 1. The default value is 0. + + + + + Optional standard HTTP header properties that can be set for the + new page blob. + + + + + Optional to add + conditions on the creation of this new page blob. + + + + + Optional custom metadata to set for this page blob. + + + + + Options tags to set for this append blob. + + + + + Optional parameters for Page Blob Open Write. + + + + + The size of the buffer to use. Default is 4 MB, + max is 4 MB. Must be a increment of 512. See . + + + + + Access conditions used to open the write stream. + + + + + Optional to provide + progress updates about data transfers. + + + + + Required if overwrite is set to true, or the underlying + Page Blob is being created for the first time. + Specifies the size of the new Page Blob. + + + + + Specifies page blob specific access conditions. + + + + + IfSequenceNumberLessThan ensures that the page blob operation + succeeds only if the blob's sequence number is less than a value. + + + + + IfSequenceNumberLessThanOrEqual ensures that the page blob + operation succeeds only if the blob's sequence number is less than + or equal to a value. + + + + + IfSequenceNumberEqual ensures that the page blob operation + succeeds only if the blob's sequence number is equal to a value. + + + + + Collect any request conditions. Conditions should be separated by + a semicolon. + + The collected conditions. + + + + Contains blob page range information returned from the PageBlobClient.GetPageRanges operations. + + + + + Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. + + + + + The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. + + + + + The size of the blob in bytes. + + + + + Page ranges for the blob. + + + + + Clear ranges for the blob. + + + + + Creates a new PageRangesInfo instance + + + + + Provides the version state of a successfully released blob or container + object. + + + + + The ETag contains a value that you can use to perform operations + conditionally. If the request version is 2011-08-18 or newer, the + ETag value will be in quotes. + + + + + Returns the date and time the object was last modified. Any + operation that modifies the blob or container, including an update + of the object's metadata or properties, changes the last-modified + time of the object. + + + + + Creates a new . + + + The contains a value that you can use to perform + operations conditionally. + + + The date and time the object was last modified. + + + + + Creates a new . + + A released . + + + + Creates a new . + + A released . + + + + Creates a string representation of a + . + + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the . + + Hash code for the . + + + + Blob info from a FindBlobsByTags. + + + + + Blob Name. + + + + + Container Name. + + + + + Blob Tags. + + + + + Prevent direct instantiation of FilterBlobItem instances. + You can use BlobsModelFactory.FilterBlobItem instead. + + + + + Quick Query extensions. + + + + + contains the list of + permissions that can be set for a blob account's access policy. Use + + to set the permissions on the . + + + + + Indicates that Read is permitted. + + + + + Indicates that Add is permitted. + + + + + Indicates that Create is permitted. + + + + + Indicates that Write is permitted. + + + + + Indicates that Delete is permitted. + + + + + Indicates that List is permitted. + + + + + Indicates that all permissions are set. + + + + + contains the list of + permissions that can be set for a blob's access policy. Use + + to set the permissions on the . + + + + + Indicates that Read is permitted. + + + + + Indicates that Add is permitted. + + + + + Indicates that Create is permitted. + + + + + Indicates that Write is permitted. + + + + + Indicates that Delete is permitted. + + + + + Indicates that List is permitted. + + + + + Indicates that reading and writing Tags are permitted. + + + + + Indicates that deleting a Blob Version is permitted. + + + + + Indicates that Move is permitted. + + + + + Indicates that Execute is permitted. + + + + + Indicates that all permissions are set. + + + + + is used to generate a Shared Access + Signature (SAS) for an Azure Storage container or blob. + For more information, see + + Create a service SAS. + + + + + The storage service version to use to authenticate requests made + with this shared access signature, and the service version to use + when handling requests made with this shared access signature. + + + This property has been deprecated and we will always use the latest + storage SAS version of the Storage service supported. This change + does not have any impact on how your application generates or makes + use of SAS tokens. + + + + + The optional signed protocol field specifies the protocol + permitted for a request made with the SAS. Possible values are + , + , and + . + + + + + Optionally specify the time at which the shared access signature + becomes valid. If omitted when DateTimeOffset.MinValue is used, + start time for this call is assumed to be the time when the + storage service receives the request. + + + + + The time at which the shared access signature becomes invalid. + This field must be omitted if it has been specified in an + associated stored access policy. + + + + + The permissions associated with the shared access signature. The + user is restricted to operations allowed by the permissions. This + field must be omitted if it has been specified in an associated + stored access policy. The , + , , + or can be used to create the + permissions string. + + + + + Specifies an IP address or a range of IP addresses from which to + accept requests. If the IP address from which the request + originates does not match the IP address or address range + specified on the SAS token, the request is not authenticated. + When specifying a range of IP addresses, note that the range is + inclusive. + + + + + An optional unique value up to 64 characters in length that + correlates to an access policy specified for the container. + + + + + The name of the blob container being made accessible. + + + + + The name of the blob being made accessible, or + for a container SAS. + + + + + The name of the snapshot being made accessible, or + for a blob SAS. + + + + + The name of the blob version being made accessible, or + for a blob SAS. + + + + + Specifies which resources are accessible via the shared access + signature. + + Specify "b" if the shared resource is a blob. This grants access to + the content and metadata of the blob. + + Specify "c" if the shared resource is a blob container. This grants + access to the content and metadata of any blob in the container, + and to the list of blobs in the container. + + Beginning in version 2018-11-09, specify "bs" if the shared resource + is a blob snapshot. This grants access to the content and + metadata of the specific snapshot, but not the corresponding root + blob. + + Beginning in version 2019-12-12, specify "bv" if the shared resource + is a blob version. This grants access to the content and + metadata of the specific version, but not the corresponding root + blob. + + + + + Override the value returned for Cache-Control response header. + + + + + Override the value returned for Content-Disposition response + header. + + + + + Override the value returned for Cache-Encoding response header. + + + + + Override the value returned for Cache-Language response header. + + + + + Override the value returned for Cache-Type response header. + + + + + Optional. Beginning in version 2020-02-10, this value will be used for + the AAD Object ID of a user authorized by the owner of the + User Delegation Key to perform the action granted by the SAS. + The Azure Storage service will ensure that the owner of the + user delegation key has the required permissions before granting access. + No additional permission check for the user specified in this value will be performed. + This is only used with generating User Delegation SAS. + + + + + Optional. Beginning in version 2020-02-10, this value will be used for + to correlate the storage audit logs with the audit logs used by the + principal generating and distributing SAS. This is only used for + User Delegation SAS. + + + + + Initializes a new instance of the + class. + + + This constructor has been deprecated. Please consider using + + to create a Service SAS. This change does not have any impact on how + your application generates or makes use of SAS tokens. + + + + + Initializes a new instance of the + class to create a Blob Service Sas. + + + The time at which the shared access signature becomes invalid. + This field must be omitted if it has been specified in an + associated stored access policy. + + + The time at which the shared access signature becomes invalid. + This field must be omitted if it has been specified in an + associated stored access policy. + + + + + Initializes a new instance of the + class to create a Blob Container Service Sas. + + + The time at which the shared access signature becomes invalid. + This field must be omitted if it has been specified in an + associated stored access policy. + + + The time at which the shared access signature becomes invalid. + This field must be omitted if it has been specified in an + associated stored access policy. + + + + + Sets the permissions for a blob SAS. + + + containing the allowed permissions. + + + + + Sets the permissions for a blob account level SAS. + + + containing the allowed permissions. + + + + + Sets the permissions for a blob container SAS. + + + containing the allowed permissions. + + + + + Sets the permissions for a Snapshot SAS. + + + containing the allowed permissions. + + + + + Sets the permissions for a Version SAS. + + + containing the allowed permissions. + + + + + Sets the permissions for the SAS using a raw permissions string. + + + Raw permissions string for the SAS. + + + If the permissions should be validated and correctly ordered. + + + + + Sets the permissions for the SAS using a raw permissions string. + + Raw permissions string for the SAS. + + + + Use an account's to sign this + shared access signature values to produce the proper SAS query + parameters for authenticating requests. + + + The storage account's . + + + The used for authenticating + requests. + + + + + Use an account's to sign this + shared access signature values to produce the proper SAS query + parameters for authenticating requests. + + + A returned from + . + + The name of the storage account. + + The used for authenticating requests. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Check if two BlobSasBuilder instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the BlobSasBuilder. + + Hash code for the BlobSasBuilder. + + + + contains the list of + permissions that can be set for a blob's access policy. Use + + to set the permissions on the . + + + + + Indicates that Read is permitted. + + + + + Indicates that Add is permitted. + + + + + Indicates that Create is permitted. + + + + + Indicates that Write is permitted. + + + + + Indicates that Delete is permitted. + + + + + Indicates that reading and writing Tags are permitted. + + + + + Indicates that deleting a Blob Version is permitted. + + + + + Indicates that List is permitted. + + + + + Indicates that Move is permitted. + + + + + Indicates that Execute is permitted. + + + + + Indicates that all permissions are set. + + + + + A object represents the components + that make up an Azure Storage Shared Access Signature's query + parameters. You can construct a new instance using + . + + For more information, + + Create a service SAS. + + + + + Gets the Azure Active Directory object ID in GUID format. + + + + + Gets the Azure Active Directory tenant ID in GUID format + + + + + Gets the time at which the key becomes valid. + + + + + Gets the time at which the key becomes expires. + + + + + Gets the Storage service that accepts the key. + + + + + Gets the Storage service version that created the key. + + + + + Gets empty shared access signature query parameters. + + + + + Creates a new BlobSasQueryParameters instance. + + + + + Creates a new instance of the + type based on the supplied query parameters . + All SAS-related query parameters will be removed from + . + + URI query parameters + + + + Convert the SAS query parameters into a URL encoded query string. + + + A URL encoded query string representing the SAS. + + + + + contains the list of + permissions that can be set for a blob bersion. Use + + to set the permissions on the . + + + + + Indicates that Delete is permitted. + + + + + Indicates that all permissions are set. + + + + + Parses the key properties into the QueryParameters instance. + + + The BlobSasQueryParameters or DataLakeSasQueryParameters instance. + + + Dictionary of keys and values. + + + + + contains the list of + permissions that can be set for a blob's access policy. Use + + to set the permissions on the . + + + + + Indicates that Read is permitted. + + + + + Indicates that Write is permitted. + + + + + Indicates that Delete is permitted. + + + + + Indicates that all permissions are set. + + + + + Extension methods for Sas. + + + + + Creates a string representing which resource types are allowed + for . + + + A string representing which resource types are allowed. + + + The order here matches the order used by the portal when generating SAS signatures. + + + + + Parse a string representing which resource types are accessible + from a shared access signature. + + + A string representing which resource types are accessible. + + + An instance. + + + The order here matches the order used by the portal when generating SAS signatures. + + + + + Gets a string representation of the protocol. + + A string representation of the protocol. + + + + Parse a string representation of a protocol. + + A string representation of a protocol. + A . + + + + Creates a string representing which services can be used for + . + + + A string representing which services are allowed. + + + The order here matches the order used by the portal when generating SAS signatures. + + + + + Parse a string representing which services are accessible from a + shared access signature. + + + A string representing which services are accessible. + + + An instance. + + + + + FormatTimesForSASSigning converts a time.Time to a snapshotTimeFormat string suitable for a + SASField's StartTime or ExpiryTime fields. Returns "" if value.IsZero(). + + + + + + + Helper method to add query param key value pairs to StringBuilder + + StringBuilder instance + query key + query value + + + + Helper to access protected static members of SasQueryParameters. + + + + + Encapsulates the shared properties used by both + BlobSasQueryParameters and DataLakeSasQueryParameters. + + + + + Builds up the UserDelegationKey portion of the SAS query parameter string. + + + + + Decrypts the given stream if decryption information is provided. + Does not shave off unwanted start/end bytes, but will shave off padding. + + Stream to decrypt. + + Encryption metadata and wrapped content encryption key. + + + Whether to use the first block of the stream for the IV instead of the value in + . Generally for partial blob downloads where the + previous block of the ciphertext is the IV for the next. + + + Whether to ignore padding. Generally for partial blob downloads where the end of + the blob (where the padding occurs) was not downloaded. + + Whether to perform this function asynchronously. + + + Decrypted plaintext. + + + Exceptions thrown based on implementations of and + . + + + + + Extension method to clone an instance of . + + + + + + + Copies all properties from one instance to another. It cannot copy + ; + that is the responsibility of the caller who made the instance. + + Object to copy from. + Object to copy to. + + This functionality has been pulled out to be accessible by other + clone methods available on subclasses. They need the ability to + instantiate the subclass destination first before copying over the + properties. + + + + + Specifies the encryption algorithm used to encrypt and decrypt a blob. + + + + + Initializes a new instance of the structure. + + The string value of the instance. + + + + AES-CBC using a 256 bit key. + + + + + Determines if two values are the same. + + The first to compare. + The second to compare. + True if and are the same; otherwise, false. + + + + Determines if two values are different. + + The first to compare. + The second to compare. + True if and are different; otherwise, false. + + + + Converts a string to a . + + The string value to convert. + + + Indicates whether this instance and a specified object are equal.The object to compare with the current instance. if and this instance are the same type and represent the same value; otherwise, . + + + + + + Returns the hash code for this instance.A 32-bit signed integer that is the hash code for this instance. + + + Returns the fully qualified type name of this instance.The fully qualified type name. + + + + Represents the encryption agent stored on the service. + + + + + The protocol version used for encryption. + + + + + The algorithm used for encryption. + + + + + Represents the encryption data that is stored on the service. + + + + + The blob encryption mode. + + + + + A object that stores the wrapping algorithm, key identifier and the encrypted key. + + + + + The encryption agent. + + + + + The content encryption IV. + + + + + Metadata for encryption. Currently used only for storing the encryption library, but may contain other data. + + + + + Serializes an EncryptionData instance into JSON. + + Data to serialize. + The JSON string. + + + + Serializes an EncryptionData instance into JSON and writes it to the given JSON writer. + + The writer to write the serialization to. + Data to serialize. + + + + Deserializes an EncryptionData instance from JSON. + + The serialized data string. + The instance. + + + + Reads an EncryptionData instance from a JSON reader. + + The reader to parse an EncryptionData isntance from. + The instance. + + + + Reads an EncryptionData instance from a parsed JSON object. + + The JSON object model. + The instance. + + + + Represents the envelope key details JSON schema stored on the service. + In the envelope technique, a securely generated content encryption key (CEK) is generated + for every encryption operation. It is then encrypted (wrapped) with the user-provided key + encryption key (KEK), using a key-wrap algorithm. The wrapped CEK is stored with the + encrypted data, and needs the KEK to be unwrapped. The KEK and key-wrapping operation is + never seen by this SDK. + + + + + The key identifier string. + + + + + The encrypted content encryption key. + + + + + The algorithm used to wrap the content encryption key. + + + + + Wraps the given read-stream in a CryptoStream and provides the metadata used to create + that stream. + + Stream to wrap. + Whether to wrap the content encryption key asynchronously. + Cancellation token. + The wrapped stream to read from and the encryption metadata for the wrapped stream. + + + + Encrypts the given stream and provides the metadata used to encrypt. This method writes to a memory stream, + optimized for known-size data that will already be buffered in memory. + + Stream to encrypt. + Whether to wrap the content encryption key asynchronously. + Cancellation token. + The encrypted data and the encryption metadata for the wrapped stream. + + + + An accumulator for request and response data transfers. + + + + + Increments the current value and reports it to the progress handler + + + + + + Zeroes out the current accumulation, and reports it to the progress handler + + + + + Returns an instance that no-ops accumulation. + + + + + Returns a long instance representing the current progress value. + + + + + The maximum allowed time between read or write calls to the stream for IdleCancellingStream. + + + + + Gets the default service version to use when building shared access + signatures. + + + + + The default size of staged blocks when uploading small blobs. + + + + + The size of staged blocks when uploading large blobs. + + + + + The threshold where we switch from staging + buffers to staging buffers. + + + + + The minimum number of bytes to download in Open Read. + + + + + Different .NET implementations have different default sizes for + and it's overloads. This is the default for .NET Core to be applied everywhere for test consistency. + + + + + The size of the buffer to use when copying streams during a + download operation. + + + + + The default format we use for block names. There are 50,000 + maximum blocks so we pad the size with up to 4 leading zeros. + + + + + Storage Connection String constant values. + + + + + The default port numbers for development storage credentials + + + + + Header Name constant values. + + + + + Blob constant values. + + + + + The Azure Storage name used to identify a storage account's root container. + + + + + The Azure Storage name used to identify a storage account's logs container. + + + + + The Azure Storage name used to identify a storage account's web content container. + + + + + Lease Duration is set as infinite when passed -1. + + + + + File constant values. + + + + + Lease Duration is set as infinite when passed -1. + + + + + Data Lake constant values. + + + + + The blob URI suffix. + + + + + The DFS URI suffix. + + + + + The key of the object json object returned for errors. + + + + + The key of the error code returned for errors. + + + + + The key of the error message returned for errors. + + + + + The Azure Storage error codes for Datalake Client. + + + + + Default concurrent transfers count. + + + + + Max upload bytes for less than Service Version 2019-12-12. + + + + + Max upload bytes. + + + + + Metadata key for isFolder property. + + + + + Queue constant values. + + + + + QueueMaxMessagesDequeue indicates the maximum number of messages + you can retrieve with each call to Dequeue. + + + + + QueueMessageMaxBytes indicates the maximum number of bytes allowed for a message's UTF-8 text. + + + + + ChangeFeed constant values. + + + + + Quick Query constant values. + + + + + Sas constant values. + + + + + List of ports used for path style addressing. + Copied from Microsoft.Azure.Storage.Core.Util + + + + + XML Element Name constant values. + + + + + Create exceptions for common error cases. + + + + + This policy is used if the SecondaryUri property is passed in on the clientOptions. It allows for storage + accounts configured with RA-GRS to retry GET or HEAD requests against the secondary storage Uri. + + + + + Functions like a readable but uses an ArrayPool to supply the backing memory. + This stream support buffering long sizes. + + + + + Size to rent from MemoryPool. + + + + + The backing array pool. + + + + + Absolute position of this stream in the larger stream it was chunked from. + + + + + Parameterless constructor for mocking. + + + + + Buffers a portion of the given stream, returning the buffered stream partition. + + + Stream to buffer from. + + + Minimum number of bytes to buffer. This method will not return until at least this many bytes have been read from or the stream completes. + + + Maximum number of bytes to buffer. + + + Current position of the stream, since throws if not seekable. + + + Pool to rent buffer space from. + + + Max size we can request from the array pool. + + + Whether to perform this operation asynchronously. + + + Cancellation token. + + + The buffered stream partition with memory backed by an array pool. + + + + + Describes a stream that is a partition of another, larger stream. + + + + + Absolute position of the start of this stream in the larger stream it was chunked from. + + + + + Exposes a predetermined slice of a larger stream using the same Stream interface. + There should not be access to the base stream while this facade is in use. + + + + Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.The unsigned byte cast to an , or -1 if at the end of the stream.The stream does not support reading.Methods were called after the stream was closed. + + Implementing this method takes advantage of any optimizations in the wrapped stream's implementation. + + + + + Some streams will throw if you try to access their length so we wrap + the check in a TryGet helper. + + + + + Wraps a stream, and reports position updates to a progress incrementer + + + + + Gets the SAS token used to authenticate requests to the Storage + service. + + + + + Initializes a new instance of the + class. + + + The SAS token used to authenticate requests to the Storage service. + + + + + Defines the client configuration options for connecting to Azure + Storage. + + + + + Set common ClientOptions defaults for Azure Storage. + + Storage ClientOptions. + + + + Get an authentication policy to sign Storage requests. + + Credential to use. + An authentication policy. + + + + Get an authentication policy to sign Storage requests. + + Credential to use. + Resource Uri. Must not contain shared access signature. + An authentication policy. + + + + Get an authentication policy to sign Storage requests. + + Credential to use. + An authentication policy. + + + + Get an optional authentication policy to sign Storage requests. + + Optional credentials to use. + An optional authentication policy. + + + + Create an HttpPipeline from Storage ClientOptions. + + The Storage ClientOptions. + Optional authentication policy. + The secondary URI to be used for retries on failed read requests + An HttpPipeline to use for Storage requests. + + + + Create an HttpPipeline from Storage ClientOptions. + + The Storage ClientOptions. + Optional authentication credentials. + The secondary URI to be used for retries on failed read requests + An HttpPipeline to use for Storage requests. + + + + Gets or sets a value indicating whether the FISMA MD5 setting will be used. + + false to use the FISMA MD5 setting; true to use the .NET default implementation. + + + + Initializes a new instance of the class using the specified + account credentials and service endpoints. + + A StorageCredentials object. + A specifying the Blob service endpoint or endpoints. + A specifying the Queue service endpoint or endpoints. + A specifying the Table service endpoint or endpoints. + A specifying the File service endpoint or endpoints. + + + + Gets a object that references the well-known development storage account. + + A object representing the development storage account. + + + + Indicates whether this account is a development storage account. + + + + + The storage service hostname suffix set by the user, if any. + + + + + The connection string parsed into settings. + + + + + True if the user used a constructor that auto-generates endpoints. + + + + + Gets the primary endpoint for the Blob service, as configured for the storage account. + + A containing the primary Blob service endpoint. + + + + Gets the primary endpoint for the Queue service, as configured for the storage account. + + A containing the primary Queue service endpoint. + + + + Gets the primary endpoint for the Table service, as configured for the storage account. + + A containing the primary Table service endpoint. + + + + Gets the primary endpoint for the File service, as configured for the storage account. + + A containing the primary File service endpoint. + + + + Gets the endpoints for the Blob service at the primary and secondary location, as configured for the storage account. + + A containing the Blob service endpoints. + + + + Gets the endpoints for the Queue service at the primary and secondary location, as configured for the storage account. + + A containing the Queue service endpoints. + + + + Gets the endpoints for the Table service at the primary and secondary location, as configured for the storage account. + + A containing the Table service endpoints. + + + + Gets the endpoints for the File service at the primary and secondary location, as configured for the storage account. + + A containing the File service endpoints. + + + + Gets the credentials used to create this object. + + A StorageCredentials object. + + + + Private record of the account name for use in ToString(bool). + + + + + Parses a connection string and returns a created + from the connection string. + + A valid connection string. + Thrown if is null or empty. + Thrown if is not a valid connection string. + Thrown if cannot be parsed. + A object constructed from the values provided in the connection string. + + + + Indicates whether a connection string can be parsed to return a object. + + The connection string to parse. + A object to hold the instance returned if + the connection string can be parsed. + true if the connection string was successfully parsed; otherwise, false. + + + + Internal implementation of Parse/TryParse. + + The string to parse. + The to return. + A callback for reporting errors. + If true, the parse was successful. Otherwise, false. + + + + Gets the default blob endpoint using the specified protocol and account name. + + The protocol to use. + The name of the storage account. + The Endpoint DNS suffix; use null for default. + The sas token; use null for default. + The default blob endpoint. + + + + Gets the default file endpoint using the specified protocol and account name. + + The protocol to use. + The name of the storage account. + The Endpoint DNS suffix; use null for default. + The sas token; use null for default. + The default file endpoint. + + + + Gets the default queue endpoint using the specified protocol and account name. + + The protocol to use. + The name of the storage account. + The Endpoint DNS suffix; use null for default. + The sas token; use null for default. + The default queue endpoint. + + + + Gets the default queue endpoint using the specified protocol and account name. + + The protocol to use. + The name of the storage account. + The Endpoint DNS suffix; use null for default. + The sas token; use null for default. + The default table endpoint. + + + + Provide helpful information about errors calling Azure Storage endpoints. + + + + + Attempt to get the error code from a response if it's not provided. + + The response. + An optional error code. + The response's error code. + + + + Check if a Response will throw an exception if you try to access + its Value property. + + Type of the Response Value. + The response to check. + True if the response will throw. + + + + Create a response that will throw an exception if you try to access + its Value property. + + Type of the Response Value. + The raw response. + A response that will throw if accessed. + + + + Pipeline policy to verify x-ms-client-request-id and x-ms-client-return-request-id + headers that are echoed back from a request match. + + + + + Create a new StorageRequestValidationPipelinePolicy + + + + + Verify x-ms-client-request-id and x-ms-client-return-request-id headers matches as + x-ms-client-return-request-id is an echo of x-mis-client-request-id. + + The message that was sent + + + + This class is added to access protected static methods off of the base class + that should not be exposed directly to customers. + + + + + HttpPipelinePolicy to sign requests using an Azure Storage shared key. + + + + + Create a new SharedKeyPipelinePolicy + + SharedKeyCredentials to authenticate requests. + + + + Sign the request using the shared key credentials. + + The message with the request to sign. + + + + The secondary URI to be used for retries on failed read requests + + + + + Overridden version of IsRetriableResponse that allows for Storage specific retry logic. + + The message containing both Response and Request + + + + + Helpers to manage Storage service versions. + + + + + Gets the latest version of the service supported by this SDK. + + + + + Convert a Storage ServiceVersion enum to an x-ms-version string. + + The service version enum value. + The x-ms-version string. + + + + Extension methods used to manipulate URIs. + + + + + Append a segment to a URIs path. + + The URI. + The relative segment to append. + The combined URI. + + + + Get the (already encoded) query parameters on a URI. + + The URI. + Dictionary mapping query parameters to values. + + + + Get the account name from the domain portion of a Uri. + + The Uri. + The service subdomain used to validate that the + domain is in the expected format. This should be "blob" for blobs, "file" for files, + "queue" for queues, "blob" and "dfs" for datalake. + Account name or null if not able to be parsed. + + + + Get the account name from the host. + + Host. + The service subdomain used to validate that the + domain is in the expected format. This should be "blob" for blobs, "file" for files, + "queue" for queues, "blob" and "dfs" for datalake. + Account name or null if not able to be parsed. + + + + If path starts with a slash, remove it + + The Uri. + Sanitized Uri. + + + + Check to see if Uri is using IP Endpoint style. + + The Uri. + True if using IP Endpoint style. + + + + Appends a query parameter to the string builder. + + string builder instance. + query parameter key. + query parameter value. + + + + Takes encoded query params string, output decoded params map + + + + + + Used for Open Read APIs. + + + + + Reads a fixed number of bytes from the stream. + The number of bytes to return is the first int read from the stream. + + + Note that in the Avro spec, byte array length is specified as a long. + This is fine for Quick Query and Change Feed, but could become a problem + in the future. + + + + + Returns null. + + + + + Reads a bool from the stream. + + + + + Reads a long from the stream. + + + + + Reads an int from the stream. + + + + + Reads a float from the stream. + + + + + Reads a double from the stream. + + + + + Reads a fixed number of bytes from the stream. + + + + + Reads a string from the stream. + + + + + Reads a map from the stream. + + + + + Adds the select to each element in the array. + + + + + Converts an IEnumerable of KeyValuePair into a Dictionary. + + + + + Parent class of AvroTypes. + + + + + Reads an object from the stream. + + + + + Determinds the AvroType from the Avro Schema. + + + + + AvroPrimativeType. + + + + + AvroEnumType. + + + + + AvroUnionType. + + + + + AvroMapType. + + + + + AvroRecordType. + + + + + The byte offset within the Avro file (both header and data) + of the start of the current block. + + + + + The index of the current object within the current block. + + + + + + Constructor for an AvroReader that will read from the + beginning of an Avro file. + + + + + Constructor for an Avro Reader that will read beginning + in the middle of an Avro file. + + + + + Constructor for mocking. Do not use. + + + + + Wrapper for HttpContentStream that provides the current position. + + + + When overridden in a derived class, gets or sets the position within the current stream.The current position within the stream.An I/O error occurs.The stream does not support seeking.Methods were called after the stream was closed. + + + When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source.The zero-based byte offset in at which to begin storing the data read from the current stream.The maximum number of bytes to be read from the current stream.The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.The sum of and is larger than the buffer length. is . or is negative.An I/O error occurs.The stream does not support reading.Methods were called after the stream was closed. + + + When overridden in a derived class, gets a value indicating whether the current stream supports reading. if the stream supports reading; otherwise, . + + + When overridden in a derived class, gets a value indicating whether the current stream supports seeking. if the stream supports seeking; otherwise, . + + + When overridden in a derived class, gets a value indicating whether the current stream supports writing. if the stream supports writing; otherwise, . + + + When overridden in a derived class, gets the length in bytes of the stream.A long value representing the length of the stream in bytes.A class derived from does not support seeking.Methods were called after the stream was closed. + + + When overridden in a derived class, sets the position within the current stream.A byte offset relative to the parameter.A value of type indicating the reference point used to obtain the new position.The new position within the current stream.An I/O error occurs.The stream does not support seeking, such as if the stream is constructed from a pipe or console output.Methods were called after the stream was closed. + + + When overridden in a derived class, sets the length of the current stream.The desired length of the current stream in bytes.An I/O error occurs.The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.Methods were called after the stream was closed. + + + When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.An array of bytes. This method copies bytes from to the current stream.The zero-based byte offset in at which to begin copying bytes to the current stream.The number of bytes to be written to the current stream.The sum of and is greater than the buffer length. is . or is negative.An I/O error occurred, such as the specified file cannot be found.The stream does not support writing. was called after the stream was closed. + + + When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.An I/O error occurs. + + + Releases the unmanaged resources used by the and optionally releases the managed resources. to release both managed and unmanaged resources; to release only unmanaged resources. + + + + Argument validation. + + + This class should be shared via source using Azure.Core.props and contain only common argument validation. + It is declared partial so that you can use the same familiar class name but extend it with project-specific validation. + To extend the functionality of this class, just declare your own partial class with project-specific methods. + + + Be sure to document exceptions thrown by these methods on your public methods. + + + + + + Throws if is null. + + The value to validate. + The name of the parameter. + is null. + + + + Throws if has not been initialized. + + The value to validate. + The name of the parameter. + has not been initialized. + + + + Throws if is null or an empty collection. + + The value to validate. + The name of the parameter. + is an empty collection. + is null. + + + + Throws if is null or an empty string. + + The value to validate. + The name of the parameter. + is an empty string. + is null. + + + + Throws if is null, an empty string, or consists only of white-space characters. + + The value to validate. + The name of the parameter. + is an empty string or consists only of white-space characters. + is null. + + + + Throws if is the default value for type . + + The type of structure to validate which implements . + The value to validate. + The name of the parameter. + is the default value for type . + + + + Throws if is less than the or greater than the . + + The type of to validate which implements . + The value to validate. + The minimum value to compare. + The maximum value to compare. + The name of the parameter. + + + + This attribute should be set on all client assemblies with value of one of the resource providers + from the https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-services-resource-providers list. + + + + + Initializes a new instance of the class. + + The used to authenticate requests. + + + + Method is invoked before the request is sent. + The containing the request. + + + + HACK HACK HACK. Some runtime environments like Azure.Functions downgrade System.Diagnostic.DiagnosticSource package version causing method not found exceptions in customer apps + This type is a temporary workaround to avoid the issue. + + + + + Both and are defined as public structs so that foreach can use duck typing + to call and avoid heap memory allocation. + Please don't delete this method and don't make these types private. + + + + + + Represents a heap-based, array-backed output sink into which data can be written. + + + + + Creates an instance of an , in which data can be written to, + with the default initial capacity. + + + + + Creates an instance of an , in which data can be written to, + with an initial capacity specified. + + The minimum capacity with which to initialize the underlying buffer. + + Thrown when is not positive (i.e. less than or equal to 0). + + + + + Returns the data written to the underlying buffer so far, as a . + + + + + Returns the data written to the underlying buffer so far, as a . + + + + + Returns the amount of data written to the underlying buffer so far. + + + + + Returns the total amount of space within the underlying buffer. + + + + + Returns the amount of space available that can still be written into without forcing the underlying buffer to grow. + + + + + Clears the data written to the underlying buffer. + + + You must clear the before trying to re-use it. + + + + + Notifies that amount of data was written to the output /. + + + Thrown when is negative. + + + Thrown when attempting to advance past the end of the underlying buffer. + + + You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer. + + + + + Returns a to write to that is at least the requested length (specified by ). + If no is provided (or it's equal to 0), some non-empty buffer is returned. + + + Thrown when is negative. + + + This will never return an empty . + + + There is no guarantee that successive calls will return the same buffer or the same-sized buffer. + + + You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer. + + + + + Returns a to write to that is at least the requested length (specified by ). + If no is provided (or it's equal to 0), some non-empty buffer is returned. + + + Thrown when is negative. + + + This will never return an empty . + + + There is no guarantee that successive calls will return the same buffer or the same-sized buffer. + + + You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer. + + + + + Marks methods that call methods on other client and don't need their diagnostics verified + + + + + Copied from https://github.com/dotnet/corefx/blob/master/src/Common/src/CoreLib/System/HashCode.cs. + + + + + Extension methods to add client to clients builder. + + + + + Registers a instance with the provided + + + + + Registers a instance with the provided + + + + + Registers a instance with the provided and + + + + + Registers a instance with connection options loaded from the provided instance. + + + + Returns an enumerator that iterates through the collection.An enumerator that can be used to iterate through the collection. + + + Returns an enumerator that iterates through a collection.An object that can be used to iterate through the collection. + + + Gets the element in the collection at the current position of the enumerator.The element in the collection at the current position of the enumerator. + + + diff --git a/app_data/jobs/triggered/utility/Azure.Storage.Common.dll b/app_data/jobs/triggered/utility/Azure.Storage.Common.dll new file mode 100644 index 000000000..44a008e94 Binary files /dev/null and b/app_data/jobs/triggered/utility/Azure.Storage.Common.dll differ diff --git a/app_data/jobs/triggered/utility/Azure.Storage.Common.xml b/app_data/jobs/triggered/utility/Azure.Storage.Common.xml new file mode 100644 index 000000000..f5ac4b48f --- /dev/null +++ b/app_data/jobs/triggered/utility/Azure.Storage.Common.xml @@ -0,0 +1,1442 @@ + + + + Azure.Storage.Common + + + + + Provides the client configuration options for connecting to Azure Blob using clientside encryption. + + + + + The version of clientside encryption to use. + + + + + Required for upload operations. + The key used to wrap the generated content encryption key. + For more information, see https://docs.microsoft.com/en-us/azure/storage/common/storage-client-side-encryption. + + + + + Required for download operations. + Fetches the correct key encryption key to unwrap the downloaded content encryption key. + For more information, see https://docs.microsoft.com/en-us/azure/storage/common/storage-client-side-encryption. + + + + + Required for upload operations. + The algorithm identifier to use when wrapping the content encryption key. This is passed into + + and its async counterpart. + + + + + Initializes a new instance of the class. + + The version of clientside encryption to use. + + + + The version of clientside encryption to use. + + + + + 1.0 + + + + + is used to generate an account level + Shared Access Signature (SAS) for Azure Storage services. + For more information, see + + Create an account SAS. + + + + + The storage service version to use to authenticate requests made + with this shared access signature, and the service version to use + when handling requests made with this shared access signature. + + + + + The optional signed protocol field specifies the protocol + permitted for a request made with the SAS. Possible values are + , + , and + . + + + + + Optionally specify the time at which the shared access signature + becomes valid. If omitted when DateTimeOffset.MinValue is used, + start time for this call is assumed to be the time when the + storage service receives the request. + + + + + The time at which the shared access signature becomes invalid. + This field must be omitted if it has been specified in an + associated stored access policy. + + + + + The permissions associated with the shared access signature. The + user is restricted to operations allowed by the permissions. The + type can be used to create the + permissions string. + + + + + Specifies an IP address or a range of IP addresses from which to + accept requests. If the IP address from which the request + originates does not match the IP address or address range + specified on the SAS token, the request is not authenticated. + When specifying a range of IP addresses, note that the range is + inclusive. + + + + + The services associated with the shared access signature. The + user is restricted to operations with the specified services. + + + + + The resource types associated with the shared access signature. The + user is restricted to operations on the specified resources. + + + + + Initializes a new instance of the + class. + + + This constructor has been deprecated. Please consider using + + to create a Service SAS. This change does not have any impact on how + your application generates or makes use of SAS tokens. + + + + + Initializes a new instance of the + class to create a Blob Container Service Sas. + + + The time at which the shared access signature becomes invalid. + This field must be omitted if it has been specified in an + associated stored access policy. + + + The time at which the shared access signature becomes invalid. + This field must be omitted if it has been specified in an + associated stored access policy. + + + Specifies the services accessible from an account level shared access + signature. + + + Specifies the resource types accessible from an account level shared + access signature. + + + + + Sets the permissions for an account SAS. + + + containing the allowed permissions. + + + + + Sets the permissions for the SAS using a raw permissions string. + + Raw permissions string for the SAS. + + + + Use an account's to sign this + shared access signature values to produce the proper SAS query + parameters for authenticating requests. + + + The storage account's . + + + The used for authenticating + requests. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the . + + Hash code for the . + + + + contains the list of + permissions that can be set for a blob's access policy. Use + + to set the permissions on the . + + + + + Indicates that Read is permitted. + + + + + Indicates that Write is permitted. + + + + + Indicates that Delete is permitted. + + + + + Indicates that List is permitted. + + + + + Indicates that Add is permitted. + + + + + Indicates that Create is permitted. + + + + + Indicates that Update is permitted. + + + + + Indicates that Delete is permitted. + + + + + Indicates that reading and writing Tags is permitted. + Blob service only. + + + + + Indicates that filtering by tag is permitted. + Blob service only. + + + + + Indicates that deleting a BlobVersion is permitted. + Blob Service only. + + + + + Indicates that all permissions are set. + + + + + Specifies the resource types accessible from an account level shared + access signature. + + + + + Indicates whether service-level APIs are accessible + from this shared access signature (e.g., Get/Set Service + Properties, Get Service Stats, List Containers/Queues/Tables/ + Shares). + + + + + Indicates whether blob container-level APIs are accessible + from this shared access signature (e.g., Create/Delete Container, + Create/Delete Queue, Create/Delete Table, Create/Delete Share, List + Blobs/Files and Directories). + + + + + Indicates whether object-level APIs for blobs, queue + messages, and files are accessible from this shared access + signature (e.g. Put Blob, Query Entity, Get Messages, Create File, + etc.). + + + + + Indicates all service-level APIs are accessible from this shared + access signature. + + + + + Specifies the services accessible from an account level shared access + signature. + + + + + Indicates whether Azure Blob Storage resources are + accessible from the shared access signature. + + + + + Indicates whether Azure Queue Storage resources are + accessible from the shared access signature. + + + + + Indicates whether Azure File Storage resources are + accessible from the shared access signature. + + + + + Indicates whether Azure Table Storage resources are + accessible from the shared access signature. + + + + + Indicates all services are accessible from the shared + access signature. + + + + + Represents a range of allowed IP addresses for constructing a Shared + Access Signature. + + + + + Gets the start of the IP range. Not specified if equal to null or + . + + + + + Gets the optional end of the IP range. Not specified if equal to + null or . + + + + + Creates a new . + + + The range's start . + + + The range's optional end . + + + + + Creates a string representation of an . + + + A string representation of an . + + + + + Parse an IP range string into a new . + + IP range string to parse. + The parsed . + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the . + + Hash code for the . + + + + Check if two instances are equal. + + The first instance to compare. + The second instance to compare. + True if they're equal, false otherwise. + + + + Check if two instances are not equal. + + The first instance to compare. + The second instance to compare. + True if they're not equal, false otherwise. + + + + Check if two instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Defines the protocols permitted for Storage requests made with a shared + access signature. + + + + + No protocol has been specified. If no value is specified, + the service will default to HttpsAndHttp. + + + + + Only requests issued over HTTPS or HTTP will be permitted. + + + + + Only requests issued over HTTPS will be permitted. + + + + + A object represents the components + that make up an Azure Storage Shared Access Signature's query + parameters. It includes components used by all Azure Storage resources + (Blob Containers, Blobs, Files, and Queues). You can construct a new instance + using the service specific SAS builder types. + For more information, + + Create a service SAS. + + + + + The default service version to use for Shared Access Signatures. + + + + + Gets the storage service version to use to authenticate requests + made with this shared access signature, and the service version to + use when handling requests made with this shared access signature. + + + + + Gets the signed services accessible with an account level shared + access signature. + + + + + Gets which resources are accessible via the shared access signature. + + + + + Optional. Specifies the protocol permitted for a request made with + the shared access signature. + + + + + Gets the optional time at which the shared access signature becomes + valid. If omitted, start time for this call is assumed to be the + time when the storage service receives the request. + means not set. + + + + + Gets the time at which the shared access signature becomes invalid. + means not set. + + + + + Gets the optional IP address or a range of IP addresses from which + to accept requests. When specifying a range, note that the range + is inclusive. + + + + + Gets the optional unique value up to 64 characters in length that + correlates to an access policy specified for the blob container, queue, + or share. + + + + + Gets the resources are accessible via the shared access signature. + + + + + Gets the permissions associated with the shared access signature. + The user is restricted to operations allowed by the permissions. + This field must be omitted if it has been specified in an + associated stored access policy. + + + + + Gets the Cache-Control response header, which allows for + specifying the client-side caching to be used for blob and file downloads. + + + + + Gets the Content-Disposition response header, which allows for + specifying the way that the blob or file content can be displayed in the browser. + + + + + Gets the Content-Encoding response header, which allows for specifying + the type of encoding used for blob and file downloads. + + + + + Gets the Content-Language response header, which allows for specifying the + language of the downloaded blob or file content. + + + + + Gets the Content-Type response header, which allows for specifying the + type of the downloaded blob or file content. + + + + + Gets the Authorized AAD Object Id associated with the shared access signature. + The AAD Object ID of a user authorized by the owner of the User Delegation Key + to perform the action granted by the SAS. The Azure Storage service will + ensure that the owner of the user delegation key has the required permissions + before granting access but no additional permission check for the user specified + in this value will be performed. This cannot be used in conjuction with + . + Only valid in an HNS enabled account. If this value is set in an non-HNS enabled + account, an authorization failure will be thrown. + + + + + Gets the Unauthorized AAD Object Id associated with the shared access signature. + The AAD Object Id of a user that is assumed to be unauthorized by the owner of the + User Delegation Key. The Azure Storage Service will perform an additional POSIX ACL + check to determine if the user is authorized to perform the requested operation. + This cannot be used in conjuction with . + Only valid in an HNS enabled account. If this value is set in an non-HNS enabled + account, an authorization failure will be thrown. + + + + + Gets the Correlation Id associated with the shared access signature. This is used to + correlate the storage audit logs with the audit logs used by the principal generating + and distributing SAS. + + + + + Gets the Directory Depth specificed in the canonicalizedresource field of the + string-to-sign. The depth of the directory is the number of directories beneath the + root folder. Required when resource (sr) = d to indicate the depth of the directory. + The value must be a non-negative integer. + + + + + Gets the string-to-sign, a unique string constructed from the + fields that must be verified in order to authenticate the request. + The signature is an HMAC computed over the string-to-sign and key + using the SHA256 algorithm, and then encoded using Base64 encoding. + + + + + Gets empty shared access signature query parameters. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance of the type + based on the supplied query parameters . + All SAS-related query parameters will be removed from + . + + URI query parameters + + + + Creates a new SasQueryParameters instance. + + + + + Creates a new SasQueryParameters instance. + + + + + Creates a new instance of the type + based on the supplied query parameters . + All SAS-related query parameters will be removed from + . + + URI query parameters + + + + Creates a new SasQueryParameters instance. + + + + + Creates a new SasQueryParameters instance. + + + + + Convert the SAS query parameters into a URL encoded query string. + + + A URL encoded query string representing the SAS. + + + + + Builds the query parameter string for the SasQueryParameters instance. + + + StringBuilder instance to add the query params to + + + + + Extension methods for Sas. + + + + + Creates a string representing which resource types are allowed + for . + + + A string representing which resource types are allowed. + + + The order here matches the order used by the portal when generating SAS signatures. + + + + + Parse a string representing which resource types are accessible + from a shared access signature. + + + A string representing which resource types are accessible. + + + An instance. + + + The order here matches the order used by the portal when generating SAS signatures. + + + + + Gets a string representation of the protocol. + + A string representation of the protocol. + + + + Parse a string representation of a protocol. + + A string representation of a protocol. + A . + + + + Creates a string representing which services can be used for + . + + + A string representing which services are allowed. + + + The order here matches the order used by the portal when generating SAS signatures. + + + + + Parse a string representing which services are accessible from a + shared access signature. + + + A string representing which services are accessible. + + + An instance. + + + + + FormatTimesForSASSigning converts a time.Time to a snapshotTimeFormat string suitable for a + SASField's StartTime or ExpiryTime fields. Returns "" if value.IsZero(). + + + + + + + Helper method to add query param key value pairs to StringBuilder + + StringBuilder instance + query key + query value + + + + Helper to access protected static members of SasQueryParameters. + + + + + Blob enum extensions. + + + + + Create a permissions string to provide + . + + A permissions string. + + + + A is a credential backed by + a Storage Account's name and one of its access keys. + + + + + Gets the name of the Storage Account. + + + + + Initializes a new instance of the + class. + + The name of the Storage Account. + A Storage Account access key. + + + + Update the Storage Account's access key. This intended to be used + when you've regenerated your Storage Account's access keys and want + to update long lived clients. + + A Storage Account access key. + + + + Generates a base-64 hash signature string for an HTTP request or + for a SAS. + + The message to sign. + The signed message. + + + + Generates a base-64 hash signature string for an HTTP request or + for a SAS. + + The credential. + The message to sign. + The signed message. + + + + is used to provide options for parallel transfers. + + + + + The maximum length of an transfer in bytes. This property is a backwards-compatible + facade for , which supports long values. Use + for full access of supported values. + + + + + The maximum length of an transfer in bytes. + + + + + The maximum number of workers that may be used in a parallel transfer. + + + + + The size of the first range request in bytes. Blobs smaller than this limit will + be downloaded in a single request. Blobs larger than this limit will continue being + downloaded in chunks of size . This property is a + backwards-compatible facade for , which supports + long values. Use for full access of supported values. + + + + + The size of the first range request in bytes. Blobs smaller than this limit will + be downloaded in a single request. Blobs larger than this limit will continue being + downloaded in chunks of size . + + + + + Check if two ParallelTransferOptions instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + Get a hash code for the ParallelTransferOptions. + + Hash code for the ParallelTransferOptions. + + + + Check if two ParallelTransferOptions instances are equal. + + The first instance to compare. + The second instance to compare. + True if they're equal, false otherwise. + + + + Check if two ParallelTransferOptions instances are equal. + + The first instance to compare. + The second instance to compare. + True if they're not equal, false otherwise. + + + + Check if two ParallelTransferOptions instances are equal. + + The instance to compare to. + True if they're equal, false otherwise. + + + + The maximum allowed time between read or write calls to the stream for IdleCancellingStream. + + + + + Gets the default service version to use when building shared access + signatures. + + + + + The default size of staged blocks when uploading small blobs. + + + + + The size of staged blocks when uploading large blobs. + + + + + The threshold where we switch from staging + buffers to staging buffers. + + + + + The minimum number of bytes to download in Open Read. + + + + + Different .NET implementations have different default sizes for + and it's overloads. This is the default for .NET Core to be applied everywhere for test consistency. + + + + + The size of the buffer to use when copying streams during a + download operation. + + + + + The default format we use for block names. There are 50,000 + maximum blocks so we pad the size with up to 4 leading zeros. + + + + + Storage Connection String constant values. + + + + + The default port numbers for development storage credentials + + + + + Header Name constant values. + + + + + Blob constant values. + + + + + The Azure Storage name used to identify a storage account's root container. + + + + + The Azure Storage name used to identify a storage account's logs container. + + + + + The Azure Storage name used to identify a storage account's web content container. + + + + + Lease Duration is set as infinite when passed -1. + + + + + File constant values. + + + + + Lease Duration is set as infinite when passed -1. + + + + + Data Lake constant values. + + + + + The blob URI suffix. + + + + + The DFS URI suffix. + + + + + The key of the object json object returned for errors. + + + + + The key of the error code returned for errors. + + + + + The key of the error message returned for errors. + + + + + The Azure Storage error codes for Datalake Client. + + + + + Default concurrent transfers count. + + + + + Max upload bytes for less than Service Version 2019-12-12. + + + + + Max upload bytes. + + + + + Metadata key for isFolder property. + + + + + Queue constant values. + + + + + QueueMaxMessagesDequeue indicates the maximum number of messages + you can retrieve with each call to Dequeue. + + + + + QueueMessageMaxBytes indicates the maximum number of bytes allowed for a message's UTF-8 text. + + + + + ChangeFeed constant values. + + + + + Quick Query constant values. + + + + + Sas constant values. + + + + + List of ports used for path style addressing. + Copied from Microsoft.Azure.Storage.Core.Util + + + + + XML Element Name constant values. + + + + + Create exceptions for common error cases. + + + + + This policy is used if the SecondaryUri property is passed in on the clientOptions. It allows for storage + accounts configured with RA-GRS to retry GET or HEAD requests against the secondary storage Uri. + + + + + Gets the SAS token used to authenticate requests to the Storage + service. + + + + + Initializes a new instance of the + class. + + + The SAS token used to authenticate requests to the Storage service. + + + + + Provide helpful information about errors calling Azure Storage endpoints. + + + + + Attempt to get the error code from a response if it's not provided. + + The response. + An optional error code. + The response's error code. + + + + Check if a Response will throw an exception if you try to access + its Value property. + + Type of the Response Value. + The response to check. + True if the response will throw. + + + + Create a response that will throw an exception if you try to access + its Value property. + + Type of the Response Value. + The raw response. + A response that will throw if accessed. + + + + Gets or sets a value indicating whether the FISMA MD5 setting will be used. + + false to use the FISMA MD5 setting; true to use the .NET default implementation. + + + + Initializes a new instance of the class using the specified + account credentials and service endpoints. + + A StorageCredentials object. + A specifying the Blob service endpoint or endpoints. + A specifying the Queue service endpoint or endpoints. + A specifying the Table service endpoint or endpoints. + A specifying the File service endpoint or endpoints. + + + + Gets a object that references the well-known development storage account. + + A object representing the development storage account. + + + + Indicates whether this account is a development storage account. + + + + + The storage service hostname suffix set by the user, if any. + + + + + The connection string parsed into settings. + + + + + True if the user used a constructor that auto-generates endpoints. + + + + + Gets the primary endpoint for the Blob service, as configured for the storage account. + + A containing the primary Blob service endpoint. + + + + Gets the primary endpoint for the Queue service, as configured for the storage account. + + A containing the primary Queue service endpoint. + + + + Gets the primary endpoint for the Table service, as configured for the storage account. + + A containing the primary Table service endpoint. + + + + Gets the primary endpoint for the File service, as configured for the storage account. + + A containing the primary File service endpoint. + + + + Gets the endpoints for the Blob service at the primary and secondary location, as configured for the storage account. + + A containing the Blob service endpoints. + + + + Gets the endpoints for the Queue service at the primary and secondary location, as configured for the storage account. + + A containing the Queue service endpoints. + + + + Gets the endpoints for the Table service at the primary and secondary location, as configured for the storage account. + + A containing the Table service endpoints. + + + + Gets the endpoints for the File service at the primary and secondary location, as configured for the storage account. + + A containing the File service endpoints. + + + + Gets the credentials used to create this object. + + A StorageCredentials object. + + + + Private record of the account name for use in ToString(bool). + + + + + Parses a connection string and returns a created + from the connection string. + + A valid connection string. + Thrown if is null or empty. + Thrown if is not a valid connection string. + Thrown if cannot be parsed. + A object constructed from the values provided in the connection string. + + + + Indicates whether a connection string can be parsed to return a object. + + The connection string to parse. + A object to hold the instance returned if + the connection string can be parsed. + true if the connection string was successfully parsed; otherwise, false. + + + + Internal implementation of Parse/TryParse. + + The string to parse. + The to return. + A callback for reporting errors. + If true, the parse was successful. Otherwise, false. + + + + Gets the default blob endpoint using the specified protocol and account name. + + The protocol to use. + The name of the storage account. + The Endpoint DNS suffix; use null for default. + The sas token; use null for default. + The default blob endpoint. + + + + Gets the default file endpoint using the specified protocol and account name. + + The protocol to use. + The name of the storage account. + The Endpoint DNS suffix; use null for default. + The sas token; use null for default. + The default file endpoint. + + + + Gets the default queue endpoint using the specified protocol and account name. + + The protocol to use. + The name of the storage account. + The Endpoint DNS suffix; use null for default. + The sas token; use null for default. + The default queue endpoint. + + + + Gets the default queue endpoint using the specified protocol and account name. + + The protocol to use. + The name of the storage account. + The Endpoint DNS suffix; use null for default. + The sas token; use null for default. + The default table endpoint. + + + + The secondary URI to be used for retries on failed read requests + + + + + Overridden version of IsRetriableResponse that allows for Storage specific retry logic. + + The message containing both Response and Request + + + + + This class is added to access protected static methods off of the base class + that should not be exposed directly to customers. + + + + + HttpPipelinePolicy to sign requests using an Azure Storage shared key. + + + + + Create a new SharedKeyPipelinePolicy + + SharedKeyCredentials to authenticate requests. + + + + Sign the request using the shared key credentials. + + The message with the request to sign. + + + + Extension methods used to manipulate URIs. + + + + + Append a segment to a URIs path. + + The URI. + The relative segment to append. + The combined URI. + + + + Get the (already encoded) query parameters on a URI. + + The URI. + Dictionary mapping query parameters to values. + + + + Get the account name from the domain portion of a Uri. + + The Uri. + The service subdomain used to validate that the + domain is in the expected format. This should be "blob" for blobs, "file" for files, + "queue" for queues, "blob" and "dfs" for datalake. + Account name or null if not able to be parsed. + + + + Get the account name from the host. + + Host. + The service subdomain used to validate that the + domain is in the expected format. This should be "blob" for blobs, "file" for files, + "queue" for queues, "blob" and "dfs" for datalake. + Account name or null if not able to be parsed. + + + + If path starts with a slash, remove it + + The Uri. + Sanitized Uri. + + + + Check to see if Uri is using IP Endpoint style. + + The Uri. + True if using IP Endpoint style. + + + + Appends a query parameter to the string builder. + + string builder instance. + query parameter key. + query parameter value. + + + + Takes encoded query params string, output decoded params map + + + + + + Both and are defined as public structs so that foreach can use duck typing + to call and avoid heap memory allocation. + Please don't delete this method and don't make these types private. + + + + + Returns an enumerator that iterates through the collection.An enumerator that can be used to iterate through the collection. + + + Returns an enumerator that iterates through a collection.An object that can be used to iterate through the collection. + + + Gets the element in the collection at the current position of the enumerator.The element in the collection at the current position of the enumerator. + + + diff --git a/app_data/jobs/triggered/utility/CoreBlobMigration.exe b/app_data/jobs/triggered/utility/CoreBlobMigration.exe new file mode 100644 index 000000000..bbee37094 Binary files /dev/null and b/app_data/jobs/triggered/utility/CoreBlobMigration.exe differ diff --git a/app_data/jobs/triggered/utility/CoreBlobMigration.exe.config b/app_data/jobs/triggered/utility/CoreBlobMigration.exe.config new file mode 100644 index 000000000..a58f91b4e --- /dev/null +++ b/app_data/jobs/triggered/utility/CoreBlobMigration.exe.config @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/CoreBlobMigration.pdb b/app_data/jobs/triggered/utility/CoreBlobMigration.pdb new file mode 100644 index 000000000..d47ca0359 Binary files /dev/null and b/app_data/jobs/triggered/utility/CoreBlobMigration.pdb differ diff --git a/app_data/jobs/triggered/utility/Microsoft.Bcl.AsyncInterfaces.dll b/app_data/jobs/triggered/utility/Microsoft.Bcl.AsyncInterfaces.dll new file mode 100644 index 000000000..0c99b0b1b Binary files /dev/null and b/app_data/jobs/triggered/utility/Microsoft.Bcl.AsyncInterfaces.dll differ diff --git a/app_data/jobs/triggered/utility/Microsoft.Bcl.AsyncInterfaces.xml b/app_data/jobs/triggered/utility/Microsoft.Bcl.AsyncInterfaces.xml new file mode 100644 index 000000000..cb1744f60 --- /dev/null +++ b/app_data/jobs/triggered/utility/Microsoft.Bcl.AsyncInterfaces.xml @@ -0,0 +1,223 @@ + + + + Microsoft.Bcl.AsyncInterfaces + + + + Provides the core logic for implementing a manual-reset or . + + + + + The callback to invoke when the operation completes if was called before the operation completed, + or if the operation completed before a callback was supplied, + or null if a callback hasn't yet been provided and the operation hasn't yet completed. + + + + State to pass to . + + + to flow to the callback, or null if no flowing is required. + + + + A "captured" or with which to invoke the callback, + or null if no special context is required. + + + + Whether the current operation has completed. + + + The result with which the operation succeeded, or the default value if it hasn't yet completed or failed. + + + The exception with which the operation failed, or null if it hasn't yet completed or completed successfully. + + + The current version of this value, used to help prevent misuse. + + + Gets or sets whether to force continuations to run asynchronously. + Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true. + + + Resets to prepare for the next operation. + + + Completes with a successful result. + The result. + + + Complets with an error. + + + + Gets the operation version. + + + Gets the status of the operation. + Opaque value that was provided to the 's constructor. + + + Gets the result of the operation. + Opaque value that was provided to the 's constructor. + + + Schedules the continuation action for this operation. + The continuation to invoke when the operation has completed. + The state object to pass to when it's invoked. + Opaque value that was provided to the 's constructor. + The flags describing the behavior of the continuation. + + + Ensures that the specified token matches the current version. + The token supplied by . + + + Signals that the operation has completed. Invoked after the result or error has been set. + + + + Invokes the continuation with the appropriate captured context / scheduler. + This assumes that if is not null we're already + running within that . + + + + Provides a set of static methods for configuring -related behaviors on asynchronous enumerables and disposables. + + + Configures how awaits on the tasks returned from an async disposable will be performed. + The source async disposable. + Whether to capture and marshal back to the current context. + The configured async disposable. + + + Configures how awaits on the tasks returned from an async iteration will be performed. + The type of the objects being iterated. + The source enumerable being iterated. + Whether to capture and marshal back to the current context. + The configured enumerable. + + + Sets the to be passed to when iterating. + The type of the objects being iterated. + The source enumerable being iterated. + The to use. + The configured enumerable. + + + Represents a builder for asynchronous iterators. + + + Creates an instance of the struct. + The initialized instance. + + + Invokes on the state machine while guarding the . + The type of the state machine. + The state machine instance, passed by reference. + + + Schedules the state machine to proceed to the next action when the specified awaiter completes. + The type of the awaiter. + The type of the state machine. + The awaiter. + The state machine. + + + Schedules the state machine to proceed to the next action when the specified awaiter completes. + The type of the awaiter. + The type of the state machine. + The awaiter. + The state machine. + + + Marks iteration as being completed, whether successfully or otherwise. + + + Gets an object that may be used to uniquely identify this builder to the debugger. + + + Indicates whether a method is an asynchronous iterator. + + + Initializes a new instance of the class. + The type object for the underlying state machine type that's used to implement a state machine method. + + + Provides a type that can be used to configure how awaits on an are performed. + + + Provides an awaitable async enumerable that enables cancelable iteration and configured awaits. + + + Configures how awaits on the tasks returned from an async iteration will be performed. + Whether to capture and marshal back to the current context. + The configured enumerable. + This will replace any previous value set by for this iteration. + + + Sets the to be passed to when iterating. + The to use. + The configured enumerable. + This will replace any previous set by for this iteration. + + + Provides an awaitable async enumerator that enables cancelable iteration and configured awaits. + + + Advances the enumerator asynchronously to the next element of the collection. + + A that will complete with a result of true + if the enumerator was successfully advanced to the next element, or false if the enumerator has + passed the end of the collection. + + + + Gets the element in the collection at the current position of the enumerator. + + + + Performs application-defined tasks associated with freeing, releasing, or + resetting unmanaged resources asynchronously. + + + + Exposes an enumerator that provides asynchronous iteration over values of a specified type. + The type of values to enumerate. + + + Returns an enumerator that iterates asynchronously through the collection. + A that may be used to cancel the asynchronous iteration. + An enumerator that can be used to iterate asynchronously through the collection. + + + Supports a simple asynchronous iteration over a generic collection. + The type of objects to enumerate. + + + Advances the enumerator asynchronously to the next element of the collection. + + A that will complete with a result of true if the enumerator + was successfully advanced to the next element, or false if the enumerator has passed the end + of the collection. + + + + Gets the element in the collection at the current position of the enumerator. + + + Provides a mechanism for releasing unmanaged resources asynchronously. + + + + Performs application-defined tasks associated with freeing, releasing, or + resetting unmanaged resources asynchronously. + + + + diff --git a/app_data/jobs/triggered/utility/Newtonsoft.Json.dll b/app_data/jobs/triggered/utility/Newtonsoft.Json.dll new file mode 100644 index 000000000..e5c8978e0 Binary files /dev/null and b/app_data/jobs/triggered/utility/Newtonsoft.Json.dll differ diff --git a/app_data/jobs/triggered/utility/Newtonsoft.Json.xml b/app_data/jobs/triggered/utility/Newtonsoft.Json.xml new file mode 100644 index 000000000..de78eb0c0 --- /dev/null +++ b/app_data/jobs/triggered/utility/Newtonsoft.Json.xml @@ -0,0 +1,10760 @@ + + + + Newtonsoft.Json + + + + + Represents a BSON Oid (object id). + + + + + Gets or sets the value of the Oid. + + The value of the Oid. + + + + Initializes a new instance of the class. + + The Oid value. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. + + + + + Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. + + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + + + + + Gets or sets a value indicating whether the root object will be read as a JSON array. + + + true if the root object will be read as a JSON array; otherwise, false. + + + + + Gets or sets the used when reading values from BSON. + + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. + + + + + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + + The used when writing values to BSON. + + + + Initializes a new instance of the class. + + The to write to. + + + + Initializes a new instance of the class. + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. + + + + + Writes the end. + + The token. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes the beginning of a JSON array. + + + + + Writes the beginning of a JSON object. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value that represents a BSON object id. + + The Object ID value to write. + + + + Writes a BSON regex. + + The regex pattern. + The regex options. + + + + Specifies how constructors are used when initializing objects during deserialization by the . + + + + + First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. + + + + + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. + + + + + Converts a binary value to and from a base 64 string value. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Creates a custom object. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Creates an object which will then be populated by the serializer. + + Type of the object. + The created object. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Provides a base class for converting a to and from JSON. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a F# discriminated union type to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an Entity Framework to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). + + + + + Gets or sets the date time styles used when converting a date to and from JSON. + + The date time styles used when converting a date to and from JSON. + + + + Gets or sets the date time format used when converting a date to and from JSON. + + The date time format used when converting a date to and from JSON. + + + + Gets or sets the culture used when converting a date to and from JSON. + + The culture used when converting a date to and from JSON. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from its name string value. + + + + + Gets or sets a value indicating whether the written enum text should be camel case. + + true if the written enum text will be camel case; otherwise, false. + + + + Gets or sets a value indicating whether integer values are allowed when deserializing. + + true if integers are allowed when deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + true if the written enum text will be camel case; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from a string (e.g. "1.2.3.4"). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts XML to and from JSON. + + + + + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. + + The name of the deserialized root element. + + + + Gets or sets a flag to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + true if the array attribute is written to the XML; otherwise, false. + + + + Gets or sets a value indicating whether to write the root JSON object. + + true if the JSON root object is omitted; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The calling serializer. + The value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Checks if the is a namespace attribute. + + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Floating point numbers are parsed to . + + + + + Floating point numbers are parsed to . + + + + + Specifies how dates are formatted when writing JSON text. + + + + + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + + + + + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + + + + + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + + + + + Date formatted strings are not parsed to a date type and are read as strings. + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Specifies how to treat the time value when converting between string and . + + + + + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + + + + + Treat as a UTC. If the object represents a local time, it is converted to a UTC. + + + + + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. + + + + + Time zone information should be preserved when converting. + + + + + Specifies default value handling options for the . + + + + + + + + + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + so that it is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. + + + + + Members with a default value but no JSON will be set to their default value when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + and set members to their default value when deserializing. + + + + + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . + + + + + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + + + + + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. + + + + + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. + + + + + Specifies formatting options for the . + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the and settings. + + + + + Provides an interface for using pooled arrays. + + The array type content. + + + + Rent an array from the pool. This array must be returned when it is no longer needed. + + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. + + + + Return an array to the pool. + + The array that is being returned. + + + + Provides an interface to enable a class to return line and position information. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + The current line number or 0 if no line information is available (for example, when returns false). + + + + Gets the current line position. + + The current line position or 0 if no line information is available (for example, when returns false). + + + + Instructs the how to serialize the collection. + + + + + Gets or sets a value indicating whether null items are allowed in the collection. + + true if null items are allowed in the collection; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a flag indicating whether the array can contain null items. + + A flag indicating whether the array can contain null items. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to use the specified constructor when deserializing that object. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the id. + + The id. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the description. + + The description. + + + + Gets or sets the collection's items converter. + + The collection's items converter. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets a value that indicates whether to preserve object references. + + + true to keep object reference; otherwise, false. The default is false. + + + + + Gets or sets a value that indicates whether to preserve collection's items references. + + + true to keep collection's items object references; otherwise, false. The default is false. + + + + + Gets or sets the reference loop handling used when serializing the collection's items. + + The reference loop handling. + + + + Gets or sets the type name handling used when serializing the collection's items. + + The type name handling. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Provides methods for converting between .NET types and JSON types. + + + + + + + + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . + + + + + Represents JavaScript's boolean value true as a string. This field is read-only. + + + + + Represents JavaScript's boolean value false as a string. This field is read-only. + + + + + Represents JavaScript's null as a string. This field is read-only. + + + + + Represents JavaScript's undefined as a string. This field is read-only. + + + + + Represents JavaScript's positive infinity as a string. This field is read-only. + + + + + Represents JavaScript's negative infinity as a string. This field is read-only. + + + + + Represents JavaScript's NaN as a string. This field is read-only. + + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output should be formatted. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a collection of . + + The object to serialize. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting and a collection of . + + The object to serialize. + Indicates how the output should be formatted. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Serializes the to a JSON string. + + The node to serialize. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to serialize. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A flag to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Serializes the to a JSON string. + + The node to convert to JSON. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to convert to JSON. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A flag to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the used when serializing the property's collection items. + + The collection's items . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously skips the children of the current token. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Specifies the state of the reader. + + + + + A read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader is in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the source should be closed when this reader is closed. + + + true to close the source when this reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. + The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Gets or sets how time zones are handled when reading JSON. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets the .NET type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Reads the next JSON token from the source. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the current token and value. + + The new token. + The value. + A flag indicating whether the position index inside an array should be updated. + + + + Sets the state based on current token type. + + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the reader's state to . + If is set to true, the source is also closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to always serialize the member, and to require that the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + + + + + Gets or sets how null values are handled during serialization and deserialization. + + + + + Gets or sets how default values are handled during serialization and deserialization. + + + + + Gets or sets how objects are created during deserialization. + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled during serialization and deserialization. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to reader values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to reader values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Specifies the settings on a object. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) are handled. + + Reference loop handling. + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + + Missing member handling. + + + + Gets or sets how objects are created during deserialization. + + The object creation handling. + + + + Gets or sets how null values are handled during serialization and deserialization. + + Null value handling. + + + + Gets or sets how default values are handled during serialization and deserialization. + + The default value handling. + + + + Gets or sets a collection that will be used during serialization. + + The converters. + + + + Gets or sets how object references are preserved by the serializer. + + The preserve references handling. + + + + Gets or sets how type name writing and reading is handled by the serializer. + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + The type name handling. + + + + Gets or sets how metadata properties are used during deserialization. + + The metadata properties handling. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + + The type name assembly format. + + + + Gets or sets how constructors are used during deserialization. + + The constructor handling. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + The contract resolver. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets the used by the serializer when resolving references. + + The reference resolver. + + + + Gets or sets a function that creates the used by the serializer when resolving references. + + A function that creates the used by the serializer when resolving references. + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the error handler called during serialization and deserialization. + + The error handler called during serialization and deserialization. + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + + + + + Indicates how JSON text output is formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled during serialization and deserialization. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Gets a value indicating whether there will be a check for additional content after deserializing an object. + + + true if there will be a check for additional content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Initializes a new instance of the class with the specified . + + The containing the JSON data to read. + + + + Gets or sets the reader's character buffer pool. + + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + + The current line number or 0 if no line information is available (for example, returns false). + + + + + Gets the current line position. + + + The current line position or 0 if no line information is available (for example, returns false). + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Gets or sets the writer's character array pool. + + + + + Gets or sets how many s to write for each level in the hierarchy when is set to . + + + + + Gets or sets which character to use to quote attribute values. + + + + + Gets or sets which character to use for indenting when is set to . + + + + + Gets or sets a value indicating whether object names will be surrounded with quotes. + + + + + Initializes a new instance of the class using the specified . + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying . + + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the specified end token. + + The end token to write. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Specifies the type of JSON token. + + + + + This is returned by the if a read method has not been called. + + + + + An object start token. + + + + + An array start token. + + + + + A constructor start token. + + + + + An object property name. + + + + + A comment. + + + + + Raw JSON. + + + + + An integer. + + + + + A float. + + + + + A string. + + + + + A boolean. + + + + + A null token. + + + + + An undefined token. + + + + + An object end token. + + + + + An array end token. + + + + + A constructor end token. + + + + + A Date. + + + + + Byte data. + + + + + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Sets an event handler for receiving schema validation errors. + + + + + Gets the text value of the current JSON token. + + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + + Gets the type of the current JSON token. + + + + + + Gets the .NET type for the current JSON token. + + + + + + Initializes a new instance of the class that + validates the content returned from the given . + + The to read from while validating. + + + + Gets or sets the schema. + + The schema. + + + + Gets the used to construct this . + + The specified in the constructor. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a []. + + + A [] or null if the next JSON token is null. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the current token. + + The to read the token from. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the token and its value. + + The to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Asynchronously ets the state of the . + + The being written. + The value being written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asychronousity. + + + + Gets or sets a value indicating whether the destination should be closed when this writer is closed. + + + true to close the destination when this writer is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. + + + true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. + + + + + Gets the top. + + The top. + + + + Gets the state of the writer. + + + + + Gets the path of the writer. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled when writing JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written to JSON text. + + + + + Gets or sets how and values are formatted when writing JSON text. + + + + + Gets or sets the culture used when writing JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the destination and also flushes the destination. + + + + + Closes this writer. + If is set to true, the destination is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of an array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end constructor. + + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes the end of the current JSON object or array. + + + + + Writes the current token and its children. + + The to read the token from. + + + + Writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + + + + Writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + + + + Writes the token. + + The to write. + + + + Writes the specified end token. + + The end token to write. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON without changing the writer's state. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Sets the state of the . + + The being written. + The value being written. + + + + The exception thrown when an error occurs while writing JSON text. + + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Specifies how JSON comments are handled when loading JSON. + + + + + Ignore comments. + + + + + Load comments as a with type . + + + + + Specifies how line information is handled when loading JSON. + + + + + Ignore line information. + + + + + Load line information. + + + + + Contains the LINQ to JSON extension methods. + + + + + Returns a collection of tokens that contains the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. + + + + Returns a collection of child properties of every object in the source collection. + + An of that contains the source collection. + An of that contains the properties of every object in the source collection. + + + + Returns a collection of child values of every object in the source collection with the given key. + + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. + + + + Returns a collection of child values of every object in the source collection. + + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child values of every object in the source collection with the given key. + + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. + + + + Returns a collection of converted child values of every object in the source collection. + + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. + + + + Converts the value. + + The type to convert the value to. + A cast as a of . + A converted value. + + + + Converts the value. + + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. + + + + Returns a collection of child tokens of every array in the source collection. + + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child tokens of every array in the source collection. + + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. + + + + Returns the input typed as . + + An of that contains the source collection. + The input typed as . + + + + Returns the input typed as . + + The source collection type. + An of that contains the source collection. + The input typed as . + + + + Represents a collection of objects. + + The type of token. + + + + Gets the of with the specified key. + + + + + + Represents a JSON array. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the at the specified index. + + + + + + Determines the index of a specific item in the . + + The object to locate in the . + + The index of if found in the list; otherwise, -1. + + + + + Inserts an item to the at the specified index. + + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + + + + + Removes the item at the specified index. + + The zero-based index of the item to remove. + + is not a valid index in the . + + + + + Returns an enumerator that iterates through the collection. + + + A of that can be used to iterate through the collection. + + + + + Adds an item to the . + + The object to add to the . + + + + Removes all items from the . + + + + + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies the elements of the to an array, starting at a particular array index. + + The array. + Index of the array. + + + + Gets a value indicating whether the is read-only. + + true if the is read-only; otherwise, false. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + + + + + Represents a JSON constructor. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets or sets the name of this constructor. + + The constructor name. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name. + + The constructor name. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a token that can contain other tokens. + + + + + Occurs when the list changes or an item in the list changes. + + + + + Occurs before an item is added to the collection. + + + + + Occurs when the items list of the collection has changed, or the collection is reset. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Get the first child token of this token. + + + A containing the first child token of the . + + + + + Get the last child token of this token. + + + A containing the last child token of the . + + + + + Returns a collection of the child tokens of this token, in document order. + + + An of containing the child tokens of this , in document order. + + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + + A containing the child values of this , in document order. + + + + + Returns a collection of the descendant tokens for this token in document order. + + An of containing the descendant tokens of the . + + + + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + + An of containing this token, and all the descendant tokens of the . + + + + Adds the specified content as children of this . + + The content to be added. + + + + Adds the specified content as the first children of this . + + The content to be added. + + + + Creates a that can be used to add tokens to the . + + A that is ready to have content written to it. + + + + Replaces the child nodes of this token with the specified content. + + The content. + + + + Removes the child nodes from this token. + + + + + Merge the specified content into this . + + The content to be merged. + + + + Merge the specified content into this using . + + The content to be merged. + The used to merge the content. + + + + Gets the count of child JSON tokens. + + The count of child JSON tokens. + + + + Represents a collection of objects. + + The type of token. + + + + An empty collection of objects. + + + + + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Gets the of with the specified key. + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Represents a JSON object. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Occurs when a property value changes. + + + + + Occurs when a property value is changing. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Gets the node type for this . + + The type. + + + + Gets an of of this object's properties. + + An of of this object's properties. + + + + Gets a the specified name. + + The property name. + A with the specified name or null. + + + + Gets a of of this object's property values. + + A of of this object's property values. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the with the specified property name. + + + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified property name. + + Name of the property. + The with the specified property name. + + + + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. + + + + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. + + + + Adds the specified property name. + + Name of the property. + The value. + + + + Removes the property with the specified name. + + Name of the property. + true if item was successfully removed; otherwise, false. + + + + Tries to get the with the specified property name. + + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Represents a JSON property. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the property name. + + The property name. + + + + Gets or sets the property value. + + The property value. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a raw JSON string. + + + + + Asynchronously creates an instance of with the content of the reader's current token. + + The reader. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns an instance of with the content of the reader's current token. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class. + + The raw json. + + + + Creates an instance of with the content of the reader's current token. + + The reader. + An instance of with the content of the reader's current token. + + + + Specifies the settings used when merging JSON. + + + + + Gets or sets the method used when merging JSON arrays. + + The method used when merging JSON arrays. + + + + Gets or sets how null value properties are merged. + + How null value properties are merged. + + + + Represents a view of a . + + + + + Initializes a new instance of the class. + + The name. + + + + When overridden in a derived class, returns whether resetting an object changes its value. + + + true if resetting the component changes its value; otherwise, false. + + The component to test for reset capability. + + + + When overridden in a derived class, gets the current value of the property on a component. + + + The value of a property for a given component. + + The component with the property for which to retrieve the value. + + + + When overridden in a derived class, resets the value for this property of the component to the default value. + + The component with the property value that is to be reset to the default value. + + + + When overridden in a derived class, sets the value of the component to a different value. + + The component with the property value that is to be set. + The new value. + + + + When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. + + + true if the property should be persisted; otherwise, false. + + The component with the property to be examined for persistence. + + + + When overridden in a derived class, gets the type of the component this property is bound to. + + + A that represents the type of component this property is bound to. + When the or + + methods are invoked, the object specified might be an instance of this type. + + + + + When overridden in a derived class, gets a value indicating whether this property is read-only. + + + true if the property is read-only; otherwise, false. + + + + + When overridden in a derived class, gets the type of the property. + + + A that represents the type of the property. + + + + + Gets the hash code for the name of the member. + + + + The hash code for the name of the member. + + + + + Represents an abstract JSON token. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Writes this token to a asynchronously. + + A into which this method will write. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Gets a comparer that can compare two tokens for value equality. + + A that can compare two nodes for value equality. + + + + Gets or sets the parent. + + The parent. + + + + Gets the root of this . + + The root of this . + + + + Gets the node type for this . + + The type. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Compares the values of two tokens, including the values of all descendant tokens. + + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. + + + + Gets the next sibling token of this node. + + The that contains the next sibling token. + + + + Gets the previous sibling token of this node. + + The that contains the previous sibling token. + + + + Gets the path of the JSON token. + + + + + Adds the specified content immediately after this token. + + A content object that contains simple content or a collection of content objects to be added after this token. + + + + Adds the specified content immediately before this token. + + A content object that contains simple content or a collection of content objects to be added before this token. + + + + Returns a collection of the ancestor tokens of this token. + + A collection of the ancestor tokens of this token. + + + + Returns a collection of tokens that contain this token, and the ancestors of this token. + + A collection of tokens that contain this token, and the ancestors of this token. + + + + Returns a collection of the sibling tokens after this token, in document order. + + A collection of the sibling tokens after this tokens, in document order. + + + + Returns a collection of the sibling tokens before this token, in document order. + + A collection of the sibling tokens before this token, in document order. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets the with the specified key converted to the specified type. + + The type to convert the token to. + The token key. + The converted token value. + + + + Get the first child token of this token. + + A containing the first child token of the . + + + + Get the last child token of this token. + + A containing the last child token of the . + + + + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + + + + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + + The type to filter the child tokens on. + A containing the child tokens of this , in document order. + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + A containing the child values of this , in document order. + + + + Removes this token from its parent. + + + + + Replaces this token with the specified token. + + The value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Returns the indented JSON for this token. + + + The indented JSON for this token. + + + + + Returns the JSON for this token using the given formatting and converters. + + Indicates how the output should be formatted. + A collection of s which will be used when writing the token. + The JSON for this token using the given formatting and converters. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to []. + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from [] to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Creates a for this token. + + A that can be used to read this token and its descendants. + + + + Creates a from an object. + + The object that will be used to create . + A with the value of the specified object. + + + + Creates a from an object using the specified . + + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + Creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Selects a using a JPath expression. Selects the token that matches the object path. + + + A that contains a JPath expression. + + A , or null. + + + + Selects a using a JPath expression. Selects the token that matches the object path. + + + A that contains a JPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . + + + + Selects a collection of elements using a JPath expression. + + + A that contains a JPath expression. + + An of that contains the selected elements. + + + + Selects a collection of elements using a JPath expression. + + + A that contains a JPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An of that contains the selected elements. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A new instance of the . + + + + Adds an object to the annotation list of this . + + The annotation to add. + + + + Get the first annotation object of the specified type from this . + + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets the first annotation object of the specified type from this . + + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets a collection of annotations of the specified type for this . + + The type of the annotations to retrieve. + An that contains the annotations for this . + + + + Gets a collection of annotations of the specified type for this . + + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . + + + + Removes the annotations of the specified type from this . + + The type of annotations to remove. + + + + Removes the annotations of the specified type from this . + + The of annotations to remove. + + + + Compares tokens to determine whether they are equal. + + + + + Determines whether the specified objects are equal. + + The first object of type to compare. + The second object of type to compare. + + true if the specified objects are equal; otherwise, false. + + + + + Returns a hash code for the specified object. + + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets the at the reader's current position. + + + + + Initializes a new instance of the class. + + The token to read from. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Gets the path of the current JSON token. + + + + + Specifies the type of token. + + + + + No token type has been set. + + + + + A JSON object. + + + + + A JSON array. + + + + + A JSON constructor. + + + + + A JSON object property. + + + + + A comment. + + + + + An integer value. + + + + + A float value. + + + + + A string value. + + + + + A boolean value. + + + + + A null value. + + + + + An undefined value. + + + + + A date value. + + + + + A raw JSON value. + + + + + A collection of bytes value. + + + + + A Guid value. + + + + + A Uri value. + + + + + A TimeSpan value. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets the at the writer's current position. + + + + + Gets the token being written. + + The token being written. + + + + Initializes a new instance of the class writing to the given . + + The container being written to. + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the underlying . + + + + + Closes this writer. + If is set to true, the JSON is auto-completed. + + + Setting to true has no additional effect, since the underlying is a type that cannot be closed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end. + + The token. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes a value. + An error will be raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Represents a value in JSON (string, integer, date, etc). + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Creates a comment with the given value. + + The value. + A comment with the given value. + + + + Creates a string with the given value. + + The value. + A string with the given value. + + + + Creates a null value. + + A null value. + + + + Creates a undefined value. + + A undefined value. + + + + Gets the node type for this . + + The type. + + + + Gets or sets the underlying token value. + + The underlying token value. + + + + Writes this token to a . + + A into which this method will write. + A collection of s which will be used when writing the token. + + + + Indicates whether the current object is equal to another object of the same type. + + + true if the current object is equal to the parameter; otherwise, false. + + An object to compare with this object. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + + Serves as a hash function for a particular type. + + + A hash code for the current . + + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . + + + is not of the same type as this instance. + + + + + Specifies the settings used when loading JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets how JSON comments are handled when loading JSON. + + The JSON comment handling. + + + + Gets or sets how JSON line info is handled when loading JSON. + + The JSON line info handling. + + + + Specifies how JSON arrays are merged together. + + + + Concatenate arrays. + + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + + + Specifies how null value properties are merged. + + + + + The content's null value properties will be ignored during merging. + + + + + The content's null value properties will be merged. + + + + + Specifies the member serialization options for the . + + + + + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. + + + + + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . + + + + + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. + + + + + Specifies metadata property handling options for the . + + + + + Read metadata properties located at the start of a JSON object. + + + + + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + + + + + Do not try to read metadata properties. + + + + + Specifies missing member handling options for the . + + + + + Ignore a missing member and do not attempt to deserialize it. + + + + + Throw a when a missing member is encountered during deserialization. + + + + + Specifies null value handling options for the . + + + + + + + + + Include null values when serializing and deserializing objects. + + + + + Ignore null values when serializing and deserializing objects. + + + + + Specifies how object creation is handled by the . + + + + + Reuse existing objects, create new objects when needed. + + + + + Only reuse existing objects. + + + + + Always create new objects. + + + + + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . + + + + + + + + Do not preserve references when serializing types. + + + + + Preserve references when serializing into a JSON object structure. + + + + + Preserve references when serializing into a JSON array structure. + + + + + Preserve references when serializing. + + + + + Specifies reference loop handling options for the . + + + + + Throw a when a loop is encountered. + + + + + Ignore loop references and do not serialize. + + + + + Serialize loop references. + + + + + Indicating whether a property is required. + + + + + The property is not required. The default state. + + + + + The property must be defined in JSON but can be a null value. + + + + + The property must be defined in JSON and cannot be a null value. + + + + + The property is not required but it cannot be a null value. + + + + + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + The validation event handler. + + + + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the id. + + + + + Gets or sets the title. + + + + + Gets or sets whether the object is required. + + + + + Gets or sets whether the object is read-only. + + + + + Gets or sets whether the object is visible to users. + + + + + Gets or sets whether the object is transient. + + + + + Gets or sets the description of the object. + + + + + Gets or sets the types of values allowed by the object. + + The type. + + + + Gets or sets the pattern. + + The pattern. + + + + Gets or sets the minimum length. + + The minimum length. + + + + Gets or sets the maximum length. + + The maximum length. + + + + Gets or sets a number that the value should be divisible by. + + A number that the value should be divisible by. + + + + Gets or sets the minimum. + + The minimum. + + + + Gets or sets the maximum. + + The maximum. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). + + A flag indicating whether the value can not equal the number defined by the minimum attribute (). + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). + + A flag indicating whether the value can not equal the number defined by the maximum attribute (). + + + + Gets or sets the minimum number of items. + + The minimum number of items. + + + + Gets or sets the maximum number of items. + + The maximum number of items. + + + + Gets or sets the of items. + + The of items. + + + + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + + true if items are validated using their array position; otherwise, false. + + + + + Gets or sets the of additional items. + + The of additional items. + + + + Gets or sets a value indicating whether additional items are allowed. + + + true if additional items are allowed; otherwise, false. + + + + + Gets or sets whether the array items must be unique. + + + + + Gets or sets the of properties. + + The of properties. + + + + Gets or sets the of additional properties. + + The of additional properties. + + + + Gets or sets the pattern properties. + + The pattern properties. + + + + Gets or sets a value indicating whether additional properties are allowed. + + + true if additional properties are allowed; otherwise, false. + + + + + Gets or sets the required property if this property is present. + + The required property if this property is present. + + + + Gets or sets the a collection of valid enum values allowed. + + A collection of valid enum values allowed. + + + + Gets or sets disallowed types. + + The disallowed types. + + + + Gets or sets the default value. + + The default value. + + + + Gets or sets the collection of that this schema extends. + + The collection of that this schema extends. + + + + Gets or sets the format. + + The format. + + + + Initializes a new instance of the class. + + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The object representing the JSON Schema. + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. + + + + Load a from a string that contains JSON Schema. + + A that contains JSON Schema. + A populated from the string that contains JSON Schema. + + + + Load a from a string that contains JSON Schema using the specified . + + A that contains JSON Schema. + The resolver. + A populated from the string that contains JSON Schema. + + + + Writes this schema to a . + + A into which this method will write. + + + + Writes this schema to a using the specified . + + A into which this method will write. + The resolver used. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + + Returns detailed information about the schema exception. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets how undefined schemas are handled by the serializer. + + + + + Gets or sets the contract resolver. + + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + + Resolves from an id. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the loaded schemas. + + The loaded schemas. + + + + Initializes a new instance of the class. + + + + + Gets a for the specified reference. + + The id. + A for the specified reference. + + + + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. + + + + + + Specifies undefined schema Id handling options for the . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Do not infer a schema Id. + + + + + Use the .NET type name as the schema Id. + + + + + Use the assembly qualified .NET type name as the schema Id. + + + + + + Returns detailed information related to the . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the associated with the validation error. + + The JsonSchemaException associated with the validation error. + + + + Gets the path of the JSON location where the validation error occurred. + + The path of the JSON location where the validation error occurred. + + + + Gets the text description corresponding to the validation error. + + The text description. + + + + + Represents the callback method that will handle JSON schema validation events and the . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Allows users to control class loading and mandate what class to load. + + + + + When implemented, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When implemented, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + A snake case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + A camel case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used by to resolve a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets the default members search flags. + + The default members search flags. + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + + + true if the interface will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + + + true if the attribute will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + + The naming strategy used to resolve how property names and dictionary keys are serialized. + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Gets the serializable members for the type. + + The type to get serializable members for. + The serializable members for the type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates the constructor parameters. + + The constructor to create properties for. + The type's member properties. + Properties for the given . + + + + Creates a for the given . + + The matching member property. + The constructor parameter. + A created for the given . + + + + Resolves the default for the contract. + + Type of the object. + The contract's default . + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Determines which contract type is created for the given type. + + Type of the object. + A for the given type. + + + + Creates properties for the given . + + The type to create properties for. + /// The member serialization mode for the type. + Properties for the given . + + + + Creates the used by the serializer to get and set values from a member. + + The member. + The used by the serializer to get and set values from a member. + + + + Creates a for the given . + + The member's parent . + The member to create a for. + A created for the given . + + + + Resolves the name of the property. + + Name of the property. + Resolved name of the property. + + + + Resolves the name of the extension data. By default no changes are made to extension data names. + + Name of the extension data. + Resolved name of the extension data. + + + + Resolves the key of the dictionary. By default is used to resolve dictionary keys. + + Key of the dictionary. + Resolved key of the dictionary. + + + + Gets the resolved name of the property. + + Name of the property. + Name of the property. + + + + The default naming strategy. Property names and dictionary keys are unchanged. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + The default serialization binder used when resolving and loading classes from type names. + + + + + Initializes a new instance of the class. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + The type of the object the formatter creates a new instance of. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer that writes to the application's instances. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides information surrounding an error. + + + + + Gets the error. + + The error. + + + + Gets the original object that caused the error. + + The original object that caused the error. + + + + Gets the member that caused the error. + + The member that caused the error. + + + + Gets the path of the JSON location where the error occurred. + + The path of the JSON location where the error occurred. + + + + Gets or sets a value indicating whether this is handled. + + true if handled; otherwise, false. + + + + Provides data for the Error event. + + + + + Gets the current object the error event is being raised against. + + The current object the error event is being raised against. + + + + Gets the error context. + + The error context. + + + + Initializes a new instance of the class. + + The current object. + The error context. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides methods to get attributes. + + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Used by to resolve a for a given . + + + + + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + A base class for resolving how property names and dictionary keys are serialized. + + + + + A flag indicating whether dictionary keys should be processed. + Defaults to false. + + + + + A flag indicating whether extension data names should be processed. + Defaults to false. + + + + + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. + + + + + Gets the serialized name for a given property name. + + The initial property name. + A flag indicating whether the property has had a name explicitly specified. + The serialized property name. + + + + Gets the serialized name for a given extension data name. + + The initial extension data name. + The serialized extension data name. + + + + Gets the serialized key for a given dictionary key. + + The initial dictionary key. + The serialized dictionary key. + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Used to resolve references when serializing and deserializing JSON by the . + + + + + Resolves a reference to its object. + + The serialization context. + The reference to resolve. + The object that was resolved from the reference. + + + + Gets the reference for the specified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + + The serialization context. + The object to test for a reference. + + true if the specified object is referenced; otherwise, false. + + + + + Adds a reference to the specified object. + + The serialization context. + The reference. + The object to reference. + + + + Represents a trace writer. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + The that will be used to filter the trace messages passed to the writer. + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides methods to get and set values. + + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Contract details for a used by the . + + + + + Gets the of the collection items. + + The of the collection items. + + + + Gets a value indicating whether the collection type is a multidimensional array. + + true if the collection type is a multidimensional array; otherwise, false. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the collection values. + + true if the creator has a parameter with the collection values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the default collection items . + + The converter. + + + + Gets or sets a value indicating whether the collection items preserve object references. + + true if collection items preserve object references; otherwise, false. + + + + Gets or sets the collection item reference loop handling. + + The reference loop handling. + + + + Gets or sets the collection item type name handling. + + The type name handling. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Handles serialization callback events. + + The object that raised the callback event. + The streaming context. + + + + Handles serialization error callback events. + + The object that raised the callback event. + The streaming context. + The error context. + + + + Sets extension data for an object during deserialization. + + The object to set extension data on. + The extension data key. + The extension data value. + + + + Gets extension data for an object during serialization. + + The object to set extension data on. + + + + Contract details for a used by the . + + + + + Gets the underlying type for the contract. + + The underlying type for the contract. + + + + Gets or sets the type created during deserialization. + + The type created during deserialization. + + + + Gets or sets whether this type contract is serialized as a reference. + + Whether this type contract is serialized as a reference. + + + + Gets or sets the default for this contract. + + The converter. + + + + Gets or sets all methods called immediately after deserialization of the object. + + The methods called immediately after deserialization of the object. + + + + Gets or sets all methods called during deserialization of the object. + + The methods called during deserialization of the object. + + + + Gets or sets all methods called after serialization of the object graph. + + The methods called after serialization of the object graph. + + + + Gets or sets all methods called before serialization of the object. + + The methods called before serialization of the object. + + + + Gets or sets all method called when an error is thrown during the serialization of the object. + + The methods called when an error is thrown during the serialization of the object. + + + + Gets or sets the default creator method used to create the object. + + The default creator method used to create the object. + + + + Gets or sets a value indicating whether the default creator is non-public. + + true if the default object creator is non-public; otherwise, false. + + + + Contract details for a used by the . + + + + + Gets or sets the dictionary key resolver. + + The dictionary key resolver. + + + + Gets the of the dictionary keys. + + The of the dictionary keys. + + + + Gets the of the dictionary values. + + The of the dictionary values. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the dictionary values. + + true if the creator has a parameter with the dictionary values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets the object's properties. + + The object's properties. + + + + Gets or sets the property name resolver. + + The property name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object constructor. + + The object constructor. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object member serialization. + + The member object serialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Gets the object's properties. + + The object's properties. + + + + Gets a collection of instances that define the parameters used with . + + + + + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. + + The function used to create the object. + + + + Gets or sets the extension data setter. + + + + + Gets or sets the extension data getter. + + + + + Gets or sets the extension data value type. + + + + + Gets or sets the extension data name resolver. + + The extension data name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Maps a JSON property to a .NET member or constructor parameter. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the type that declared this property. + + The type that declared this property. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets the name of the underlying member or parameter. + + The name of the underlying member or parameter. + + + + Gets the that will get and set the during serialization. + + The that will get and set the during serialization. + + + + Gets or sets the for this property. + + The for this property. + + + + Gets or sets the type of the property. + + The type of the property. + + + + Gets or sets the for the property. + If set this converter takes precedence over the contract converter for the property type. + + The converter. + + + + Gets or sets the member converter. + + The member converter. + + + + Gets or sets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets or sets a value indicating whether this is readable. + + true if readable; otherwise, false. + + + + Gets or sets a value indicating whether this is writable. + + true if writable; otherwise, false. + + + + Gets or sets a value indicating whether this has a member attribute. + + true if has a member attribute; otherwise, false. + + + + Gets the default value. + + The default value. + + + + Gets or sets a value indicating whether this is required. + + A value indicating whether this is required. + + + + Gets or sets a value indicating whether this property preserves object references. + + + true if this instance is reference; otherwise, false. + + + + + Gets or sets the property null value handling. + + The null value handling. + + + + Gets or sets the property default value handling. + + The default value handling. + + + + Gets or sets the property reference loop handling. + + The reference loop handling. + + + + Gets or sets the property object creation handling. + + The object creation handling. + + + + Gets or sets or sets the type name handling. + + The type name handling. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets a predicate used to determine whether the property should be deserialized. + + A predicate used to determine whether the property should be deserialized. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets an action used to set whether the property has been deserialized. + + An action used to set whether the property has been deserialized. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets or sets the converter used when serializing the property's collection items. + + The collection's items converter. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + The type. + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + The key for the specified element. + + + + Adds a object. + + The property to add to the collection. + + + + Gets the closest matching object. + First attempts to get an exact case match of and then + a case insensitive match. + + Name of the property. + A matching property if found. + + + + Gets a property by property name. + + The name of the property to get. + Type property name string comparison. + A matching property if found. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Lookup and create an instance of the type described by the argument. + + The type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. + + + + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Initializes a new instance of the class. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Returns an enumeration of the most recent trace messages. + + An enumeration of the most recent trace messages. + + + + Returns a of the most recent trace messages. + + + A of the most recent trace messages. + + + + + Represents a method that constructs an object. + + The object type to create. + + + + When applied to a method, specifies that the method is called when an error occurs serializing an object. + + + + + Provides methods to get attributes from a , , or . + + + + + Initializes a new instance of the class. + + The instance to get attributes for. This parameter should be a , , or . + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Get and set values for a using reflection. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. + + + + + Specifies how strings are escaped when writing JSON text. + + + + + Only control characters (e.g. newline) are escaped. + + + + + All non-ASCII and control characters (e.g. newline) are escaped. + + + + + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + + + + + Specifies type name handling options for the . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Do not include the .NET type name when serializing types. + + + + + Include the .NET type name when serializing into a JSON object structure. + + + + + Include the .NET type name when serializing into a JSON array structure. + + + + + Always include the .NET type name when serializing. + + + + + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON + you must specify a root type object with + or . + + + + + Determines whether the collection is null or empty. + + The collection. + + true if the collection is null or empty; otherwise, false. + + + + + Adds the elements of the specified collection to the specified generic . + + The list to add to. + The collection of elements to add. + + + + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. + + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. + + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic that returns a result + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Returns a Restrictions object which includes our current restrictions merged + with a restriction limiting our type + + + + + Gets a dictionary of the names and values of an type. + + + + + + Gets a dictionary of the names and values of an Enum type. + + The enum type to get names and values for. + + + + + Gets the type of the typed collection's items. + + The type. + The type of the typed collection's items. + + + + Gets the member's underlying type. + + The member. + The underlying type of the member. + + + + Determines whether the member is an indexed property. + + The member. + + true if the member is an indexed property; otherwise, false. + + + + + Determines whether the property is an indexed property. + + The property. + + true if the property is an indexed property; otherwise, false. + + + + + Gets the member's value on the object. + + The member. + The target object. + The member's value on the object. + + + + Sets the member's value on the target object. + + The member. + The target. + The value. + + + + Determines whether the specified MemberInfo can be read. + + The MemberInfo to determine whether can be read. + /// if set to true then allow the member to be gotten non-publicly. + + true if the specified MemberInfo can be read; otherwise, false. + + + + + Determines whether the specified MemberInfo can be set. + + The MemberInfo to determine whether can be set. + if set to true then allow the member to be set non-publicly. + if set to true then allow the member to be set if read-only. + + true if the specified MemberInfo can be set; otherwise, false. + + + + + Builds a string. Unlike this class lets you reuse its internal buffer. + + + + + Determines whether the string is all white space. Empty string will return false. + + The string to test whether it is all white space. + + true if the string is all white space; otherwise, false. + + + + + Specifies the state of the . + + + + + An exception has been thrown, which has left the in an invalid state. + You may call the method to put the in the Closed state. + Any other method calls result in an being thrown. + + + + + The method has been called. + + + + + An object is being written. + + + + + An array is being written. + + + + + A constructor is being written. + + + + + A property is being written. + + + + + A write method has not been called. + + + + diff --git a/app_data/jobs/triggered/utility/Npgsql.dll b/app_data/jobs/triggered/utility/Npgsql.dll new file mode 100644 index 000000000..864b592d1 Binary files /dev/null and b/app_data/jobs/triggered/utility/Npgsql.dll differ diff --git a/app_data/jobs/triggered/utility/Npgsql.xml b/app_data/jobs/triggered/utility/Npgsql.xml new file mode 100644 index 000000000..cfb059565 --- /dev/null +++ b/app_data/jobs/triggered/utility/Npgsql.xml @@ -0,0 +1,12345 @@ + + + + Npgsql + + + + + Note that this message doesn't actually contain the data, but only the length. Data is processed + directly from the connector's buffer. + + + + + DataRow is special in that it does not parse the actual contents of the backend message, + because in sequential mode the message will be traversed and processed sequentially by + . + + + + + Error and notice message field codes + + + + + A RowDescription message sent from the backend. + + + See https://www.postgresql.org/docs/current/static/protocol-message-formats.html + + + + + Given a string name, returns the field's ordinal index in the row. + + + + + Given a string name, returns the field's ordinal index in the row. + + + + + Comparer that's case-insensitive and Kana width-insensitive + + + + + A descriptive record on a single field received from PostgreSQL. + See RowDescription in https://www.postgresql.org/docs/current/static/protocol-message-formats.html + + + + + The field name. + + + + + The object ID of the field's data type. + + + + + The data type size (see pg_type.typlen). Note that negative values denote variable-width types. + + + + + The type modifier (see pg_attribute.atttypmod). The meaning of the modifier is type-specific. + + + + + If the field can be identified as a column of a specific table, the object ID of the table; otherwise zero. + + + + + If the field can be identified as a column of a specific table, the attribute number of the column; otherwise zero. + + + + + The format code being used for the field. + Currently will be zero (text) or one (binary). + In a RowDescription returned from the statement variant of Describe, the format code is not yet known and will always be zero. + + + + + The Npgsql type handler assigned to handle this field. + Returns for fields with format text. + + + + + Returns a string that represents the current object. + + + + + Base class for all classes which represent a message sent by the PostgreSQL backend. + + + + + Specifies the type of SQL statement, e.g. SELECT + + + + + Contains the connection string returned to the user from + after the connection has been opened. Does not contain the password unless Persist Security Info=true. + + + + + Tracks all connectors currently managed by this pool, whether idle or busy. + Only updated rarely - when physical connections are opened/closed - but is read in perf-sensitive contexts. + + + + + Reader side for the idle connector channel. Contains nulls in order to release waiting attempts after + a connector has been physically closed/broken. + + + + + Incremented every time this pool is cleared via or + . Allows us to identify connections which were + created before the clear. + + + + + A pool-wide type mapper used when multiplexing. This is necessary because binding parameters + to their type handlers happens *before* the command is enqueued for execution, so there's no + connector yet at that stage. + + + + + When multiplexing is enabled, determines the maximum amount of time to wait for further + commands before flushing to the network. In ticks (100ns), 0 disables waiting. + This is in 100ns ticks, not ticks whose meaning vary across platforms. + + + + + When multiplexing is enabled, determines the maximum number of outgoing bytes to buffer before + flushing to the network. + + + + + Called exactly once per multiplexing pool, when the first connection is opened, with two goals: + 1. Load types and bind the pool-wide type mapper (necessary for binding parameters) + 2. Cause any connection exceptions (e.g. bad username) to be thrown from NpgsqlConnection.Open + + + + + A factory which get generate instances of , which describe a database + and the types it contains. When first connecting to a database, Npgsql will attempt to load information + about it via this factory. + + + + + Given a connection, loads all necessary information about the connected database, e.g. its types. + A factory should only handle the exact database type it was meant for, and return null otherwise. + + + An object describing the database to which is connected, or null if the + database isn't of the correct type and isn't handled by this factory. + + + + + Launches MIT Kerberos klist and parses out the default principal from it. + Caches the result. + + + + + An logging provider that outputs Npgsql logging messages to standard error. + + + + + Constructs a new + + Only messages of this level of higher will be logged + If true, will output the log level (e.g. WARN). Defaults to false. + If true, will output the connector ID. Defaults to false. + + + + Creates a new instance of the given name. + + + + Used to create logger instances of the given name. + + + + Creates a new INpgsqlLogger instance of the given name. + + + + + A generic interface for logging. + + + + + Manages logging for Npgsql, used to set the logging provider. + + + + + The logging provider used for logging in Npgsql. + + + + + Determines whether parameter contents will be logged alongside SQL statements - this may reveal sensitive information. + Defaults to false. + + + + + A component which translates a CLR name (e.g. SomeClass) into a database name (e.g. some_class) + according to some scheme. + Used for mapping enum and composite types. + + + + + Given a CLR type name (e.g class, struct, enum), translates its name to a database type name. + + + + + Given a CLR member name (property or field), translates its name to a database type name. + + + + + A name translator which preserves CLR names (e.g. SomeClass) when mapping names to the database. + + + + + Given a CLR type name (e.g class, struct, enum), translates its name to a database type name. + + + + + Given a CLR member name (property or field), translates its name to a database type name. + + + + + A name translator which converts standard CLR names (e.g. SomeClass) to snake-case database + names (some_class) + + + + + Creates a new . + + + + + Creates a new . + + Uses the legacy naming convention if true, otherwise it uses the new naming convention. + + + + Given a CLR type name (e.g class, struct, enum), translates its name to a database type name. + + + + + Given a CLR member name (property or field), translates its name to a database type name. + + + + + Converts a string to its snake_case equivalent. + + The value to convert. + + + + This mechanism is used to temporarily set the current synchronization context to null while + executing Npgsql code, making all await continuations execute on the thread pool. This replaces + the need to place ConfigureAwait(false) everywhere, and should be used in all surface async methods, + without exception. + + Warning: do not use this directly in async methods, use it in sync wrappers of async methods + (see https://github.com/npgsql/npgsql/issues/1593) + + + https://stackoverflow.com/a/28307965/640325 + + + + + Provides an API for a binary COPY TO operation, a high-performance data export mechanism from + a PostgreSQL table. Initiated by + + + + + The number of columns, as returned from the backend in the CopyInResponse. + + + + + Current timeout + + + + + Starts reading a single row, must be invoked before reading any columns. + + + The number of columns in the row. -1 if there are no further rows. + Note: This will currently be the same value for all rows, but this may change in the future. + + + + + Starts reading a single row, must be invoked before reading any columns. + + + The number of columns in the row. -1 if there are no further rows. + Note: This will currently be the same value for all rows, but this may change in the future. + + + + + Reads the current column, returns its value and moves ahead to the next column. + If the column is null an exception is thrown. + + + The type of the column to be read. This must correspond to the actual type or data + corruption will occur. If in doubt, use to manually + specify the type. + + The value of the column + + + + Reads the current column, returns its value and moves ahead to the next column. + If the column is null an exception is thrown. + + + The type of the column to be read. This must correspond to the actual type or data + corruption will occur. If in doubt, use to manually + specify the type. + + The value of the column + + + + Reads the current column, returns its value according to and + moves ahead to the next column. + If the column is null an exception is thrown. + + + In some cases isn't enough to infer the data type coming in from the + database. This parameter and be used to unambiguously specify the type. An example is the JSONB + type, for which will be a simple string but for which + must be specified as . + + The .NET type of the column to be read. + The value of the column + + + + Reads the current column, returns its value according to and + moves ahead to the next column. + If the column is null an exception is thrown. + + + In some cases isn't enough to infer the data type coming in from the + database. This parameter and be used to unambiguously specify the type. An example is the JSONB + type, for which will be a simple string but for which + must be specified as . + + + The .NET type of the column to be read. + The value of the column + + + + Returns whether the current column is null. + + + + + Skips the current column without interpreting its value. + + + + + Skips the current column without interpreting its value. + + + + + Cancels an ongoing export. + + + + + Completes that binary export and sets the connection back to idle state + + + + + Async completes that binary export and sets the connection back to idle state + + + + + + Provides an API for a binary COPY FROM operation, a high-performance data import mechanism to + a PostgreSQL table. Initiated by + + + See https://www.postgresql.org/docs/current/static/sql-copy.html. + + + + + The number of columns in the current (not-yet-written) row. + + + + + The number of columns, as returned from the backend in the CopyInResponse. + + + + + Current timeout + + + + + Starts writing a single row, must be invoked before writing any columns. + + + + + Starts writing a single row, must be invoked before writing any columns. + + + + + Writes a single column in the current row. + + The value to be written + + The type of the column to be written. This must correspond to the actual type or data + corruption will occur. If in doubt, use to manually + specify the type. + + + + + Writes a single column in the current row. + + The value to be written + + + The type of the column to be written. This must correspond to the actual type or data + corruption will occur. If in doubt, use to manually + specify the type. + + + + + Writes a single column in the current row as type . + + The value to be written + + In some cases isn't enough to infer the data type to be written to + the database. This parameter and be used to unambiguously specify the type. An example is + the JSONB type, for which will be a simple string but for which + must be specified as . + + The .NET type of the column to be written. + + + + Writes a single column in the current row as type . + + The value to be written + + In some cases isn't enough to infer the data type to be written to + the database. This parameter and be used to unambiguously specify the type. An example is + the JSONB type, for which will be a simple string but for which + must be specified as . + + + The .NET type of the column to be written. + + + + Writes a single column in the current row as type . + + The value to be written + + In some cases isn't enough to infer the data type to be written to + the database. This parameter and be used to unambiguously specify the type. + + The .NET type of the column to be written. + + + + Writes a single column in the current row as type . + + The value to be written + + In some cases isn't enough to infer the data type to be written to + the database. This parameter and be used to unambiguously specify the type. + + + The .NET type of the column to be written. + + + + Writes a single null column value. + + + + + Writes a single null column value. + + + + + Writes an entire row of columns. + Equivalent to calling , followed by multiple + on each value. + + An array of column values to be written as a single row + + + + Writes an entire row of columns. + Equivalent to calling , followed by multiple + on each value. + + + An array of column values to be written as a single row + + + + Completes the import operation. The writer is unusable after this operation. + + + + + Completes the import operation. The writer is unusable after this operation. + + + + + Cancels that binary import and sets the connection back to idle state + + + + + Async cancels that binary import and sets the connection back to idle state + + + + + + Completes the import process and signals to the database to write everything. + + + + + Async completes the import process and signals to the database to write everything. + + + + + + + Represents a SQL statement or function (stored procedure) to execute + against a PostgreSQL database. This class cannot be inherited. + + + + + If this command is (explicitly) prepared, references the connector on which the preparation happened. + Used to detect when the connector was changed (i.e. connection open/close), meaning that the command + is no longer prepared. + + + + + Returns details about each statement that this command has executed. + Is only populated when an Execute* method is called. + + + + + Initializes a new instance of the NpgsqlCommand class. + + + + + Initializes a new instance of the NpgsqlCommand class with the text of the query. + + The text of the query. + + + + Initializes a new instance of the NpgsqlCommand class with the text of the query and a NpgsqlConnection. + + The text of the query. + A NpgsqlConnection that represents the connection to a PostgreSQL server. + + + + Initializes a new instance of the NpgsqlCommand class with the text of the query, a NpgsqlConnection, and the NpgsqlTransaction. + + The text of the query. + A NpgsqlConnection that represents the connection to a PostgreSQL server. + The NpgsqlTransaction in which the NpgsqlCommand executes. + + + + Gets or sets the SQL statement or function (stored procedure) to execute at the data source. + + The Transact-SQL statement or stored procedure to execute. The default is an empty string. + + + + Gets or sets the wait time (in seconds) before terminating the attempt to execute a command and generating an error. + + The time (in seconds) to wait for the command to execute. The default value is 30 seconds. + + + + Gets or sets a value indicating how the + CommandText property is to be interpreted. + + One of the CommandType values. The default is CommandType.Text. + + + + DB connection. + + + + + Gets or sets the NpgsqlConnection + used by this instance of the NpgsqlCommand. + + The connection to a data source. The default value is a null reference. + + + + Design time visible. + + + + + Gets or sets how command results are applied to the DataRow when used by the + DbDataAdapter.Update(DataSet) method. + + One of the UpdateRowSource values. + + + + Returns whether this query will execute as a prepared (compiled) query. + + + + + Marks all of the query's result columns as either known or unknown. + Unknown results column are requested them from PostgreSQL in text format, and Npgsql makes no + attempt to parse them. They will be accessible as strings only. + + + + + Marks the query's result columns as known or unknown, on a column-by-column basis. + Unknown results column are requested them from PostgreSQL in text format, and Npgsql makes no + attempt to parse them. They will be accessible as strings only. + + + If the query includes several queries (e.g. SELECT 1; SELECT 2), this will only apply to the first + one. The rest of the queries will be fetched and parsed as usual. + + The array size must correspond exactly to the number of result columns the query returns, or an + error will be raised. + + + + + Marks result types to be used when using GetValue on a data reader, on a column-by-column basis. + Used for Entity Framework 5-6 compability. + Only primitive numerical types and DateTimeOffset are supported. + Set the whole array or just a value to null to use default type. + + + + + The current state of the command + + + + + Creates a new instance of an DbParameter object. + + An DbParameter object. + + + + Creates a new instance of a NpgsqlParameter object. + + A NpgsqlParameter object. + + + + DB parameter collection. + + + + + Gets the NpgsqlParameterCollection. + + The parameters of the SQL statement or function (stored procedure). The default is an empty collection. + + + + Creates a server-side prepared statement on the PostgreSQL server. + This will make repeated future executions of this command much faster. + + + + + Creates a server-side prepared statement on the PostgreSQL server. + This will make repeated future executions of this command much faster. + + The token to monitor for cancellation requests. The default value is . + + + + Unprepares a command, closing server-side statements associated with it. + Note that this only affects commands explicitly prepared with , not + automatically prepared statements. + + + + + Unprepares a command, closing server-side statements associated with it. + Note that this only affects commands explicitly prepared with , not + automatically prepared statements. + + The token to monitor for cancellation requests. The default value is . + + + + Executes a SQL statement against the connection and returns the number of rows affected. + + The number of rows affected if known; -1 otherwise. + + + + Asynchronous version of + + The token to monitor for cancellation requests. + A task representing the asynchronous operation, with the number of rows affected if known; -1 otherwise. + + + + Executes the query, and returns the first column of the first row + in the result set returned by the query. Extra columns or rows are ignored. + + The first column of the first row in the result set, + or a null reference if the result set is empty. + + + + Asynchronous version of + + The token to monitor for cancellation requests. + A task representing the asynchronous operation, with the first column of the + first row in the result set, or a null reference if the result set is empty. + + + + Executes the command text against the connection. + + A task representing the operation. + + + + Executes the command text against the connection. + + An instance of . + The token to monitor for cancellation requests. + A task representing the asynchronous operation. + + + + Executes the against the + and returns a . + + One of the enumeration values that specified the command behavior. + A task representing the operation. + + + + An asynchronous version of , which executes + the against the + and returns a . + + The token to monitor for cancellation requests. The default value is . + A task representing the asynchronous operation. + + + + An asynchronous version of , + which executes the against the + and returns a . + + One of the enumeration values that specified the command behavior. + The token to monitor for cancellation requests. + A task representing the asynchronous operation. + + + + DB transaction. + + + + + This property is ignored by Npgsql. PostgreSQL only supports a single transaction at a given time on + a given connection, and all commands implicitly run inside the current transaction started via + + + + + + Attempts to cancel the execution of an . + + As per the specs, no exception will be thrown by this method in case of failure. + + + + Releases the resources used by the NpgsqlCommand. + + + + + Fixes up the text/binary flag on result columns. + Since Prepare() describes a statement rather than a portal, the resulting RowDescription + will have text format on all result columns. Fix that up. + + + Note that UnknownResultTypeList only applies to the first query, while AllResultTypesAreUnknown applies + to all of them. + + + + + Create a new command based on this one. + + A new NpgsqlCommand object. + + + + Create a new command based on this one. + + A new NpgsqlCommand object. + + + + This class is responsible to create database commands for automatic insert, update and delete operations. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The adapter. + + + + Gets or sets the beginning character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens. + + + The beginning character or characters to use. The default is an empty string. + + + + + + + + Gets or sets the ending character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens. + + + The ending character or characters to use. The default is an empty string. + + + + + + + + + This method is responsible to derive the command parameter list with values obtained from function definition. + It clears the Parameters collection of command. Also, if there is any parameter type which is not supported by Npgsql, an InvalidOperationException will be thrown. + Parameters name will be parameter1, parameter2, ... for CommandType.StoredProcedure and named after the placeholder for CommandType.Text + + NpgsqlCommand whose function parameters will be obtained. + + + + Gets the automatically generated object required + to perform insertions at the data source. + + + The automatically generated object required to perform insertions. + + + + + Gets the automatically generated object required to perform insertions + at the data source, optionally using columns for parameter names. + + + If true, generate parameter names matching column names, if possible. + If false, generate @p1, @p2, and so on. + + + The automatically generated object required to perform insertions. + + + + + Gets the automatically generated System.Data.Common.DbCommand object required + to perform updates at the data source. + + + The automatically generated System.Data.Common.DbCommand object required to perform updates. + + + + + Gets the automatically generated object required to perform updates + at the data source, optionally using columns for parameter names. + + + If true, generate parameter names matching column names, if possible. + If false, generate @p1, @p2, and so on. + + + The automatically generated object required to perform updates. + + + + + Gets the automatically generated System.Data.Common.DbCommand object required + to perform deletions at the data source. + + + The automatically generated System.Data.Common.DbCommand object required to perform deletions. + + + + + Gets the automatically generated object required to perform deletions + at the data source, optionally using columns for parameter names. + + + If true, generate parameter names matching column names, if possible. + If false, generate @p1, @p2, and so on. + + + The automatically generated object required to perform deletions. + + + + + Applies the parameter information. + + The parameter. + The row. + Type of the statement. + if set to true [where clause]. + + + + Returns the name of the specified parameter in the format of @p#. + + The number to be included as part of the parameter's name.. + + The name of the parameter with the specified number appended as part of the parameter name. + + + + + Returns the full parameter name, given the partial parameter name. + + The partial name of the parameter. + + The full parameter name corresponding to the partial parameter name requested. + + + + + Returns the placeholder for the parameter in the associated SQL statement. + + The number to be included as part of the parameter's name. + + The name of the parameter with the specified number appended. + + + + + Registers the to handle the event for a . + + The to be used for the update. + + + + Adds an event handler for the event. + + The sender + A instance containing information about the event. + + + + Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier, including properly escaping any embedded quotes in the identifier. + + The original unquoted identifier. + + The quoted version of the identifier. Embedded quotes within the identifier are properly escaped. + + + + + Unquoted identifier parameter cannot be null + + + + Given a quoted identifier, returns the correct unquoted form of that identifier, including properly un-escaping any embedded quotes in the identifier. + + The identifier that will have its embedded quotes removed. + + The unquoted identifier, with embedded quotes properly un-escaped. + + + + + Quoted identifier parameter cannot be null + + + + This class represents a connection to a PostgreSQL server. + + + + + The connection string, without the password after open (unless Persist Security Info=true) + + + + + The original connection string provided by the user, including the password. + + + + + The physical connection to the database. This is null when the connection is closed, + and also when it is open in multiplexing mode and unbound (e.g. not in a transaction). + + + + + The parsed connection string set by the user + + + + + Flag used to make sure we never double-close a connection, returning it twice to the pool. + + + + + The global type mapper, which contains defaults used by all new connections. + Modify mappings on this mapper to affect your entire application. + + + + + The connection-specific type mapper - all modifications affect this connection only, + and are lost when it is closed. + + + + + The default TCP/IP port for PostgreSQL. + + + + + Maximum value for connection timeout. + + + + + Tracks when this connection was bound to a physical connector (e.g. at open-time, when a transaction + was started...). + + + + + Initializes a new instance of the + NpgsqlConnection class. + + + + + Initializes a new instance of with the given connection string. + + The connection used to open the PostgreSQL database. + + + + Opens a database connection with the property settings specified by the + ConnectionString. + + + + + This is the asynchronous version of . + + + Do not invoke other methods and properties of the object until the returned Task is complete. + + The token to monitor for cancellation requests. + A task representing the asynchronous operation. + + + + Gets or sets the string used to connect to a PostgreSQL database. See the manual for details. + + The connection string that includes the server name, + the database name, and other parameters needed to establish + the initial connection. The default value is an empty string. + + + + + Gets or sets the delegate used to generate a password for new database connections. + + + This delegate is executed when a new database connection is opened that requires a password. + Password and + Passfile connection string + properties have precedence over this delegate. It will not be executed if a password is + specified, or the specified or default Passfile contains a valid entry. + Due to connection pooling this delegate is only executed when a new physical connection + is opened, not when reusing a connection that was previously opened from the pool. + + + + + Backend server host name. + + + + + Backend server port. + + + + + Gets the time (in seconds) to wait while trying to establish a connection + before terminating the attempt and generating an error. + + The time (in seconds) to wait for a connection to open. The default value is 15 seconds. + + + + Gets the time (in seconds) to wait while trying to execute a command + before terminating the attempt and generating an error. + + The time (in seconds) to wait for a command to complete. The default value is 20 seconds. + + + + Gets the name of the current database or the database to be used after a connection is opened. + + The name of the current database or the name of the database to be + used after a connection is opened. The default value is the empty string. + + + + Gets the string identifying the database server (host and port) + + + The name of the database server (host and port). If the connection uses a Unix-domain socket, + the path to that socket is returned. The default value is the empty string. + + + + + Whether to use Windows integrated security to log in. + + + + + User name. + + + + + Gets the current state of the connection. + + A bitwise combination of the ConnectionState values. The default is Closed. + + + + Gets whether the current state of the connection is Open or Closed + + ConnectionState.Open, ConnectionState.Closed or ConnectionState.Connecting + + + + Creates and returns a DbCommand + object associated with the IDbConnection. + + A DbCommand object. + + + + Creates and returns a NpgsqlCommand + object associated with the NpgsqlConnection. + + A NpgsqlCommand object. + + + + Begins a database transaction with the specified isolation level. + + The isolation level under which the transaction should run. + An DbTransaction + object representing the new transaction. + + Currently the IsolationLevel ReadCommitted and Serializable are supported by the PostgreSQL backend. + There's no support for nested transactions. + + + + + Begins a database transaction. + + A NpgsqlTransaction + object representing the new transaction. + + Currently there's no support for nested transactions. Transactions created by this method will have Read Committed isolation level. + + + + + Begins a database transaction with the specified isolation level. + + The isolation level under which the transaction should run. + A NpgsqlTransaction + object representing the new transaction. + + Currently the IsolationLevel ReadCommitted and Serializable are supported by the PostgreSQL backend. + There's no support for nested transactions. + + + + + Enlist transaction. + + + + + Releases the connection. If the connection is pooled, it will be returned to the pool and made available for re-use. + If it is non-pooled, the physical connection will be closed. + + + + + Releases the connection. If the connection is pooled, it will be returned to the pool and made available for re-use. + If it is non-pooled, the physical connection will be closed. + + + + + Releases all resources used by the NpgsqlConnection. + + true when called from Dispose(); + false when being called from the finalizer. + + + + Releases all resources used by the NpgsqlConnection. + + + + + Fires when PostgreSQL notices are received from PostgreSQL. + + + PostgreSQL notices are non-critical messages generated by PostgreSQL, either as a result of a user query + (e.g. as a warning or informational notice), or due to outside activity (e.g. if the database administrator + initiates a "fast" database shutdown). + + Note that notices are very different from notifications (see the event). + + + + + Fires when PostgreSQL notifications are received from PostgreSQL. + + + PostgreSQL notifications are sent when your connection has registered for notifications on a specific channel via the + LISTEN command. NOTIFY can be used to generate such notifications, allowing for an inter-connection communication channel. + + Note that notifications are very different from notices (see the event). + + + + + Returns whether SSL is being used for the connection. + + + + + Returns whether SCRAM-SHA256 is being user for the connection + + + + + Returns whether SCRAM-SHA256-PLUS is being user for the connection + + + + + Selects the local Secure Sockets Layer (SSL) certificate used for authentication. + + + See + + + + + Verifies the remote Secure Sockets Layer (SSL) certificate used for authentication. + Ignored if is set. + + + See + + + + + Version of the PostgreSQL backend. + This can only be called when there is an active connection. + + + + + PostgreSQL server version. + + + + + Process id of backend server. + This can only be called when there is an active connection. + + + + + Reports whether the backend uses the newer integer timestamp representation. + Note that the old floating point representation is not supported. + Meant for use by type plugins (e.g. NodaTime) + + + + + The connection's timezone as reported by PostgreSQL, in the IANA/Olson database format. + + + + + Holds all PostgreSQL parameters received for this connection. Is updated if the values change + (e.g. as a result of a SET command). + + + + + Begins a binary COPY FROM STDIN operation, a high-performance data import mechanism to a PostgreSQL table. + + A COPY FROM STDIN SQL command + A which can be used to write rows and columns + + See https://www.postgresql.org/docs/current/static/sql-copy.html. + + + + + Begins a binary COPY TO STDOUT operation, a high-performance data export mechanism from a PostgreSQL table. + + A COPY TO STDOUT SQL command + A which can be used to read rows and columns + + See https://www.postgresql.org/docs/current/static/sql-copy.html. + + + + + Begins a textual COPY FROM STDIN operation, a data import mechanism to a PostgreSQL table. + It is the user's responsibility to send the textual input according to the format specified + in . + + A COPY FROM STDIN SQL command + + A TextWriter that can be used to send textual data. + + See https://www.postgresql.org/docs/current/static/sql-copy.html. + + + + + Begins a textual COPY TO STDOUT operation, a data export mechanism from a PostgreSQL table. + It is the user's responsibility to parse the textual input according to the format specified + in . + + A COPY TO STDOUT SQL command + + A TextReader that can be used to read textual data. + + See https://www.postgresql.org/docs/current/static/sql-copy.html. + + + + + Begins a raw binary COPY operation (TO STDOUT or FROM STDIN), a high-performance data export/import mechanism to a PostgreSQL table. + Note that unlike the other COPY API methods, doesn't implement any encoding/decoding + and is unsuitable for structured import/export operation. It is useful mainly for exporting a table as an opaque + blob, for the purpose of importing it back later. + + A COPY TO STDOUT or COPY FROM STDIN SQL command + A that can be used to read or write raw binary data. + + See https://www.postgresql.org/docs/current/static/sql-copy.html. + + + + + Maps a CLR enum to a PostgreSQL enum type for use with this connection. + + + CLR enum labels are mapped by name to PostgreSQL enum labels. + The translation strategy can be controlled by the parameter, + which defaults to . + You can also use the on your enum fields to manually specify a PostgreSQL enum label. + If there is a discrepancy between the .NET and database labels while an enum is read or written, + an exception will be raised. + + Can only be invoked on an open connection; if the connection is closed the mapping is lost. + + To avoid mapping the type for each connection, use the method. + + + A PostgreSQL type name for the corresponding enum type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + The .NET enum type to be mapped + + + + Maps a CLR enum to a PostgreSQL enum type for use with all connections created from now on. Existing connections aren't affected. + + + CLR enum labels are mapped by name to PostgreSQL enum labels. + The translation strategy can be controlled by the parameter, + which defaults to . + You can also use the on your enum fields to manually specify a PostgreSQL enum label. + If there is a discrepancy between the .NET and database labels while an enum is read or written, + an exception will be raised. + + To map the type for a specific connection, use the method. + + + A PostgreSQL type name for the corresponding enum type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + The .NET enum type to be mapped + + + + Removes a previous global enum mapping. + + + A PostgreSQL type name for the corresponding enum type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + + + + Maps a CLR type to a PostgreSQL composite type for use with this connection. + + + CLR fields and properties by string to PostgreSQL enum labels. + The translation strategy can be controlled by the parameter, + which defaults to . + You can also use the on your members to manually specify a PostgreSQL enum label. + If there is a discrepancy between the .NET and database labels while a composite is read or written, + an exception will be raised. + + Can only be invoked on an open connection; if the connection is closed the mapping is lost. + + To avoid mapping the type for each connection, use the method. + + + A PostgreSQL type name for the corresponding enum type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + The .NET type to be mapped + + + + Maps a CLR type to a PostgreSQL composite type for use with all connections created from now on. Existing connections aren't affected. + + + CLR fields and properties by string to PostgreSQL enum labels. + The translation strategy can be controlled by the parameter, + which defaults to . + You can also use the on your members to manually specify a PostgreSQL enum label. + If there is a discrepancy between the .NET and database labels while a composite is read or written, + an exception will be raised. + + To map the type for a specific connection, use the method. + + + A PostgreSQL type name for the corresponding enum type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + The .NET type to be mapped + + + + Removes a previous global enum mapping. + + + A PostgreSQL type name for the corresponding enum type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + + + + Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and + exits immediately. The asynchronous message is delivered via the normal events + (, ). + + + The time-out value, in milliseconds, passed to . + The default value is 0, which indicates an infinite time-out period. + Specifying -1 also indicates an infinite time-out period. + + true if an asynchronous message was received, false if timed out. + + + + Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and + exits immediately. The asynchronous message is delivered via the normal events + (, ). + + + The time-out value is passed to . + + true if an asynchronous message was received, false if timed out. + + + + Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and + exits immediately. The asynchronous message is delivered via the normal events + (, ). + + + + + Waits asynchronously until an asynchronous PostgreSQL messages (e.g. a notification) + arrives, and exits immediately. The asynchronous message is delivered via the normal events + (, ). + + + The time-out value, in milliseconds. + The default value is 0, which indicates an infinite time-out period. + Specifying -1 also indicates an infinite time-out period. + + The token to monitor for cancellation requests. The default value is . + true if an asynchronous message was received, false if timed out. + + + + Waits asynchronously until an asynchronous PostgreSQL messages (e.g. a notification) + arrives, and exits immediately. The asynchronous message is delivered via the normal events + (, ). + + + The time-out value as + + The token to monitor for cancellation requests. The default value is . + true if an asynchronous message was received, false if timed out. + + + + Waits asynchronously until an asynchronous PostgreSQL messages (e.g. a notification) + arrives, and exits immediately. The asynchronous message is delivered via the normal events + (, ). + + The token to monitor for cancellation requests. The default value is . + + + + Returns whether the connection is currently bound to a connector. + + + + + Checks whether the connection is currently bound to a connector, and if so, returns it via + . + + + + + Binds this connection to a physical connector. This happens when opening a non-multiplexing connection, + or when starting a transaction on a multiplexed connection. + + + + + Ends binding scope to the physical connection and returns it to the pool. Only useful with multiplexing on. + + + After this method is called, under no circumstances the physical connection (connector) should ever be used if multiplexing is on. + See #3249. + + + + + Returns the supported collections + + + + + Returns the schema collection specified by the collection name. + + The collection name. + The collection specified. + + + + Returns the schema collection specified by the collection name filtered by the restrictions. + + The collection name. + + The restriction values to filter the results. A description of the restrictions is contained + in the Restrictions collection. + + The collection specified. + + + + Asynchronously returns the supported collections. + + The token to monitor for cancellation requests. The default value is None. + The collection specified. + + + + Asynchronously returns the schema collection specified by the collection name. + + The collection name. + The token to monitor for cancellation requests. The default value is None. + The collection specified. + + + + Asynchronously returns the schema collection specified by the collection name filtered by the restrictions. + + The collection name. + + The restriction values to filter the results. A description of the restrictions is contained + in the Restrictions collection. + + The token to monitor for cancellation requests. The default value is None. + The collection specified. + + + + Creates a closed connection with the connection string and authentication details of this message. + + + + + Clones this connection, replacing its connection string with the given one. + This allows creating a new connection with the same security information + (password, SSL callbacks) while changing other connection parameters (e.g. + database or pooling) + + + + + This method changes the current database by disconnecting from the actual + database and connecting to the specified. + + The name of the database to use in place of the current database. + + + + DB provider factory. + + + + + Clears the connection pool. All idle physical connections in the pool of the given connection are + immediately closed, and any busy connections which were opened before was called + will be closed when returned to the pool. + + + + + Clear all connection pools. All idle physical connections in all pools are immediately closed, and any busy + connections which were opened before was called will be closed when returned + to their pool. + + + + + Unprepares all prepared statements on this connection. + + + + + Flushes the type cache for this connection's connection string and reloads the types for this connection only. + Type changes will appear for other connections only after they are re-opened from the pool. + + + + + The connection is currently not bound to a connector. + + + + + The connection is bound to its connector for the scope of the entire connection + (i.e. non-multiplexed connection). + + + + + The connection is bound to its connector for the scope of a transaction. + + + + + The connection is bound to its connector for the scope of a COPY operation. + + + + + The connection is bound to its connector for the scope of a single reader. + + + + + The connection is bound to its connector for the scope of establishing a new physical connection. + + + + + The connection is bound to its connector for an unspecified, temporary scope; the code that initiated + the binding is also responsible to unbind it. + + + + + Represents a method that handles the event. + + The source of the event. + A that contains the notice information (e.g. message, severity...). + + + + Represents a method that handles the event. + + The source of the event. + A that contains the notification payload. + + + + Represents the method that allows the application to provide a certificate collection to be used for SSL client authentication + + A X509CertificateCollection to be filled with one or more client certificates. + + + + Represents the method that allows the application to provide a password at connection time in code rather than configuration + + Hostname + Port + Database Name + User + A valid password for connecting to the database + + + + Provides a simple way to create and manage the contents of connection strings used by + the class. + + + + + Makes all valid keywords for a property to that property (e.g. User Name -> Username, UserId -> Username...) + + + + + Maps CLR property names (e.g. BufferSize) to their canonical keyword name, which is the + property's [DisplayName] (e.g. Buffer Size) + + + + + Maps each property to its [DefaultValue] + + + + + Cached DataSource value to reduce allocations on NpgsqlConnection.DataSource.get + + + + + Initializes a new instance of the NpgsqlConnectionStringBuilder class. + + + + + Initializes a new instance of the NpgsqlConnectionStringBuilder class, optionally using ODBC rules for quoting values. + + true to use {} to delimit fields; false to use quotation marks. + + + + Initializes a new instance of the NpgsqlConnectionStringBuilder class and sets its . + + + + + Gets or sets the value associated with the specified key. + + The key of the item to get or set. + The value associated with the specified key. + + + + Adds an item to the . + + The key-value pair to be added. + + + + Removes the entry with the specified key from the DbConnectionStringBuilder instance. + + The key of the key/value pair to be removed from the connection string in this DbConnectionStringBuilder. + true if the key existed within the connection string and was removed; false if the key did not exist. + + + + Removes the entry from the DbConnectionStringBuilder instance. + + The key/value pair to be removed from the connection string in this DbConnectionStringBuilder. + true if the key existed within the connection string and was removed; false if the key did not exist. + + + + Clears the contents of the instance. + + + + + Determines whether the contains a specific key. + + The key to locate in the . + true if the contains an entry with the specified key; otherwise false. + + + + Determines whether the contains a specific key-value pair. + + The item to locate in the . + true if the contains the entry; otherwise false. + + + + Retrieves a value corresponding to the supplied key from this . + + The key of the item to retrieve. + The value corresponding to the key. + true if keyword was found within the connection string, false otherwise. + + + + The hostname or IP address of the PostgreSQL server to connect to. + + + + + The TCP/IP port of the PostgreSQL server. + + + + + The PostgreSQL database to connect to. + + + + + The username to connect with. Not required if using IntegratedSecurity. + + + + + The password to connect with. Not required if using IntegratedSecurity. + + + + + Path to a PostgreSQL password file (PGPASSFILE), from which the password would be taken. + + + + + The optional application name parameter to be sent to the backend during connection initiation. + + + + + Whether to enlist in an ambient TransactionScope. + + + + + Gets or sets the schema search path. + + + + + Gets or sets the client_encoding parameter. + + + + + Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. + + + + + Gets or sets the PostgreSQL session timezone, in Olson/IANA database format. + + + + + Controls whether SSL is required, disabled or preferred, depending on server support. + + + + + Whether to trust the server certificate without validating it. + + + + + Location of a client certificate to be sent to the server. + + + + + Key for a client certificate to be sent to the server. + + + + + Location of a CA certificate used to validate the server certificate. + + + + + Whether to check the certificate revocation list during authentication. + False by default. + + + + + Whether to use Windows integrated security to log in. + + + + + The Kerberos service name to be used for authentication. + + + + + The Kerberos realm to be used for authentication. + + + + + Gets or sets a Boolean value that indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state. + + + + + When enabled, parameter values are logged when commands are executed. Defaults to false. + + + + + When enabled, PostgreSQL error details are included on and + . These can contain sensitive data. + + + + + Whether connection pooling should be used. + + + + + The minimum connection pool size. + + + + + The maximum connection pool size. + + + + + The time to wait before closing idle connections in the pool if the count + of all connections exceeds MinPoolSize. + + The time (in seconds) to wait. The default value is 300. + + + + How many seconds the pool waits before attempting to prune idle connections that are beyond + idle lifetime (. + + The interval (in seconds). The default value is 10. + + + + The total maximum lifetime of connections (in seconds). Connections which have exceeded this value will be + destroyed instead of returned from the pool. This is useful in clustered configurations to force load + balancing between a running server and a server just brought online. + + The time (in seconds) to wait, or 0 to to make connections last indefinitely (the default). + + + + The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. + Defaults to 15 seconds. + + + + + The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. + Defaults to 30 seconds. + + + + + The time to wait (in seconds) while trying to execute a an internal command before terminating the attempt and generating an error. + + + + + The time to wait (in milliseconds) while trying to read a response for a cancellation request for a timed out or cancelled query, before terminating the attempt and generating an error. + Defaults to 2000 milliseconds. + + + + + The database template to specify when creating a database in Entity Framework. If not specified, + PostgreSQL defaults to "template1". + + + https://www.postgresql.org/docs/current/static/manage-ag-templatedbs.html + + + + + The database admin to specify when creating and dropping a database in Entity Framework. This is needed because + Npgsql needs to connect to a database in order to send the create/drop database command. + If not specified, defaults to "template1". Check NpgsqlServices.UsingPostgresDBConnection for more information. + + + + + The number of seconds of connection inactivity before Npgsql sends a keepalive query. + Set to 0 (the default) to disable. + + + + + Whether to use TCP keepalive with system defaults if overrides isn't specified. + + + + + The number of seconds of connection inactivity before a TCP keepalive query is sent. + Use of this option is discouraged, use instead if possible. + Set to 0 (the default) to disable. + + + + + The interval, in seconds, between when successive keep-alive packets are sent if no acknowledgement is received. + Defaults to the value of . must be non-zero as well. + + + + + Determines the size of the internal buffer Npgsql uses when reading. Increasing may improve performance if transferring large values from the database. + + + + + Determines the size of the internal buffer Npgsql uses when writing. Increasing may improve performance if transferring large values to the database. + + + + + Determines the size of socket read buffer. + + + + + Determines the size of socket send buffer. + + + + + The maximum number SQL statements that can be automatically prepared at any given point. + Beyond this number the least-recently-used statement will be recycled. + Zero (the default) disables automatic preparation. + + + + + The minimum number of usages an SQL statement is used before it's automatically prepared. + Defaults to 5. + + + + + If set to true, a pool connection's state won't be reset when it is closed (improves performance). + Do not specify this unless you know what you're doing. + + + + + Load table composite type definitions, and not just free-standing composite types. + + + + + Set the replication mode of the connection + + + This property and its corresponding enum are intentionally kept internal as they + should not be set by users or even be visible in their connection strings. + Replication connections are a special kind of connection that is encapsulated in + + and . + + + + + Set PostgreSQL configuration parameter default values for the connection. + + + + + Configure the way arrays of value types are returned when requested as object instances. + + + + + Enables multiplexing, which allows more efficient use of connections. + + + + + When multiplexing is enabled, determines the maximum amount of time to wait for further + commands before flushing to the network. In microseconds, 0 disables waiting altogether. + + + + + When multiplexing is enabled, determines the maximum number of outgoing bytes to buffer before + flushing to the network. + + + + + A compatibility mode for special PostgreSQL server types. + + + + + Makes MaxValue and MinValue timestamps and dates readable as infinity and negative infinity. + + + + + Obsolete, see https://www.npgsql.org/doc/release-notes/3.1.html + + + + + Obsolete, see https://www.npgsql.org/doc/release-notes/3.1.html + + + + + Obsolete, see https://www.npgsql.org/doc/release-notes/3.0.html + + + + + Obsolete, see https://www.npgsql.org/doc/release-notes/3.0.html + + + + + Obsolete, see https://www.npgsql.org/doc/release-notes/4.1.html + + + + + Writes connection performance information to performance counters. + + + + + Determines whether the specified object is equal to the current object. + + + + + Hash function. + + + + + + Gets an containing the keys of the . + + + + + Gets an containing the values in the . + + + + + Copies the elements of the to an Array, starting at a particular Array index. + + + The one-dimensional Array that is the destination of the elements copied from . + The Array must have zero-based indexing. + + + The zero-based index in array at which copying begins. + + + + + Returns an enumerator that iterates through the . + + + + + + Marks on which participate in the connection + string. Optionally holds a set of synonyms for the property. + + + + + Holds a list of synonyms for the property. + + + + + Creates a . + + + + + Creates a . + + + + + An option specified in the connection string that activates special compatibility features. + + + + + No special server compatibility mode is active + + + + + The server is an Amazon Redshift instance. + + + + + The server is doesn't support full type loading from the PostgreSQL catalogs, support the basic set + of types via information hardcoded inside Npgsql. + + + + + Specifies how to manage SSL. + + + + + SSL is disabled. If the server requires SSL, the connection will fail. + + + + + Prefer SSL connections if the server allows them, but allow connections without SSL. + + + + + Fail the connection if the server doesn't support SSL. + + + + + Specifies how the mapping of arrays of + value types + behaves with respect to nullability when they are requested via an API returning an . + + + + + Arrays of value types are always returned as non-nullable arrays (e.g. int[]). + If the PostgreSQL array contains a NULL value, an exception is thrown. This is the default mode. + + + + + Arrays of value types are always returned as nullable arrays (e.g. int?[]). + + + + + The type of array that gets returned is determined at runtime. + Arrays of value types are returned as non-nullable arrays (e.g. int[]) + if the actual instance that gets returned doesn't contain null values + and as nullable arrays (e.g. int?[]) if it does. + + When using this setting, make sure that your code is prepared to the fact + that the actual type of array instances returned from APIs like + may change on a row by row base. + + + + Specifies whether the connection shall be initialized as a physical or + logical replication connection + + + This enum and its corresponding property are intentionally kept internal as they + should not be set by users or even be visible in their connection strings. + Replication connections are a special kind of connection that is encapsulated in + + and . + + + + + Replication disabled. This is the default + + + + + Physical replication enabled + + + + + Logical replication enabled + + + + + Represents a connection to a PostgreSQL backend. Unlike NpgsqlConnection objects, which are + exposed to users, connectors are internal to Npgsql and are recycled by the connection pool. + + + + + This Stream is placed between NegotiateStream and the socket's NetworkStream (or SSLStream). It intercepts + traffic and performs the following operations: + * Outgoing messages are framed in PostgreSQL's PasswordMessage, and incoming are stripped of it. + * NegotiateStream frames payloads with a 5-byte header, which PostgreSQL doesn't understand. This header is + stripped from outgoing messages and added to incoming ones. + + + See https://referencesource.microsoft.com/#System/net/System/Net/_StreamFramer.cs,16417e735f0e9530,references + + + + + The physical connection socket to the backend. + + + + + The physical connection stream to the backend, without anything on top. + + + + + The physical connection stream to the backend, layered with an SSL/TLS stream if in secure mode. + + + + + Same as , except that it does not throw an exception if an invalid char is + encountered (exception fallback), but rather replaces it with a question mark character (replacement + fallback). + + + + + Buffer used for reading data. + + + + + If we read a data row that's bigger than , we allocate an oversize buffer. + The original (smaller) buffer is stored here, and restored when the connection is reset. + + + + + Buffer used for writing data. + + + + + The secret key of the backend for this connector, used for query cancellation. + + + + + The process ID of the backend for this connector. + + + + + A unique ID identifying this connector, used for logging. Currently mapped to BackendProcessId + + + + + The current transaction status for this connector. + + + + + A transaction object for this connector. Since only one transaction can be in progress at any given time, + this instance is recycled. To check whether a transaction is currently in progress on this connector, + see . + + + + + The NpgsqlConnection that (currently) owns this connector. Null if the connector isn't + owned (i.e. idle in the pool) + + + + + The number of messages that were prepended to the current message chain, but not yet sent. + Note that this only tracks messages which produce a ReadyForQuery message + + + + + If the connector is currently in COPY mode, holds a reference to the importer/exporter object. + Otherwise null. + + + + + Holds all run-time parameters received from the backend (via ParameterStatus messages) + + + + + Holds all run-time parameters in raw, binary format for efficient handling without allocations. + + + + + If this connector was broken, this contains the exception that caused the break. + + + + + Semaphore, used to synchronize DatabaseInfo between multiple connections, so it wouldn't be loaded in parallel. + + + + + + Used by the pool to indicate that I/O is currently in progress on this connector, so that another write + isn't started concurrently. Note that since we have only one write loop, this is only ever usedto + protect against an over-capacity writes into a connector that's currently *asynchronously* writing. + + + It is guaranteed that the currently-executing + Specifically, reading may occur - and the connector may even be returned to the pool - before this is + released. + + + + + + + + + + + + The timeout for reading messages that are part of the user's command + (i.e. which aren't internal prepended commands). + + Precision is milliseconds + + + + A lock that's taken while a user action is in progress, e.g. a command being executed. + Only used when keepalive is enabled, otherwise null. + + + + + A lock that's taken while a cancellation is being delivered; new queries are blocked until the + cancellation is delivered. This reduces the chance that a cancellation meant for a previous + command will accidentally cancel a later one, see #615. + + + + + The command currently being executed by the connector, null otherwise. + Used only for concurrent use error reporting purposes. + + + + + Contains the UTC timestamp when this connector was opened, used to implement + . + + + + + The minimum timeout that can be set on internal commands such as COMMIT, ROLLBACK. + + Precision is seconds + + + + Creates a new connector with the given connection string. + + The parsed connection string. + The connection string. + + + + The actual command timeout value that gets set on internal commands. + + Precision is milliseconds + + + + Gets the current state of the connector + + + + + Returns whether the connector is open, regardless of any task it is currently performing + + + + + Opens the physical connection to the server. + + Usually called by the RequestConnector + Method of the connection pool manager. + + + + Prepends a message to be sent at the beginning of the next message chain. + + + + + Reads backend messages and discards them, stopping only after a message of the given type has + been seen. Only a sync I/O version of this method exists - in async flows we inline the loop + rather than calling an additional async method, in order to avoid the overhead. + + + + + Handles a new transaction indicator received on a ReadyForQuery message + + + + + Returns whether SSL is being used for the connection + + + + + Returns whether SCRAM-SHA256 is being user for the connection + + + + + Returns whether SCRAM-SHA256-PLUS is being user for the connection + + + + + Creates another connector and sends a cancel request through it for this connector. This method never throws, but returns + whether the cancellation attempt failed. + + + + if the cancellation request was successfully delivered, or if it was skipped because a previous + request was already sent. if the cancellation request could not be delivered because of an exception + (the method logs internally). + + + This does not indicate whether the cancellation attempt was successful on the PostgreSQL side - only if the request was + delivered. + + + + + + Starts a new cancellable operation within an ongoing user action. This should only be used if a single user + action spans several different actions which each has its own cancellation tokens. For example, a command + execution is a single user action, but spans ExecuteReaderQuery, NextResult, Read and so forth. + + + Only one level of nested operations is supported. It is an error to call this method if it has previously + been called, and the returned was not disposed. + + + The cancellation token provided by the user. Callbacks will be registered on this token for executing the + cancellation, and the token will be included in any thrown . + + + If , PostgreSQL cancellation will be attempted when the user requests cancellation or + a timeout occurs, followed by a client-side socket cancellation once + has elapsed. If , + PostgreSQL cancellation will be skipped and client-socket cancellation will occur immediately. + + + + + Closes ongoing operations, i.e. an open reader exists or a COPY operation still in progress, as + part of a connection close. + + + + + Called when an unexpected message has been received during an action. Breaks the + connector and returns the appropriate message. + + + + + Called when a connector becomes completely unusable, e.g. when an unexpected I/O exception is raised or when + we lose protocol sync. + Note that fatal errors during the Open phase do *not* pass through here. + + The exception that caused the break. + The exception given in for chaining calls. + + + + Closes the socket and cleans up client-side resources associated with this connector. + + + This method doesn't actually perform any meaningful I/O, and therefore is sync-only. + + + + + Called when a pooled connection is closed, and its connector is returned to the pool. + Resets the connector back to its initial state, releasing server-side sources + (e.g. prepared statements), resetting parameters to their defaults, and resetting client-side + state + + + + + Starts a user action. This makes sure that another action isn't already in progress, handles synchronization with keepalive, + and sets up cancellation. + + The new state to be set when entering this user action. + + The that is starting execution - if an is + thrown, it will reference this. + + + The cancellation token provided by the user. Callbacks will be registered on this token for executing the cancellation, + and the token will be included in any thrown . + + + If , PostgreSQL cancellation will be attempted when the user requests cancellation or a timeout + occurs, followed by a client-side socket cancellation once has + elapsed. If , PostgreSQL cancellation will be skipped and client-socket cancellation will occur + immediately. + + + + + An IDisposable wrapper around . + + + + + The connection's timezone as reported by PostgreSQL, in the IANA/Olson database format. + + + + + Expresses the exact state of a connector. + + + + + The connector has either not yet been opened or has been closed. + + + + + The connector is currently connecting to a PostgreSQL server. + + + + + The connector is connected and may be used to send a new query. + + + + + The connector is waiting for a response to a query which has been sent to the server. + + + + + The connector is currently fetching and processing query results. + + + + + The connector is currently waiting for asynchronous notifications to arrive. + + + + + The connection was broken because an unexpected error occurred which left it in an unknown state. + This state isn't implemented yet. + + + + + The connector is engaged in a COPY operation. + + + + + The connector is engaged in streaming replication. + + + + + Currently not in a transaction block + + + + + Currently in a transaction block + + + + + Currently in a failed transaction block (queries will be rejected until block is ended) + + + + + A new transaction has been requested but not yet transmitted to the backend. It will be transmitted + prepended to the next query. + This is a client-side state option only, and is never transmitted from the backend. + + + + + Specifies how to load/parse DataRow messages as they're received from the backend. + + + + + Load DataRows in non-sequential mode + + + + + Load DataRows in sequential mode + + + + + Skip DataRow messages altogether + + + + + Represents the method that handles the RowUpdated events. + + The source of the event. + A NpgsqlRowUpdatedEventArgs that contains the event data. + + + + Represents the method that handles the RowUpdating events. + + The source of the event. + A NpgsqlRowUpdatingEventArgs that contains the event data. + + + + This class represents an adapter from many commands: select, update, insert and delete to fill Datasets. + + + + + Row updated event. + + + + + Row updating event. + + + + + Default constructor. + + + + + Constructor. + + + + + + Constructor. + + + + + + + Constructor. + + + + + + + Create row updated event. + + + + + Create row updating event. + + + + + Raise the RowUpdated event. + + + + + + Raise the RowUpdating event. + + + + + + Delete command. + + + + + Select command. + + + + + Update command. + + + + + Insert command. + + + + + Base class for implementations which provide information about PostgreSQL and PostgreSQL-like databases + (e.g. type definitions, capabilities...). + + + + + The hostname of IP address of the database. + + + + + The TCP port of the database. + + + + + The database name. + + + + + The version of the PostgreSQL database we're connected to, as reported in the "server_version" parameter. + Exposed via . + + + + + Whether the backend supports range types. + + + + + Whether the backend supports enum types. + + + + + Whether the backend supports the CLOSE ALL statement. + + + + + Whether the backend supports advisory locks. + + + + + Whether the backend supports the DISCARD SEQUENCES statement. + + + + + Whether the backend supports the UNLISTEN statement. + + + + + Whether the backend supports the DISCARD TEMP statement. + + + + + Whether the backend supports the DISCARD statement. + + + + + Reports whether the backend uses the newer integer timestamp representation. + + + + + Whether the database supports transactions. + + + + + Indexes backend types by their type OID. + + + + + Indexes backend types by their PostgreSQL name, including namespace (e.g. pg_catalog.int4). + Only used for enums and composites. + + + + + Indexes backend types by their PostgreSQL name, not including namespace. + If more than one type exists with the same name (i.e. in different namespaces) this + table will contain an entry with a null value. + Only used for enums and composites. + + + + + Initializes the instance of . + + + + + Provides all PostgreSQL types detected in this database. + + + + + + Parses a PostgreSQL server version (e.g. 10.1, 9.6.3) and returns a CLR Version. + + + + + Registers a new database info factory, which is used to load information about databases. + + + + + Reads a forward-only stream of rows from a data source. + + + + + The behavior of the command with which this reader was executed. + + + + + In multiplexing, this is as the sending is managed in the write multiplexing loop, + and does not need to be awaited by the reader. + + + + + Holds the list of statements being executed by this reader. + + + + + The index of the current query resultset we're processing (within a multiquery) + + + + + The number of columns in the current row + + + + + Records, for each column, its starting offset and length in the current row. + Used only in non-sequential mode. + + + + + The index of the column that we're on, i.e. that has already been parsed, is + is memory and can be retrieved. Initialized to -1, which means we're on the column + count (which comes before the first column). + + + + + For streaming types (e.g. bytea), holds the byte length of the column. + Does not include the length prefix. + + + + + The position in the buffer at which the current data row message ends. + Used only in non-sequential mode. + + + + + The RowDescription message for the current resultset being processed + + + + + Whether the current result set has rows + + + + + Is raised whenever Close() is called. + + + + + A stream that has been opened on a column. + + + + + Used for internal temporary purposes + + + + + Advances the reader to the next record in a result set. + + true if there are more rows; otherwise false. + + The default position of a data reader is before the first record. Therefore, you must call Read to begin accessing data. + + + + + This is the asynchronous version of + + The token to monitor for cancellation requests. + A task representing the asynchronous operation. + + + + Advances the reader to the next result when reading the results of a batch of statements. + + + + + + This is the asynchronous version of NextResult. + + The token to monitor for cancellation requests. + A task representing the asynchronous operation. + + + + Internal implementation of NextResult + + + + + Note that in SchemaOnly mode there are no resultsets, and we read nothing from the backend (all + RowDescriptions have already been processed and are available) + + + + + Gets a value indicating the depth of nesting for the current row. Always returns zero. + + + + + Gets a value indicating whether the data reader is closed. + + + + + Gets the number of rows changed, inserted, or deleted by execution of the SQL statement. + + + + + Returns details about each statement that this reader will or has executed. + + + Note that some fields (i.e. rows and oid) are only populated as the reader + traverses the result. + + For commands with multiple queries, this exposes the number of rows affected on + a statement-by-statement basis, unlike + which exposes an aggregation across all statements. + + + + + Gets a value that indicates whether this DbDataReader contains one or more rows. + + + + + Indicates whether the reader is currently positioned on a row, i.e. whether reading a + column is possible. + This property is different from in that will + return true even if attempting to read a column will fail, e.g. before + has been called + + + + + Gets the name of the column, given the zero-based column ordinal. + + The zero-based column ordinal. + The name of the specified column. + + + + Gets the number of columns in the current row. + + + + + Consumes all result sets for this reader, leaving the connector ready for sending and processing further + queries + + + + + Releases the resources used by the NpgsqlDataReader. + + + + + Releases the resources used by the NpgsqlDataReader. + + + + + Closes the reader, allowing a new command to be executed. + + + + + Closes the reader, allowing a new command to be executed. + + + + + Gets the value of the specified column as a Boolean. + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as a byte. + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as a single character. + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as a 16-bit signed integer. + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as a 32-bit signed integer. + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as a 64-bit signed integer. + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as a object. + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as an instance of . + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as a object. + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as a double-precision floating point number. + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as a single-precision floating point number. + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as a globally-unique identifier (GUID). + + The zero-based column ordinal. + The value of the specified column. + + + + Populates an array of objects with the column values of the current row. + + An array of Object into which to copy the attribute columns. + The number of instances of in the array. + + + + Gets the value of the specified column as an instance of . + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as an , + Npgsql's provider-specific type for dates. + + + PostgreSQL's date type represents dates from 4713 BC to 5874897 AD, while .NET's DateTime + only supports years from 1 to 1999. If you require years outside this range use this accessor. + The standard method will also return this type, but has + the disadvantage of boxing the value. + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as a TimeSpan, + + + PostgreSQL's interval type has has a resolution of 1 microsecond and ranges from + -178000000 to 178000000 years, while .NET's TimeSpan has a resolution of 100 nanoseconds + and ranges from roughly -29247 to 29247 years. + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as an , + Npgsql's provider-specific type for time spans. + + + PostgreSQL's interval type has has a resolution of 1 microsecond and ranges from + -178000000 to 178000000 years, while .NET's TimeSpan has a resolution of 100 nanoseconds + and ranges from roughly -29247 to 29247 years. If you require values from outside TimeSpan's + range use this accessor. + The standard ADO.NET method will also return this + type, but has the disadvantage of boxing the value. + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as an , + Npgsql's provider-specific type for date/time timestamps. Note that this type covers + both PostgreSQL's "timestamp with time zone" and "timestamp without time zone" types, + which differ only in how they are converted upon input/output. + + + PostgreSQL's timestamp type represents dates from 4713 BC to 5874897 AD, while .NET's DateTime + only supports years from 1 to 1999. If you require years outside this range use this accessor. + The standard method will also return this type, but has + the disadvantage of boxing the value. + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + The zero-based column ordinal. + The value of the specified column. + + + + Reads a stream of bytes from the specified column, starting at location indicated by dataOffset, into the buffer, starting at the location indicated by bufferOffset. + + The zero-based column ordinal. + The index within the row from which to begin the read operation. + The buffer into which to copy the data. + The index with the buffer to which the data will be copied. + The maximum number of characters to read. + The actual number of bytes read. + + + + Retrieves data as a . + + The zero-based column ordinal. + The returned object. + + + + Retrieves data as a . + + The zero-based column ordinal. + The token to monitor for cancellation requests. The default value is . + The returned object. + + + + Reads a stream of characters from the specified column, starting at location indicated by dataOffset, into the buffer, starting at the location indicated by bufferOffset. + + The zero-based column ordinal. + The index within the row from which to begin the read operation. + The buffer into which to copy the data. + The index with the buffer to which the data will be copied. + The maximum number of characters to read. + The actual number of characters read. + + + + Retrieves data as a . + + The zero-based column ordinal. + The returned object. + + + + Retrieves data as a . + + The zero-based column ordinal. + The token to monitor for cancellation requests. The default value is . + The returned object. + + + + Asynchronously gets the value of the specified column as a type. + + The type of the value to be returned. + The type of the value to be returned. + The token to monitor for cancellation requests. + + + + + Synchronously gets the value of the specified column as a type. + + Synchronously gets the value of the specified column as a type. + The column to be retrieved. + The column to be retrieved. + + + + Gets the value of the specified column as an instance of . + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as an instance of . + + The zero-based column ordinal. + The value of the specified column. + + + + Gets the value of the specified column as an instance of . + + The name of the column. + The value of the specified column. + + + + Gets a value that indicates whether the column contains nonexistent or missing values. + + The zero-based column ordinal. + true if the specified column is equivalent to ; otherwise false. + + + + An asynchronous version of , which gets a value that indicates whether the column contains non-existent or missing values. + The parameter is currently ignored. + + The zero-based column to be retrieved. + The token to monitor for cancellation requests. + true if the specified column value is equivalent to otherwise false. + + + + Gets the column ordinal given the name of the column. + + The name of the column. + The zero-based column ordinal. + + + + Gets a representation of the PostgreSQL data type for the specified field. + The returned representation can be used to access various information about the field. + + The zero-based column index. + + + + Gets the data type information for the specified field. + This will be the PostgreSQL type name (e.g. double precision), not the .NET type + (see for that). + + The zero-based column index. + + + + Gets the OID for the PostgreSQL type for the specified field, as it appears in the pg_type table. + + + This is a PostgreSQL-internal value that should not be relied upon and should only be used for + debugging purposes. + + The zero-based column index. + + + + Gets the data type of the specified column. + + The zero-based column ordinal. + The data type of the specified column. + + + + Returns the provider-specific field type of the specified column. + + The zero-based column ordinal. + The Type object that describes the data type of the specified column. + + + + Gets all provider-specific attribute columns in the collection for the current row. + + An array of Object into which to copy the attribute columns. + The number of instances of in the array. + + + + Returns an that can be used to iterate through the rows in the data reader. + + An that can be used to iterate through the rows in the data reader. + + + + Returns schema information for the columns in the current resultset. + + + + + + Asynchronously returns schema information for the columns in the current resultset. + + + + + + Returns a System.Data.DataTable that describes the column metadata of the DataReader. + + + + + Asynchronously returns a System.Data.DataTable that describes the column metadata of the DataReader. + + + + + Seeks to the given column. The 4-byte length is read and stored in . + + + + + Checks that we have a RowDescription, but not necessary an actual resultset + (for operations which work in SchemaOnly mode. + + + + + Unbinds reader from the connector. + Should be called before the connector is returned to the pool. + + + + + The exception that is thrown when server-related issues occur. + + + PostgreSQL errors (e.g. query SQL issues, constraint violations) are raised via + which is a subclass of this class. + Purely Npgsql-related issues which aren't related to the server will be raised + via the standard CLR exceptions (e.g. ArgumentException). + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + + + + Initializes a new instance of the class with a specified error message. + + The message that describes the error. + + + + Specifies whether the exception is considered transient, that is, whether retrying the operation could + succeed (e.g. a network error or a timeout). + + + + + Initializes a new instance of the class with serialized data. + + The SerializationInfo that holds the serialized object data about the exception being thrown. + The StreamingContext that contains contextual information about the source or destination. + + + + A factory to create instances of various Npgsql objects. + + + + + Gets an instance of the . + This can be used to retrieve strongly typed data objects. + + + + + Returns a strongly typed instance. + + + + + Returns a strongly typed instance. + + + + + Returns a strongly typed instance. + + + + + Returns a strongly typed instance. + + + + + Returns a strongly typed instance. + + + + + Returns a strongly typed instance. + + + + + Gets the service object of the specified type. + + An object that specifies the type of service object to get. + A service object of type serviceType, or null if there is no service object of type serviceType. + + + + Large object manager. This class can be used to store very large files in a PostgreSQL database. + + + + + The largest chunk size (in bytes) read and write operations will read/write each roundtrip to the network. Default 4 MB. + + + + + Creates an NpgsqlLargeObjectManager for this connection. The connection must be opened to perform remote operations. + + + + + + Execute a function + + + + + Execute a function that returns a byte array + + + + + + Create an empty large object in the database. If an oid is specified but is already in use, an PostgresException will be thrown. + + A preferred oid, or specify 0 if one should be automatically assigned + The oid for the large object created + If an oid is already in use + + + + Create an empty large object in the database. If an oid is specified but is already in use, an PostgresException will be thrown. + + A preferred oid, or specify 0 if one should be automatically assigned + The token to monitor for cancellation requests. The default value is . + The oid for the large object created + If an oid is already in use + + + + Opens a large object on the backend, returning a stream controlling this remote object. + A transaction snapshot is taken by the backend when the object is opened with only read permissions. + When reading from this object, the contents reflects the time when the snapshot was taken. + Note that this method, as well as operations on the stream must be wrapped inside a transaction. + + Oid of the object + An NpgsqlLargeObjectStream + + + + Opens a large object on the backend, returning a stream controlling this remote object. + A transaction snapshot is taken by the backend when the object is opened with only read permissions. + When reading from this object, the contents reflects the time when the snapshot was taken. + Note that this method, as well as operations on the stream must be wrapped inside a transaction. + + Oid of the object + The token to monitor for cancellation requests. The default value is . + An NpgsqlLargeObjectStream + + + + Opens a large object on the backend, returning a stream controlling this remote object. + Note that this method, as well as operations on the stream must be wrapped inside a transaction. + + Oid of the object + An NpgsqlLargeObjectStream + + + + Opens a large object on the backend, returning a stream controlling this remote object. + Note that this method, as well as operations on the stream must be wrapped inside a transaction. + + Oid of the object + The token to monitor for cancellation requests. The default value is . + An NpgsqlLargeObjectStream + + + + Deletes a large object on the backend. + + Oid of the object to delete + + + + Deletes a large object on the backend. + + Oid of the object to delete + The token to monitor for cancellation requests. The default value is . + + + + Exports a large object stored in the database to a file on the backend. This requires superuser permissions. + + Oid of the object to export + Path to write the file on the backend + + + + Exports a large object stored in the database to a file on the backend. This requires superuser permissions. + + Oid of the object to export + Path to write the file on the backend + The token to monitor for cancellation requests. The default value is . + + + + Imports a large object to be stored as a large object in the database from a file stored on the backend. This requires superuser permissions. + + Path to read the file on the backend + A preferred oid, or specify 0 if one should be automatically assigned + + + + Imports a large object to be stored as a large object in the database from a file stored on the backend. This requires superuser permissions. + + Path to read the file on the backend + A preferred oid, or specify 0 if one should be automatically assigned + The token to monitor for cancellation requests. The default value is . + + + + Since PostgreSQL 9.3, large objects larger than 2GB can be handled, up to 4TB. + This property returns true whether the PostgreSQL version is >= 9.3. + + + + + An interface to remotely control the seekable stream for an opened large object on a PostgreSQL server. + Note that the OpenRead/OpenReadWrite method as well as all operations performed on this stream must be wrapped inside a database transaction. + + + + + Since PostgreSQL 9.3, large objects larger than 2GB can be handled, up to 4TB. + This property returns true whether the PostgreSQL version is >= 9.3. + + + + + Reads count bytes from the large object. The only case when fewer bytes are read is when end of stream is reached. + + The buffer where read data should be stored. + The offset in the buffer where the first byte should be read. + The maximum number of bytes that should be read. + How many bytes actually read, or 0 if end of file was already reached. + + + + Reads count bytes from the large object. The only case when fewer bytes are read is when end of stream is reached. + + The buffer where read data should be stored. + The offset in the buffer where the first byte should be read. + The maximum number of bytes that should be read. + The token to monitor for cancellation requests. The default value is . + How many bytes actually read, or 0 if end of file was already reached. + + + + Writes count bytes to the large object. + + The buffer to write data from. + The offset in the buffer at which to begin copying bytes. + The number of bytes to write. + + + + Writes count bytes to the large object. + + The buffer to write data from. + The offset in the buffer at which to begin copying bytes. + The number of bytes to write. + The token to monitor for cancellation requests. The default value is . + + + + CanTimeout always returns false. + + + + + CanRead always returns true, unless the stream has been closed. + + + + + CanWrite returns true if the stream was opened with write permissions, and the stream has not been closed. + + + + + CanSeek always returns true, unless the stream has been closed. + + + + + Returns the current position in the stream. Getting the current position does not need a round-trip to the server, however setting the current position does. + + + + + Gets the length of the large object. This internally seeks to the end of the stream to retrieve the length, and then back again. + + + + + Gets the length of the large object. This internally seeks to the end of the stream to retrieve the length, and then back again. + + The token to monitor for cancellation requests. The default value is . + + + + Seeks in the stream to the specified position. This requires a round-trip to the backend. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference point used to obtain the new position. + + + + + Seeks in the stream to the specified position. This requires a round-trip to the backend. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference point used to obtain the new position. + The token to monitor for cancellation requests. The default value is . + + + + Does nothing. + + + + + Truncates or enlarges the large object to the given size. If enlarging, the large object is extended with null bytes. + For PostgreSQL versions earlier than 9.3, the value must fit in an Int32. + + Number of bytes to either truncate or enlarge the large object. + + + + Truncates or enlarges the large object to the given size. If enlarging, the large object is extended with null bytes. + For PostgreSQL versions earlier than 9.3, the value must fit in an Int32. + + Number of bytes to either truncate or enlarge the large object. + Cancellation token. + + + + Releases resources at the backend allocated for this stream. + + + + + Releases resources at the backend allocated for this stream, iff disposing is true. + + Whether to release resources allocated at the backend. + + + + An array of cached lengths for the parameters sending process. + + When sending parameters, lengths need to be calculated more than once (once for Bind, once for + an array, once for the string within that array). This cache optimized that. Lengths are added + to the cache, and then retrieved at the same order. + + + + + Stores a length value in the cache, to be fetched later via . + Called at the phase. + + The length parameter. + + + + Retrieves a length value previously stored in the cache via . + Called at the writing phase, after validation has already occurred and the length cache is populated. + + + + + + Provides information on a PostgreSQL notification. Notifications are sent when your connection has registered for + notifications on a specific channel via the LISTEN command. NOTIFY can be used to generate such notifications, + allowing for an inter-connection communication channel. + + + + + Process ID of the PostgreSQL backend that sent this notification. + + + + + The channel on which the notification was sent. + + + + + An optional payload string that was sent with this notification. + + + + + The channel on which the notification was sent. + + + + + An optional payload string that was sent with this notification. + + + + + Thrown when trying to use a connection that is already busy performing some other operation. + Provides information on the already-executing operation to help with debugging. + + + + + Creates a new instance of . + + + A command which was in progress when the operation which triggered this exception was executed. + + + + + If the connection is busy with another command, this will contain a reference to that command. + Otherwise, if the connection if busy with another type of operation (e.g. COPY), contains + . + + + + + This class represents a parameter to a command that will be sent to server + + + + + Can be used to communicate a value from the validation phase to the writing phase. + To be used by type handlers only. + + + + + Initializes a new instance of the NpgsqlParameter class. + + + + + Initializes a new instance of the NpgsqlParameter + class with the parameter name and a value of the new NpgsqlParameter. + + The name of the parameter to map. + An Object that is the value of the NpgsqlParameter. + +

When you specify an Object + in the value parameter, the DbType is + inferred from the .NET Framework type of the Object.

+

When using this constructor, you must be aware of a possible misuse of the constructor which takes a DbType parameter. + This happens when calling this constructor passing an int 0 and the compiler thinks you are passing a value of DbType. + Use Convert.ToInt32(value) for example to have compiler calling the correct constructor.

+
+
+ + + Initializes a new instance of the NpgsqlParameter + class with the parameter name and the data type. + + The name of the parameter to map. + One of the NpgsqlDbType values. + + + + Initializes a new instance of the NpgsqlParameter. + + The name of the parameter to map. + One of the DbType values. + + + + Initializes a new instance of the NpgsqlParameter. + + The name of the parameter to map. + One of the NpgsqlDbType values. + The length of the parameter. + + + + Initializes a new instance of the NpgsqlParameter. + + The name of the parameter to map. + One of the DbType values. + The length of the parameter. + + + + Initializes a new instance of the NpgsqlParameter + + The name of the parameter to map. + One of the NpgsqlDbType values. + The length of the parameter. + The name of the source column. + + + + Initializes a new instance of the NpgsqlParameter. + + The name of the parameter to map. + One of the DbType values. + The length of the parameter. + The name of the source column. + + + + Initializes a new instance of the NpgsqlParameter. + + The name of the parameter to map. + One of the NpgsqlDbType values. + The length of the parameter. + The name of the source column. + One of the ParameterDirection values. + true if the value of the field can be null, otherwise false. + The total number of digits to the left and right of the decimal point to which + Value is resolved. + The total number of decimal places to which + Value is resolved. + One of the DataRowVersion values. + An Object that is the value + of the NpgsqlParameter. + + + + Initializes a new instance of the NpgsqlParameter. + + The name of the parameter to map. + One of the DbType values. + The length of the parameter. + The name of the source column. + One of the ParameterDirection values. + true if the value of the field can be null, otherwise false. + The total number of digits to the left and right of the decimal point to which + Value is resolved. + The total number of decimal places to which + Value is resolved. + One of the DataRowVersion values. + An Object that is the value + of the NpgsqlParameter. + + + + Gets or sets The name of the NpgsqlParameter. + + The name of the NpgsqlParameter. + The default is an empty string. + + + + + + + Gets or sets the value of the parameter. + + + An that is the value of the parameter. + The default value is . + + + + + Gets or sets the DbType of the parameter. + + One of the DbType values. The default is Object. + + + + Gets or sets the NpgsqlDbType of the parameter. + + One of the NpgsqlDbType values. The default is Unknown. + + + + Used to specify which PostgreSQL type will be sent to the database for this parameter. + + + + + + + + + + + Gets or sets the maximum number of digits used to represent the + Value property. + + The maximum number of digits used to represent the + Value property. + The default value is 0, which indicates that the data provider + sets the precision for Value. + + + + Gets or sets the number of decimal places to which + Value is resolved. + + The number of decimal places to which + Value is resolved. The default is 0. + + + + + + + + + + + + + + + + The collection to which this parameter belongs, if any. + + + + + The PostgreSQL data type, such as int4 or text, as discovered from pg_type. + This property is automatically set if parameters have been derived via + and can be used to + acquire additional information about the parameters' data type. + + + + + + + + Creates a new NpgsqlParameter that + is a copy of the current instance. + + A new NpgsqlParameter that is a copy of this instance. + + + + Represents a collection of parameters relevant to a NpgsqlCommand + as well as their respective mappings to columns in a DataSet. + This class cannot be inherited. + + + + + Initializes a new instance of the NpgsqlParameterCollection class. + + + + + Invalidate the hash lookup tables. This should be done any time a change + may throw the lookups out of sync with the list. + + + + + Gets the NpgsqlParameter with the specified name. + + The name of the NpgsqlParameter to retrieve. + The NpgsqlParameter with the specified name, or a null reference if the parameter is not found. + + + + Gets the NpgsqlParameter at the specified index. + + The zero-based index of the NpgsqlParameter to retrieve. + The NpgsqlParameter at the specified index. + + + + Adds the specified NpgsqlParameter object to the NpgsqlParameterCollection. + + The NpgsqlParameter to add to the collection. + The index of the new NpgsqlParameter object. + + + + + + + Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified parameter name and value. + + The name of the NpgsqlParameter. + The Value of the NpgsqlParameter to add to the collection. + The parameter that was added. + + + + Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified parameter name, data type and value. + + The name of the NpgsqlParameter. + One of the NpgsqlDbType values. + The Value of the NpgsqlParameter to add to the collection. + The parameter that was added. + + + + Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified parameter name and value. + + The name of the NpgsqlParameter. + The Value of the NpgsqlParameter to add to the collection. + One of the NpgsqlDbType values. + The length of the column. + The parameter that was added. + + + + Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified parameter name and value. + + The name of the NpgsqlParameter. + The Value of the NpgsqlParameter to add to the collection. + One of the NpgsqlDbType values. + The length of the column. + The name of the source column. + The parameter that was added. + + + + Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified value. + + The Value of the NpgsqlParameter to add to the collection. + The parameter that was added. + + + + Adds a NpgsqlParameter to the NpgsqlParameterCollection given the specified data type and value. + + One of the NpgsqlDbType values. + The Value of the NpgsqlParameter to add to the collection. + The parameter that was added. + + + + Adds a NpgsqlParameter to the NpgsqlParameterCollection given the parameter name and the data type. + + The name of the parameter. + One of the DbType values. + The index of the new NpgsqlParameter object. + + + + Adds a NpgsqlParameter to the NpgsqlParameterCollection with the parameter name, the data type, and the column length. + + The name of the parameter. + One of the DbType values. + The length of the column. + The index of the new NpgsqlParameter object. + + + + Adds a NpgsqlParameter to the NpgsqlParameterCollection with the parameter name, the data type, the column length, and the source column name. + + The name of the parameter. + One of the DbType values. + The length of the column. + The name of the source column. + The index of the new NpgsqlParameter object. + + + + + + + + + + + + + + + + Removes the specified NpgsqlParameter from the collection using a specific index. + + The zero-based index of the parameter. + + + + + + + Removes the specified NpgsqlParameter from the collection. + + The name of the NpgsqlParameter to remove from the collection. + + + + Removes the specified NpgsqlParameter from the collection. + + The NpgsqlParameter to remove from the collection. + + + + + + + Gets a value indicating whether a NpgsqlParameter with the specified parameter name exists in the collection. + + The name of the NpgsqlParameter object to find. + A reference to the requested parameter is returned in this out param if it is found in the list. This value is null if the parameter is not found. + true if the collection contains the parameter and param will contain the parameter; otherwise, false. + + + + Removes all items from the collection. + + + + + + + + + + + + + + + + + Gets the number of NpgsqlParameter objects in the collection. + + The number of NpgsqlParameter objects in the collection. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Report the offset within the collection of the given parameter. + + Parameter to find. + Index of the parameter, or -1 if the parameter is not present. + + + + Insert the specified parameter into the collection. + + Index of the existing parameter before which to insert the new one. + Parameter to insert. + + + + Report whether the specified parameter is present in the collection. + + Parameter to find. + True if the parameter was found, otherwise false. + + + + Remove the specified parameter from the collection. + + Parameter to remove. + True if the parameter was found and removed, otherwise false. + + + + Convert collection to a System.Array. + + Destination array. + Starting index in destination array. + + + + Convert collection to a System.Array. + + NpgsqlParameter[] + + + + A generic version of which provides more type safety and + avoids boxing of value types. Use instead of . + + The type of the value that will be stored in the parameter. + + + + Gets or sets the strongly-typed value of the parameter. + + + + + Gets or sets the value of the parameter. This delegates to . + + + + + Initializes a new instance of . + + + + + Initializes a new instance of with a parameter name and value. + + + + + Initializes a new instance of with a parameter name and type. + + + + + Initializes a new instance of with a parameter name and type. + + + + + Provides an API for a raw binary COPY operation, a high-performance data import/export mechanism to + a PostgreSQL table. Initiated by + + + See https://www.postgresql.org/docs/current/static/sql-copy.html. + + + + + The copy binary format header signature + + + + + Cancels and terminates an ongoing operation. Any data already written will be discarded. + + + + + Cancels and terminates an ongoing operation. Any data already written will be discarded. + + + + + Writer for a text import, initiated by . + + + See https://www.postgresql.org/docs/current/static/sql-copy.html. + + + + + Cancels and terminates an ongoing import. Any data already written will be discarded. + + + + + Cancels and terminates an ongoing import. Any data already written will be discarded. + + + + + Reader for a text export, initiated by . + + + See https://www.postgresql.org/docs/current/static/sql-copy.html. + + + + + Cancels and terminates an ongoing import. + + + + + Cancels and terminates an ongoing import. Any data already written will be discarded. + + + + + A buffer used by Npgsql to read data from the socket efficiently. + Provides methods which decode different values types and tracks the current position. + + + + + Timeout for sync and async reads + + + + + The total byte length of the buffer. + + + + + Same as , except that it does not throw an exception if an invalid char is + encountered (exception fallback), but rather replaces it with a question mark character (replacement + fallback). + + + + + The minimum buffer size possible. + + + + + Ensures that bytes are available in the buffer, and if + not, reads from the socket until enough is available. + + + + + Does not perform any I/O - assuming that the bytes to be skipped are in the memory buffer. + + + + + + Skip a given number of bytes. + + + + + Seeks the first null terminator (\0) and returns the string up to it. The buffer must already + contain the entire string and its terminator. + + + + + Seeks the first null terminator (\0) and returns the string up to it. The buffer must already + contain the entire string and its terminator. If any character could not be decoded, a question + mark character is returned instead of throwing an exception. + + + + + Seeks the first null terminator (\0) and returns the string up to it. Reads additional data from the network if a null + terminator isn't found in the buffered data. + + + + + Provides the underlying mechanism for reading schema information. + + + + + Returns the MetaDataCollections that lists all possible collections. + + The MetaDataCollections + + + + Returns the Restrictions that contains the meaning and position of the values in the restrictions array. + + The Restrictions + + + + Populates some generic type information that is common for base types, arrays, enums, etc. Some will + be overridden later. + + + + + Sets some custom, hardcoded info on a DataType row that cannot be loaded/inferred from PostgreSQL + + + + + List of keywords taken from PostgreSQL 9.0 reserved words documentation. + + + + + Represents a single SQL statement within Npgsql. + + Instances aren't constructed directly; users should construct an + object and populate its property as in standard ADO.NET. + Npgsql will analyze that property and constructed instances of + internally. + + Users can retrieve instances from + and access information about statement execution (e.g. affected rows). + + + + + The SQL text of the statement. + + + + + Specifies the type of query, e.g. SELECT. + + + + + The number of rows affected or retrieved. + + + See the command tag in the CommandComplete message, + https://www.postgresql.org/docs/current/static/protocol-message-formats.html + + + + + The number of rows affected or retrieved. + + + See the command tag in the CommandComplete message, + https://www.postgresql.org/docs/current/static/protocol-message-formats.html + + + + + For an INSERT, the object ID of the inserted row if is 1 and + the target table has OIDs; otherwise 0. + + + + + The input parameters sent with this statement. + + + + + The RowDescription message for this query. If null, the query does not return rows (e.g. INSERT) + + + + + If this statement has been automatically prepared, references the . + Null otherwise. + + + + + Holds the server-side (prepared) statement name. Empty string for non-prepared statements. + + + + + Whether this statement has already been prepared (including automatic preparation). + + + + + Returns the SQL text of the statement. + + + + + Represents a transaction to be made in a PostgreSQL database. This class cannot be inherited. + + + + + Specifies the object associated with the transaction. + + The object associated with the transaction. + + + + Specifies the object associated with the transaction. + + The object associated with the transaction. + + + + If true, the transaction has been committed/rolled back, but not disposed. + + + + + Specifies the IsolationLevel for this transaction. + + The IsolationLevel for this transaction. + The default is ReadCommitted. + + + + Commits the database transaction. + + + + + Commits the database transaction. + + The token to monitor for cancellation requests. The default value is . + + + + Rolls back a transaction from a pending state. + + + + + Rolls back a transaction from a pending state. + + The token to monitor for cancellation requests. The default value is . + + + + Creates a transaction save point. + + The name of the savepoint. + + This method does not cause a database roundtrip to be made. The savepoint creation statement will instead be sent along with + the next command. + + + + + Creates a transaction save point. + + The name of the savepoint. + The token to monitor for cancellation requests. The default value is . + + This method does not cause a database roundtrip to be made, and will therefore always complete synchronously. + The savepoint creation statement will instead be sent along with the next command. + + + + + Rolls back a transaction from a pending savepoint state. + + The name of the savepoint. + + + + Rolls back a transaction from a pending savepoint state. + + The name of the savepoint. + The token to monitor for cancellation requests. The default value is . + + + + Releases a transaction from a pending savepoint state. + + The name of the savepoint. + + + + Releases a transaction from a pending savepoint state. + + The name of the savepoint. + The token to monitor for cancellation requests. The default value is . + + + + Disposes the transaction, rolling it back if it is still pending. + + + + + Disposes the transaction, rolling it back if it is still pending. + + + + + Disposes the transaction, without rolling back. Used only in special circumstances, e.g. when + the connection is broken. + + + + + Unbinds transaction from the connector. + Should be called before the connector is returned to the pool. + + + + + A buffer used by Npgsql to write data to the socket efficiently. + Provides methods which encode different values types and tracks the current position. + + + + + Timeout for sync and async writes + + + + + The total byte length of the buffer. + + + + + The minimum buffer size possible. + + + + + Returns all contents currently written to the buffer (but not flushed). + Useful for pre-generating messages. + + + + + Represents a .pgpass file, which contains passwords for noninteractive connections + + + + + File name being parsed for credentials + + + + + Initializes a new instance of the class + + + + + + Parses file content and gets all credentials from the file + + corresponding to all lines in the .pgpass file + + + + Searches queries loaded from .PGPASS file to find first entry matching the provided parameters. + + Hostname to query. Use null to match any. + Port to query. Use null to match any. + Database to query. Use null to match any. + User name to query. Use null to match any. + Matching if match was found. Otherwise, returns null. + + + + Represents a hostname, port, database, username, and password combination that has been retrieved from a .pgpass file + + + + + Hostname parsed from the .pgpass file + + + + + Port parsed from the .pgpass file + + + + + Database parsed from the .pgpass file + + + + + User name parsed from the .pgpass file + + + + + Password parsed from the .pgpass file + + + + + This class represents an entry from the .pgpass file + + Hostname parsed from the .pgpass file + Port parsed from the .pgpass file + Database parsed from the .pgpass file + User name parsed from the .pgpass file + Password parsed from the .pgpass file + + + + Creates new based on string in the format hostname:port:database:username:password. The : and \ characters should be escaped with a \. + + string for the entry from the pgpass file + New instance of for the string + Entry is not formatted as hostname:port:database:username:password or non-wildcard port is not a number + + + + Checks whether this matches the parameters supplied + + Hostname to check against this entry + Port to check against this entry + Database to check against this entry + Username to check against this entry + True if the entry is a match. False otherwise. + + + + Checks if 2 strings are a match for a considering that either value can be a wildcard (*) + + Value being searched + Value from the PGPASS entry + True if the values are a match. False otherwise. + + + + Provides lookup for a pool based on a connection string. + + + is lock-free, to avoid contention, but the same isn't + true of , which acquires a lock. The calling code always tries + before trying to . + + + + + Resets the pool manager to its initial state, for test purposes only. + Assumes that no other threads are accessing the pool. + + + + + The default implementation of , for standard PostgreSQL databases.. + + + + + + + + The default implementation of NpgsqlDatabase, for standard PostgreSQL databases. + + + + + The Npgsql logger instance. + + + + + The PostgreSQL types detected in the database. + + + + + + + + The PostgreSQL version string as returned by the version() function. Populated during loading. + + + + + True if the backend is Amazon Redshift; otherwise, false. + + + + + + + + True if the 'pg_enum' table includes the 'enumsortorder' column; otherwise, false. + + + + + True if the 'pg_type' table includes the 'typcategory' column; otherwise, false. + + + pg_type.typcategory is added after 8.4. + see: https://www.postgresql.org/docs/8.4/static/catalog-pg-type.html#CATALOG-TYPCATEGORY-TABLE + + + + + Loads database information from the PostgreSQL database specified by . + + The database connection. + The timeout while loading types from the backend. + True to load types asynchronously. + + A task representing the asynchronous operation. + + + + + Generates a raw SQL query string to select type information. + + True to load range types. + True to load enum types. + + True to load table composites. + + A raw SQL query string that selects type information. + + + Select all types (base, array which is also base, enum, range, composite). + Note that arrays are distinguished from primitive types through them having typreceive=array_recv. + Order by primitives first, container later. + For arrays and ranges, join in the element OID and type (to filter out arrays of unhandled + types). + + + + + Loads type information from the backend specified by . + + The database connection. + The timeout while loading types from the backend. + True to load types asynchronously. + + A collection of types loaded from the backend. + + + Unknown typtype for type '{internalName}' in pg_type: {typeChar}. + + + + Loads composite fields for the composite type specified by the OID. + + The reader from which to read composite fields. + The OID of the composite type for which fields are read. + + + + Loads enum labels for the enum type specified by the OID. + + The reader from which to read enum labels. + The OID of the enum type for which labels are read. + + + + Provides constants for PostgreSQL error codes. + + + See https://www.postgresql.org/docs/current/static/errcodes-appendix.html + + + + + The exception that is thrown when the PostgreSQL backend reports errors (e.g. query + SQL issues, constraint violations). + + + This exception only corresponds to a PostgreSQL-delivered error. + Other errors (e.g. network issues) will be raised via , + and purely Npgsql-related issues which aren't related to the server will be raised + via the standard CLR exceptions (e.g. ). + + See https://www.postgresql.org/docs/current/static/errcodes-appendix.html, + https://www.postgresql.org/docs/current/static/protocol-error-fields.html + + + + + Creates a new instance. + + + + + Creates a new instance. + + + + + Populates a with the data needed to serialize the target object. + + The to populate with data. + The destination (see ) for this serialization. + + + + + + + Specifies whether the exception is considered transient, that is, whether retrying the operation could + succeed (e.g. a network error). Check . + + + + + Returns the statement which triggered this exception. + + + + + Severity of the error or notice. + Always present. + + + + + Severity of the error or notice, not localized. + Always present since PostgreSQL 9.6. + + + + + The SQLSTATE code for the error. + + + Always present. + Constants are defined in . + See https://www.postgresql.org/docs/current/static/errcodes-appendix.html + + + + + The SQLSTATE code for the error. + + + Always present. + Constants are defined in . + See https://www.postgresql.org/docs/current/static/errcodes-appendix.html + + + + + The primary human-readable error message. This should be accurate but terse. + + + Always present. + + + + + An optional secondary error message carrying more detail about the problem. + May run to multiple lines. + + + + + An optional suggestion what to do about the problem. + This is intended to differ from Detail in that it offers advice (potentially inappropriate) rather than hard facts. + May run to multiple lines. + + + + + The field value is a decimal ASCII integer, indicating an error cursor position as an index into the original query string. + The first character has index 1, and positions are measured in characters not bytes. + 0 means not provided. + + + + + This is defined the same as the field, but it is used when the cursor position refers to an internally generated command rather than the one submitted by the client. + The field will always appear when this field appears. + 0 means not provided. + + + + + The text of a failed internally-generated command. + This could be, for example, a SQL query issued by a PL/pgSQL function. + + + + + An indication of the context in which the error occurred. + Presently this includes a call stack traceback of active PL functions. + The trace is one entry per line, most recent first. + + + + + If the error was associated with a specific database object, the name of the schema containing that object, if any. + + PostgreSQL 9.3 and up. + + + + Table name: if the error was associated with a specific table, the name of the table. + (Refer to the schema name field for the name of the table's schema.) + + PostgreSQL 9.3 and up. + + + + If the error was associated with a specific table column, the name of the column. + (Refer to the schema and table name fields to identify the table.) + + PostgreSQL 9.3 and up. + + + + If the error was associated with a specific data type, the name of the data type. + (Refer to the schema name field for the name of the data type's schema.) + + PostgreSQL 9.3 and up. + + + + If the error was associated with a specific constraint, the name of the constraint. + Refer to fields listed above for the associated table or domain. + (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.) + + PostgreSQL 9.3 and up. + + + + The file name of the source-code location where the error was reported. + + PostgreSQL 9.3 and up. + + + + The line number of the source-code location where the error was reported. + + + + + The name of the source-code routine reporting the error. + + + + + PostgreSQL notices are non-critical messages generated by PostgreSQL, either as a result of a user query + (e.g. as a warning or informational notice), or due to outside activity (e.g. if the database administrator + initiates a "fast" database shutdown). + + + https://www.postgresql.org/docs/current/static/protocol-flow.html#PROTOCOL-ASYNC + + + + + Severity of the error or notice. + Always present. + + + + + Severity of the error or notice, not localized. + Always present since PostgreSQL 9.6. + + + + + The SQLSTATE code for the error. + + + Always present. + See https://www.postgresql.org/docs/current/static/errcodes-appendix.html + + + + + The SQLSTATE code for the error. + + + Always present. + See https://www.postgresql.org/docs/current/static/errcodes-appendix.html + + + + + The primary human-readable error message. This should be accurate but terse. + + + Always present. + + + + + An optional secondary error message carrying more detail about the problem. + May run to multiple lines. + + + + + An optional suggestion what to do about the problem. + This is intended to differ from Detail in that it offers advice (potentially inappropriate) rather than hard facts. + May run to multiple lines. + + + + + The field value is a decimal ASCII integer, indicating an error cursor position as an index into the original query string. + The first character has index 1, and positions are measured in characters not bytes. + 0 means not provided. + + + + + This is defined the same as the field, but it is used when the cursor position refers to an internally generated command rather than the one submitted by the client. + The field will always appear when this field appears. + 0 means not provided. + + + + + The text of a failed internally-generated command. + This could be, for example, a SQL query issued by a PL/pgSQL function. + + + + + An indication of the context in which the error occurred. + Presently this includes a call stack traceback of active PL functions. + The trace is one entry per line, most recent first. + + + + + If the error was associated with a specific database object, the name of the schema containing that object, if any. + + PostgreSQL 9.3 and up. + + + + Table name: if the error was associated with a specific table, the name of the table. + (Refer to the schema name field for the name of the table's schema.) + + PostgreSQL 9.3 and up. + + + + If the error was associated with a specific table column, the name of the column. + (Refer to the schema and table name fields to identify the table.) + + PostgreSQL 9.3 and up. + + + + If the error was associated with a specific data type, the name of the data type. + (Refer to the schema name field for the name of the data type's schema.) + + PostgreSQL 9.3 and up. + + + + If the error was associated with a specific constraint, the name of the constraint. + Refer to fields listed above for the associated table or domain. + (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.) + + PostgreSQL 9.3 and up. + + + + The file name of the source-code location where the error was reported. + + PostgreSQL 9.3 and up. + + + + The line number of the source-code location where the error was reported. + + + + + The name of the source-code routine reporting the error. + + + + + Creates a new instance. + + + + + Creates a new instance. + + + + + Provides data for a PostgreSQL notice event. + + + + + The Notice that was sent from the database. + + + + + Holds well-known, built-in PostgreSQL type OIDs. + + + + + Represents a PostgreSQL array data type, which can hold several multiple values in a single column. + + + See https://www.postgresql.org/docs/current/static/arrays.html. + + + + + The PostgreSQL data type of the element contained within this array. + + + + + Constructs a representation of a PostgreSQL array data type. + + + + + + + + Represents a PostgreSQL base data type, which is a simple scalar value. + + + + + + + + + + + Represents a PostgreSQL composite data type, which can hold multiple fields of varying types in a single column. + + + See https://www.postgresql.org/docs/current/static/rowtypes.html. + + + + + Holds the name and types for all fields. + + + + + Constructs a representation of a PostgreSQL array data type. + + + + + Represents a field in a PostgreSQL composite data type. + + + + + The name of the composite field. + + + + + The type of the composite field. + + + + + + + + Represents a PostgreSQL domain type. + + + See https://www.postgresql.org/docs/current/static/sql-createdomain.html. + + When PostgreSQL returns a RowDescription for a domain type, the type OID is the base type's + (so fetching a domain type over text returns a RowDescription for text). + However, when a composite type is returned, the type OID there is that of the domain, + so we provide "clean" support for domain types. + + + + + The PostgreSQL data type of the base type, i.e. the type this domain is based on. + + + + + True if the domain has a NOT NULL constraint, otherwise false. + + + + + Constructs a representation of a PostgreSQL domain data type. + + + + + Represents a PostgreSQL enum data type. + + + See https://www.postgresql.org/docs/current/static/datatype-enum.html. + + + + + The enum's fields. + + + + + Constructs a representation of a PostgreSQL enum data type. + + + + + Represents a PostgreSQL range data type. + + + See https://www.postgresql.org/docs/current/static/rangetypes.html. + + + + + The PostgreSQL data type of the subtype of this range. + + + + + Constructs a representation of a PostgreSQL range data type. + + + + + Represents a PostgreSQL data type, such as int4 or text, as discovered from pg_type. + This class is abstract, see derived classes for concrete types of PostgreSQL types. + + + Instances of this class are shared between connections to the same databases. + For more info about what this class and its subclasses represent, see + https://www.postgresql.org/docs/current/static/catalog-pg-type.html. + + + + + Constructs a representation of a PostgreSQL data type. + + The data type's namespace (or schema). + The data type's name. + The data type's OID. + + + + Constructs a representation of a PostgreSQL data type. + + The data type's namespace (or schema). + The data type's name. + The data type's internal name (e.g. _int4 for integer[]). + The data type's OID. + + + + The data type's OID - a unique id identifying the data type in a given database (in pg_type). + + + + + The data type's namespace (or schema). + + + + + The data type's name. + + + Note that this is the standard, user-displayable type name (e.g. integer[]) rather than the internal + PostgreSQL name as it is in pg_type (_int4). See for the latter. + + + + + The full name of the backend type, including its namespace. + + + + + A display name for this backend type, including the namespace unless it is pg_catalog (the namespace + for all built-in types). + + + + + The data type's internal PostgreSQL name (e.g. integer[] not _int4). + See for a more user-friendly name. + + + + + If a PostgreSQL array type exists for this type, it will be referenced here. + Otherwise null. + + + + + If a PostgreSQL range type exists for this type, it will be referenced here. + Otherwise null. + + + + + Generates the type name including any facts (size, precision, scale), given the PostgreSQL type modifier. + + + + + Returns a string that represents the current object. + + + + + Represents a PostgreSQL data type that isn't known to Npgsql and cannot be handled. + + + + + Constructs a the unknown backend type. + + + + + Internally represents a statement has been prepared, is in the process of being prepared, or is a + candidate for preparation (i.e. awaiting further usages). + + + + + If true, the user explicitly requested this statement be prepared. It does not get closed as part of + the automatic preparation LRU mechanism. + + + + + If this statement is about to be prepared, but replaces a previous statement which needs to be closed, + this holds the name of the previous statement. Otherwise null. + + + + + Contains the handler types for a prepared statement's parameters, for overloaded cases (same SQL, different param types) + Only populated after the statement has been prepared (i.e. null for candidates). + + + + + The state of a . + + + + + The statement hasn't been prepared yet, nor is it in the process of being prepared. + This is the value for autoprepare candidates which haven't been prepared yet, and is also + a temporary state during preparation. + + + + + The statement is in the process of being prepared. + + + + + The statement has been fully prepared and can be executed. + + + + + The statement is in the process of being unprepared. This is a temporary state that only occurs during + unprepare. Specifically, it means that a Close message for the statement has already been written + to the write buffer. + + + + + The statement has been unprepared and is no longer usable. + + + + + Total number of current prepared statements (whether explicit or automatic). + + + + + This API is for internal use and for implementing logical replication plugins. + It is not meant to be consumed in common Npgsql usage scenarios. + + + + + This API is for internal use and for implementing logical replication plugins. + It is not meant to be consumed in common Npgsql usage scenarios. + + + Creates a new replication slot and returns information about the newly-created slot. + + The to use for creating the + replication slot + The name of the slot to create. Must be a valid replication slot name (see + + https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS-MANIPULATION). + + The name of the output plugin used for logical decoding (see + + https://www.postgresql.org/docs/current/logicaldecoding-output-plugin.html). + + if this replication slot shall be temporary one; otherwise + . Temporary slots are not saved to disk and are automatically dropped on error or + when the session has finished. + A to specify what to do with the + snapshot created during logical slot initialization. , which is + also the default, will export the snapshot for use in other sessions. This option can't be used inside a + transaction. will use the snapshot for the current transaction + executing the command. This option must be used in a transaction, and + must be the first command run in that transaction. Finally, will + just use the snapshot for logical decoding as normal but won't do anything else with it. + The token to monitor for cancellation requests. + The default value is . + A representing a class that + can be used to initialize instances of subclasses. + + + + Instructs the server to start streaming the WAL for logical replication, starting at WAL location + or at the slot's consistent point if isn't specified. + The server can reply with an error, for example if the requested section of the WAL has already been recycled. + + The to use for starting replication + The replication slot that will be updated as replication progresses so that the server + knows which WAL segments are still needed by the standby. + + The token to monitor for stopping the replication. + The WAL location to begin streaming at. + The collection of options passed to the slot's logical decoding plugin. + + Whether the plugin will be bypassing and reading directly from the buffer. + + A representing an that + can be used to stream WAL entries in form of instances. + + + + Contains information about a newly-created logical replication slot. + + + + + Creates a new logical replication slot + + The logical decoding output plugin to the corresponding replication slot was created for. + A struct with information to create the replication slot. + + + + The identifier of the snapshot exported by the command. + The snapshot is valid until a new command is executed on this connection or the replication connection is closed. + + + + + The name of the output plugin used by the newly-created logical replication slot. + + + + + The WAL location at which the slot became consistent. + This is the earliest location from which streaming can start on this replication slot. + + + + + Represents a logical replication connection to a PostgreSQL server. + + + + + Initializes a new instance of . + + + + + Initializes a new instance of with the given connection string. + + The connection used to open the PostgreSQL database. + + + + Decides what to do with the snapshot created during logical slot initialization. + + + + + Export the snapshot for use in other sessions. This is the default. + This option can't be used inside a transaction. + + + + + Use the snapshot for the current transaction executing the command. + This option must be used in a transaction, and CREATE_REPLICATION_SLOT must be the first command run + in that transaction. + + + + + Just use the snapshot for logical decoding as normal but don't do anything else with it. + + + + + Logical Replication Protocol begin message + + + + + The final LSN of the transaction. + + + + + Commit timestamp of the transaction. + The value is in number of microseconds since PostgreSQL epoch (2000-01-01). + + + + + Xid of the transaction. + + + + + + + + Logical Replication Protocol commit message + + + + + Flags; currently unused (must be 0). + + + + + The LSN of the commit. + + + + + The end LSN of the transaction. + + + + + Commit timestamp of the transaction. + + + + + + + + Abstract base class for Logical Replication Protocol delete message types. + + + + + ID of the relation corresponding to the ID in the relation message. + + + + + Logical Replication Protocol delete message for tables with REPLICA IDENTITY REPLICA IDENTITY set to FULL. + + + + + Columns representing the old values. + + + + + + + + Logical Replication Protocol update message for tables with REPLICA IDENTITY REPLICA IDENTITY set to FULL. + + + + + Columns representing the old values. + + + + + + + + Logical Replication Protocol update message for tables with REPLICA IDENTITY set to USING INDEX. + + + + + Columns representing the key. + + + + + + + + Logical Replication Protocol insert message + + + + + ID of the relation corresponding to the ID in the relation message. + + + + + Columns representing the new row. + + + + + + + + Logical Replication Protocol delete message for tables with REPLICA IDENTITY set to DEFAULT or USING INDEX. + + + + + Columns representing the primary key. + + + + + + + + Logical Replication Protocol origin message + + + + + The LSN of the commit on the origin server. + + + + + Name of the origin. + + + + + + + + The base class of all Logical Replication Protocol Messages + + + See https://www.postgresql.org/docs/current/protocol-logicalrep-message-formats.html for details about the + protocol. + + + + + + + + Returns a clone of this message, which can be accessed after other replication messages have been retrieved. + + + + + Logical Replication Protocol relation message + + + + + ID of the relation. + + + + + Namespace (empty string for pg_catalog). + + + + + Relation name. + + + + + Replica identity setting for the relation (same as relreplident in pg_class). + + + + + Relation columns + + + + + + + + Represents a column in a Logical Replication Protocol relation message + + + + + Flags for the column. Currently can be either 0 for no flags or 1 which marks the column as part of the key. + + + + + Name of the column. + + + + + ID of the column's data type. + + + + + Type modifier of the column (atttypmod). + + + + + Represents a column in a Logical Replication Protocol relation message + + + + + Flags for the column. Currently can be either 0 for no flags or 1 which marks the column as part of the key. + + + + + Name of the column. + + + + + ID of the column's data type. + + + + + Type modifier of the column (atttypmod). + + + + + Logical Replication Protocol truncate message + + + + + Option flags for TRUNCATE + + + + + IDs of the relations corresponding to the ID in the relation message. + + + + + + + + Enum representing the additional options for the TRUNCATE command as flags + + + + + No additional option was specified + + + + + CASCADE was specified + + + + + RESTART IDENTITY was specified + + + + + Represents the data transmitted for a tuple in a Logical Replication Protocol message + + + + + The kind of data in the tuple + + + + + The value of the tuple, if is . Otherwise throws. + + + + + The value of the tuple, in text format if is , or other formats + as may be added. Otherwise . + + + + + + + + The kind of data transmitted for a tuple in a Logical Replication Protocol message + + + + + Identifies the data as NULL value. + + + + + Identifies unchanged TOASTed value (the actual value is not sent). + + + + + Identifies the data as text formatted value. + + + + + Logical Replication Protocol type message + + + + + ID of the data type. + + + + + Namespace (empty string for pg_catalog). + + + + + Name of the data type. + + + + + + + + Logical Replication Protocol update message for tables with REPLICA IDENTITY set to DEFAULT. + + + This is the base type of all update messages containing only the tuples for the new row. + + + + + ID of the relation corresponding to the ID in the relation message. + + + + + Columns representing the new row. + + + + + + + + Options to be passed to the pgoutput plugin + + + + + Creates a new instance of . + + The publication names to include into the stream + The version of the logical streaming replication protocol + Send values in binary representation + Enable streaming output + + + + Creates a new instance of . + + The publication names to include into the stream + The version of the logical streaming replication protocol + Send values in binary representation + Enable streaming output + + + + The version of the logical streaming replication protocol + + + + + The publication names to stream + + + + + Send values in binary representation + + + This works in PostgreSQL versions 14+ + + + + + Enable streaming output + + + This works in PostgreSQL versions 14+ + + + + + + + + + + + + + + Acts as a proxy for a logical replication slot initialized for for the logical streaming replication protocol + (pgoutput logical decoding plugin). + + + + + Creates a new instance. + + + Create a instance with this + constructor to wrap an existing PostgreSQL replication slot that has + been initialized for the pgoutput logical decoding plugin. + + The name of the existing replication slot + + + + Creates a new instance. + + + Create a instance with this + constructor to wrap an existing PostgreSQL replication slot that has + been initialized for the pgoutput logical decoding plugin. + + The representing the existing replication slot + + + + Creates a new instance. + + + This constructor is intended to be consumed by plugins sitting on top of + + + The from which the new instance should be initialized + + + + Extension methods to use with the pg_output logical decoding plugin. + + + + + Creates a class that wraps a replication slot using the + "pgoutput" logical decoding plugin and can be used to start streaming replication via the logical + streaming replication protocol. + + + See https://www.postgresql.org/docs/current/protocol-logical-replication.html + and https://www.postgresql.org/docs/current/protocol-logicalrep-message-formats.html + for more information. + + The to use for creating the replication slot + The name of the slot to create. Must be a valid replication slot name (see + https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS-MANIPULATION). + + + if this replication slot shall be temporary one; otherwise . + Temporary slots are not saved to disk and are automatically dropped on error or when the session has finished. + + + A to specify what to do with the snapshot created during logical slot + initialization. , which is also the default, will export the + snapshot for use in other sessions. This option can't be used inside a transaction. + will use the snapshot for the current transaction executing the + command. This option must be used in a transaction, and must be the + first command run in that transaction. Finally, will just use + the snapshot for logical decoding as normal but won't do anything else with it. + + + The token to monitor for cancellation requests. + The default value is . + + + A that wraps the newly-created replication slot. + + + + + Instructs the server to start the Logical Streaming Replication Protocol (pgoutput logical decoding plugin), + starting at WAL location or at the slot's consistent point if + isn't specified. + The server can reply with an error, for example if the requested section of the WAL has already been recycled. + + The to use for starting replication + The replication slot that will be updated as replication progresses so that the server + knows which WAL segments are still needed by the standby. + + The collection of options passed to the slot's logical decoding plugin. + The token to monitor for stopping the replication. + The WAL location to begin streaming at. + A representing an that + can be used to stream WAL entries in form of instances. + + + + Represents a physical replication connection to a PostgreSQL server. + + + + + Initializes a new instance of . + + + + + Initializes a new instance of with the given connection string. + + The connection used to open the PostgreSQL database. + + + + Creates a that wraps a PostgreSQL physical replication slot and + can be used to start physical streaming replication + + + The name of the slot to create. Must be a valid replication slot name + (see Section 26.2.6.1). + + + if this replication slot shall be a temporary one; otherwise + . Temporary slots are not saved to disk and are automatically dropped on error or + when the session has finished. + + + If this is set to this physical replication slot reserves WAL immediately. Otherwise, + WAL is only reserved upon connection from a streaming replication client. + + + The token to monitor for cancellation requests. The default value is . + + A that wraps the newly-created replication slot. + + + + + Instructs the server to start streaming the WAL for physical replication, starting at WAL location + . The server can reply with an error, for example if the requested + section of the WAL has already been recycled. + + + If the client requests a timeline that's not the latest but is part of the history of the server, the server + will stream all the WAL on that timeline starting from the requested start point up to the point where the + server switched to another timeline. + + + The replication slot that will be updated as replication progresses so that the server + knows which WAL segments are still needed by the standby. + + The WAL location to begin streaming at. + The token to be used for stopping the replication. + Streaming starts on timeline tli. + A representing an that + can be used to stream WAL entries in form of instances. + + + + Instructs the server to start streaming the WAL for logical replication, starting at WAL location + . The server can reply with an error, for example if the requested + section of WAL has already been recycled. + + + If the client requests a timeline that's not the latest but is part of the history of the server, the server + will stream all the WAL on that timeline starting from the requested start point up to the point where the + server switched to another timeline. + + The WAL location to begin streaming at. + The token to be used for stopping the replication. + Streaming starts on timeline tli. + A representing an that + can be used to stream WAL entries in form of instances. + + + + Wraps a replication slot that uses physical replication. + + + + + Creates a new instance. + + + Create a instance with this constructor to wrap an existing PostgreSQL replication slot + that has been initialized for physical replication. + + The name of the existing replication slot + + + + Defines the core behavior of replication connections and provides the base class for + and + . + + + + + Gets or sets the string used to connect to a PostgreSQL database. See the manual for details. + + + The connection string that includes the server name, the database name, and other parameters needed to establish the initial + connection. The default value is an empty string. + + + Since replication connections are a special kind of connection, + , , + and + are always disabled no matter what you set them to in your connection string. + + + + + The location of the last WAL byte + 1 received in the standby. + + + + + The location of the last WAL byte + 1 flushed to disk in the standby. + + + + + The location of the last WAL byte + 1 applied (e. g. written to disk) in the standby. + + + + + Send replies at least this often. + Timeout. disables automated replies. + + + + + Time that receiver waits for communication from master. + Timeout. disables the timeout. + + + + + Gets or sets the wait time before terminating the attempt to execute a command and generating an error. + + The time to wait for the command to execute. The default value is 30 seconds. + + + + The client encoding for the connection + This can only be called when there is an active connection. + + + + + Process id of backend server. + This can only be called when there is an active connection. + + + + + Opens a database replication connection with the property settings specified by the + ConnectionString. + + The token to monitor for cancellation requests. + The default value is . + + A task representing the asynchronous open operation. + + + + Closes the replication connection and performs tasks associated + with freeing, releasing, or resetting its unmanaged resources asynchronously. + + A task that represents the asynchronous dispose operation. + + + + Requests the server to identify itself. + + The token to monitor for cancellation requests. + The default value is . + + A containing information + about the system we are connected to. + + + + + Requests the server to send the current setting of a run-time parameter. + This is similar to the SQL command SHOW. + + The name of a run-time parameter. + Available parameters are documented in https://www.postgresql.org/docs/current/runtime-config.html. + + The token to monitor for cancellation requests. + The default value is . + The current setting of the run-time parameter specified in as . + + + + Requests the server to send over the timeline history file for timeline tli. + + The timeline for which the history file should be sent. + The token to monitor for cancellation requests. + The default value is . + The timeline history file for timeline tli + + + + Sends a forced status update to PostgreSQL with the current WAL tracking information. + + The connection currently isn't streaming + A Task representing the sending of the status update (and not any PostgreSQL response). + + + + Drops a replication slot, freeing any reserved server-side resources. + If the slot is a logical slot that was created in a database other than + the database the walsender is connected to, this command fails. + + The name of the slot to drop. + + causes the command to wait until the slot becomes + inactive if it currently is active instead of the default behavior of raising an error. + + The token to monitor for cancellation requests. + The default value is . + A task representing the asynchronous drop operation. + + + + The common base class for all streaming replication messages + + + + + The starting point of the WAL data in this message. + + + + + The current end of WAL on the server. + + + + + The server's system clock at the time this message was transmitted, as microseconds since midnight on 2000-01-01. + + + + + Contains information about a newly-created replication slot. + + + + + The name of the newly-created replication slot. + + + + + Contains information about a replication slot. + + + + + Creates a new instance. + + + The name of the replication slot. + + + The WAL location at which the slot became consistent. + + + + + Creates a new instance. + + + The name of the replication slot. + + + The WAL location at which the slot became consistent. + + + + + The name of the replication slot. + + + + + The WAL location at which the slot became consistent. + + + + + The identifier of the snapshot exported by the CREATE_REPLICATION_SLOT command. + + + + + Contains server identification information returned from . + + + + + The unique system identifier identifying the cluster. + This can be used to check that the base backup used to initialize the standby came from the same cluster. + + + + + Current timeline ID. Also useful to check that the standby is consistent with the master. + + + + + Current WAL flush location. Useful to get a known location in the write-ahead log where streaming can start. + + + + + Database connected to. + + + + + Text representations of PostgreSQL WAL operations decoded by the "test_decoding" plugin. See + https://www.postgresql.org/docs/current/test-decoding.html. + + + + + Decoded text representation of the operation performed in this WAL entry + + + + + + + + Returns a clone of this message, which can be accessed after other replication messages have been retrieved. + + + + + Options to be passed to the test_decoding plugin + + + + + Creates a new instance of . + + Include the transaction number for BEGIN and COMMIT command output + Include the timestamp for COMMIT command output + Set the output mode to binary + Skip output for transactions that didn't change the database + Only output data that don't have the replication origin set + Include output from table rewrites that were caused by DDL statements + Enable streaming output + + + + Include the transaction number for BEGIN and COMMIT command output + + + + + Include the timestamp for COMMIT command output + + + + + Set the output mode to binary + + + + + Skip output for transactions that didn't change the database + + + + + Only output data that don't have the replication origin set + + + + + Include output from table rewrites that were caused by DDL statements + + + + + Enable streaming output + + + + + + + + + + + + + + Acts as a proxy for a logical replication slot + initialized for for the test_decoding logical decoding plugin. + + + + + Creates a new instance. + + + Create a instance with this + constructor to wrap an existing PostgreSQL replication slot that has + been initialized for the test_decoding logical decoding plugin. + + The name of the existing replication slot + + + + Creates a new instance. + + + Create a instance with this + constructor to wrap an existing PostgreSQL replication slot that has + been initialized for the test_decoding logical decoding plugin. + + The representing the existing replication slot + + + + Extension methods to use with the + test_decoding logical decoding plugin. + See https://www.postgresql.org/docs/current/test-decoding.html. + + + + + Creates a class that wraps a replication slot using the + test_decoding logical decoding plugin. + + + See https://www.postgresql.org/docs/current/test-decoding.html + for more information. + + The to use for creating the + replication slot + The name of the slot to create. Must be a valid replication slot name (see + https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS-MANIPULATION). + + + if this replication slot shall be temporary one; otherwise . + Temporary slots are not saved to disk and are automatically dropped on error or when the session has finished. + + + A to specify what to do with the snapshot created during logical slot + initialization. , which is also the default, will export the + snapshot for use in other sessions. This option can't be used inside a transaction. + will use the snapshot for the current transaction executing the + command. This option must be used in a transaction, and must be the + first command run in that transaction. Finally, will just use + the snapshot for logical decoding as normal but won't do anything else with it. + + + The token to monitor for cancellation requests. + The default value is . + + + A that wraps the newly-created replication slot. + + + + + Instructs the server to start streaming the WAL for logical replication using the test_decoding logical decoding plugin, + starting at WAL location or at the slot's consistent point if + isn't specified. + The server can reply with an error, for example if the requested section of the WAL has already been recycled. + + The to use for starting replication + The replication slot that will be updated as replication progresses so that the server + knows which WAL segments are still needed by the standby. + + The token to monitor for stopping the replication. + The collection of options passed to the slot's logical decoding plugin. + The WAL location to begin streaming at. + A representing an that + can be used to stream WAL entries in form of instances. + + + + Represents a PostgreSQL timeline history file + + + + + File name of the timeline history file, e.g., 00000002.history. + + + + + Contents of the timeline history file. + + + + + A message representing a section of the WAL data stream. + + + + + A section of the WAL data stream that is raw WAL data in physical replication or decoded with the selected + logical decoding plugin in logical replication. It is only valid until the next + is requested from the stream. + + + A single WAL record is never split across two XLogData messages. + When a WAL record crosses a WAL page boundary, and is therefore already split using continuation records, + it can be split at the page boundary. In other words, the first main WAL record and its continuation + records can be sent in different XLogData messages. + + + + + Stripped-down version of , mainly to support Amazon Redshift. + + + + + Performs some post-setup configuration that's common to both table columns and non-columns. + + + + + Provides schema information about a column. + + + Note that this can correspond to a field returned in a query which isn't an actual table column + + See https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqldatareader.getschematable(v=vs.110).aspx + for information on the meaning of the different fields. + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The describing the type of this column. + + + + + The OID of the type of this column in the PostgreSQL pg_type catalog table. + + + + + The OID of the PostgreSQL table of this column. + + + + + The column's position within its table. Note that this is different from , + which is the column's position within the resultset. + + + + + The default SQL expression for this column. + + + + + The value for this column's type. + + + + + + + + Receives a raw SQL query as passed in by the user, and performs some processing necessary + before sending to the backend. + This includes doing parameter placeholder processing (@p => $1), and splitting the query + up by semicolons if needed (SELECT 1; SELECT 2) + + Raw user-provided query. + + The parameters configured on the of this query or an empty + if deriveParameters is set to true. + + An empty list to be populated with the statements parsed by this method. + Whether PostgreSQL standards-conforming are used. + + A bool indicating whether parameters contains a list of preconfigured parameters or an empty list to be filled with derived + parameters. + + + + + Utility that simplifies awaiting a task with a timeout. If the given task does not + complete within , a is thrown. + + The task to be awaited + How much time to allow to complete before throwing a + An awaitable task that represents the original task plus the timeout + + + + Allows you to cancel awaiting for a non-cancellable task. + + + Read https://blogs.msdn.com/b/pfxteam/archive/2012/10/05/how-do-i-cancel-non-cancelable-async-operations.aspx + and be very careful with this. + + + + + Utility that simplifies awaiting a task with a timeout. If the given task does not + complete within , a is thrown. + + The task to be awaited + How much time to allow to complete before throwing a + An awaitable task that represents the original task plus the timeout + + + + Allows you to cancel awaiting for a non-cancellable task. + + + Read https://blogs.msdn.com/b/pfxteam/archive/2012/10/05/how-do-i-cancel-non-cancelable-async-operations.aspx + and be very careful with this. + + + + + Non-generic base class for all type handlers which handle PostgreSQL arrays. + Extend from instead. + + + https://www.postgresql.org/docs/current/static/arrays.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + Reads an array of element type from the given buffer . + + + + + Reads a generic list containing elements of type from the given buffer . + + + + + Base class for all type handlers which handle PostgreSQL arrays. + + + https://www.postgresql.org/docs/current/static/arrays.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + https://www.postgresql.org/docs/current/static/arrays.html + + The .NET type contained as an element within this array + The .NET provider-specific type contained as an element within this array + + + + A type handler for the PostgreSQL bit string data type. + + + See https://www.postgresql.org/docs/current/static/datatype-bit.html. + + Note that for BIT(1), this handler will return a bool by default, to align with SQLClient + (see discussion https://github.com/npgsql/npgsql/pull/362#issuecomment-59622101). + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A special handler for arrays of bit strings. + Differs from the standard array handlers in that it returns arrays of bool for BIT(1) and arrays + of BitArray otherwise (just like the scalar BitStringHandler does). + + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + A type handler for the PostgreSQL bool data type. + + + See https://www.postgresql.org/docs/current/static/datatype-boolean.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL bytea data type. + + + See https://www.postgresql.org/docs/current/static/datatype-binary.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + Constructs a . + + + + + + + + + + + + + + + + + + + + The CLR type mapped to the PostgreSQL composite type. + + + + + Interface implemented by all mapped composite handler factories. + Used to expose the name translator for those reflecting composite mappings (e.g. EF Core). + + + + + The name translator used for this composite. + + + + + A factory for type handlers for the PostgreSQL date data type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + A type handler for the PostgreSQL date data type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + Whether to convert positive and negative infinity values to DateTime.{Max,Min}Value when + a DateTime is requested + + + + + Constructs a + + + + + + + + Copied wholesale from Postgresql backend/utils/adt/datetime.c:j2date + + + + + + + + + + + + + + + + + A factory for type handlers for the PostgreSQL interval data type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + A type handler for the PostgreSQL date interval type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + Constructs an + + + + + + + + + + + + + + + + + + + + + + + A factory for type handlers for the PostgreSQL time data type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + A type handler for the PostgreSQL time data type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + Constructs a . + + + + + + + + + + + + + + A factory for type handlers for the PostgreSQL timestamp data type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + A type handler for the PostgreSQL timestamp data type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + Whether to convert positive and negative infinity values to DateTime.{Max,Min}Value when + a DateTime is requested + + + + + Constructs a . + + + + + + + + + + + Reads a timestamp from the buffer as an . + + + + + + + + + + + + + + + + + A factory for type handlers for the PostgreSQL timestamptz data type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + A type handler for the PostgreSQL timestamptz data type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + Constructs an . + + + + + + + + + + + + + + + + + + + + + + + + + + A factory for type handlers for the PostgreSQL timetz data type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + A type handler for the PostgreSQL timetz data type. + + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + Constructs an . + + + + + + + + + + + + + + + + + + + + + + + + + + Interface implemented by all concrete handlers which handle enums + + + + + The CLR enum type mapped to the PostgreSQL enum + + + + + Interface implemented by all enum handler factories. + Used to expose the name translator for those reflecting enum mappings (e.g. EF Core). + + + + + The name translator used for this enum. + + + + + A type handler for the PostgreSQL tsquery data type. + + + See https://www.postgresql.org/docs/current/static/datatype-textsearch.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL tsvector data type. + + + See https://www.postgresql.org/docs/current/static/datatype-textsearch.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL box data type. + + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL circle data type. + + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL line data type. + + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL lseg data type. + + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL path data type. + + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL point data type. + + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL polygon data type. + + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A factory for type handlers for the PostgreSQL hstore extension data type, which stores sets of key/value pairs + within a single PostgreSQL value. + + + See https://www.postgresql.org/docs/current/hstore.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + A type handler for the PostgreSQL hstore extension data type, which stores sets of key/value pairs within a + single PostgreSQL value. + + + See https://www.postgresql.org/docs/current/hstore.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + The text handler to which we delegate encoding/decoding of the actual strings + + + + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL "char" type, used only internally. + + + See https://www.postgresql.org/docs/current/static/datatype-character.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An int2vector is simply a regular array of shorts, with the sole exception that its lower bound must + be 0 (we send 1 for regular arrays). + + + + + An OIDVector is simply a regular array of uints, with the sole exception that its lower bound must + be 0 (we send 1 for regular arrays). + + + + + A factory for type handlers for the PostgreSQL jsonb data type. + + + See https://www.postgresql.org/docs/current/datatype-json.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + A factory for type handlers for the PostgreSQL json data type. + + + See https://www.postgresql.org/docs/current/datatype-json.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + A type handler for the PostgreSQL json and jsonb data type. + + + See https://www.postgresql.org/docs/current/datatype-json.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + Prepended to the string in the wire encoding + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A factory for type handlers for the PostgreSQL jsonpath data type. + + + See https://www.postgresql.org/docs/current/datatype-json.html#DATATYPE-JSONPATH. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + A type handler for the PostgreSQL jsonpath data type. + + + See https://www.postgresql.org/docs/current/datatype-json.html#DATATYPE-JSONPATH. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + Prepended to the string in the wire encoding + + + + + + + + + + + + + + + + + + + + LQuery binary encoding is a simple UTF8 string, but prepended with a version number. + + + + + Prepended to the string in the wire encoding + + + + + Ltree binary encoding is a simple UTF8 string, but prepended with a version number. + + + + + Prepended to the string in the wire encoding + + + + + LTxtQuery binary encoding is a simple UTF8 string, but prepended with a version number. + + + + + Prepended to the string in the wire encoding + + + + + A type handler for the PostgreSQL cidr data type. + + + See https://www.postgresql.org/docs/current/static/datatype-net-types.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL cidr data type. + + + See https://www.postgresql.org/docs/current/static/datatype-net-types.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL macaddr and macaddr8 data types. + + + See https://www.postgresql.org/docs/current/static/datatype-net-types.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL double precision data type. + + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL smallint data type. + + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL integer data type. + + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL bigint data type. + + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL money data type. + + + See https://www.postgresql.org/docs/current/static/datatype-money.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL numeric data type. + + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL real data type. + + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + + + + A type handler for the PostgreSQL real data type. + + + See https://www.postgresql.org/docs/current/static/datatype-oid.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + An interface implementing by , exposing the handler's supported range + CLR types. + + + + + Exposes the range CLR types supported by this handler. + + + + + A type handler for PostgreSQL range types. + + + See https://www.postgresql.org/docs/current/static/rangetypes.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + the range subtype + + + + The type handler for the element that this range type holds + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Type handler for PostgreSQL range types + + + Introduced in PostgreSQL 9.2. + https://www.postgresql.org/docs/current/static/rangetypes.html + + the main range subtype + an alternative range subtype + + + + + + + + + + + + + Type handler for PostgreSQL record types. + + + https://www.postgresql.org/docs/current/static/datatype-pseudo.html + + Encoding (identical to composite): + A 32-bit integer with the number of columns, then for each column: + * An OID indicating the type of the column + * The length of the column(32-bit integer), or -1 if null + * The column data encoded as binary + + + + + A factory for type handlers for PostgreSQL character data types (text, char, varchar, xml...). + + + See https://www.postgresql.org/docs/current/datatype-character.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + A type handler for PostgreSQL character data types (text, char, varchar, xml...). + + + See https://www.postgresql.org/docs/current/datatype-character.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Handles "conversions" for columns sent by the database with unknown OIDs. + This differs from TextHandler in that its a text-only handler (we don't want to receive binary + representations of the types registered here). + Note that this handler is also used in the very initial query that loads the OID mappings + (chicken and egg problem). + Also used for sending parameters with unknown types (OID=0) + + + + + A type handler for the PostgreSQL uuid data type. + + + See https://www.postgresql.org/docs/current/static/datatype-uuid.html. + + The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it + should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. + Use it at your own risk. + + + + + + + + + + + + + + + + + https://www.postgresql.org/docs/current/static/datatype-boolean.html + + + + + A type handler factory used to instantiate Npgsql's built-in type handlers. + + + + + Type handlers that wish to support reading other types in additional to the main one can + implement this interface for all those types. + + + + + Reads a value of type with the given length from the provided buffer, + with the assumption that it is entirely present in the provided memory buffer and no I/O will be + required. + + The buffer from which to read. + The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. + Additional PostgreSQL information about the type, such as the length in varchar(30). + The fully-read value. + + + + Responsible for validating that a value represents a value of the correct and which can be + written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown. + Also returns the byte length needed to write the value. + + The value to be written to PostgreSQL + + The instance where this value resides. Can be used to access additional + information relevant to the write process (e.g. ). + + The number of bytes required to write the value. + + + + Writes a value to the provided buffer, with the assumption that there is enough space in the buffer + (no I/O will occur). The Npgsql core will have taken care of that. + + The value to write. + The buffer to which to write. + + The instance where this value resides. Can be used to access additional + information relevant to the write process (e.g. ). + + + + + Type handlers that wish to support reading other types in additional to the main one can + implement this interface for all those types. + + + + + Reads a value of type with the given length from the provided buffer, + using either sync or async I/O. + + The buffer from which to read. + The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. + If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously. + Additional PostgreSQL information about the type, such as the length in varchar(30). + The fully-read value. + + + + Responsible for validating that a value represents a value of the correct and which can be + written for PostgreSQL - if the value cannot be written for any reason, an exception should be thrown. + Also returns the byte length needed to write the value. + + The value to be written to PostgreSQL + A cache where the length calculated during the validation phase can be stored for use at the writing phase. + + The instance where this value resides. Can be used to access additional + information relevant to the write process (e.g. ). + + The number of bytes required to write the value. + + + + Writes a value to the provided buffer. + + The value to write. + The buffer to which to write. + A cache where the length calculated during the validation phase can be stored for use at the writing phase. + + The instance where this value resides. Can be used to access additional + information relevant to the write process (e.g. ). + + + If I/O will be necessary (i.e. the buffer is full), determines whether it will be done synchronously or asynchronously. + + The that can be used to cancel the operation. + + + + Implemented by handlers which support , returns a standard + TextReader given a binary Stream. + + + + + Base class for all simple type handlers, which read and write short, non-arbitrary lengthed + values to PostgreSQL. Provides a simpler API to implement when compared to - + Npgsql takes care of all I/O before calling into this type, so no I/O needs to be performed by it. + + + The default CLR type that this handler will read and write. For example, calling + on a column with this handler will return a value with type . + Type handlers can support additional types by implementing . + + + + + Constructs an . + + + + + Reads a value of type with the given length from the provided buffer, + with the assumption that it is entirely present in the provided memory buffer and no I/O will be + required. + + The buffer from which to read. + The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. + Additional PostgreSQL information about the type, such as the length in varchar(30). + The fully-read value. + + + + Reads a value of type with the given length from the provided buffer, + using either sync or async I/O. This method is sealed for , + override . + + The buffer from which to read. + The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. + If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously. + Additional PostgreSQL information about the type, such as the length in varchar(30). + The fully-read value. + + + + Reads a value of type with the given length from the provided buffer, + using either sync or async I/O. This method is sealed for . + + The buffer from which to read. + The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. + If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously. + Additional PostgreSQL information about the type, such as the length in varchar(30). + The fully-read value. + + + + Reads a value of type with the given length from the provided buffer. + with the assumption that it is entirely present in the provided memory buffer and no I/O will be + required. Type handlers typically don't need to override this - override + - but may do + so in exceptional cases where reading of arbitrary types is required. + + The buffer from which to read. + The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. + Additional PostgreSQL information about the type, such as the length in varchar(30). + The fully-read value. + + + + Responsible for validating that a value represents a value of the correct and which can be + written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown. + Also returns the byte length needed to write the value. + + The value to be written to PostgreSQL + + The instance where this value resides. Can be used to access additional + information relevant to the write process (e.g. ). + + The number of bytes required to write the value. + + + + Writes a value to the provided buffer, with the assumption that there is enough space in the buffer + (no I/O will occur). The Npgsql core will have taken care of that. + + The value to write. + The buffer to which to write. + + The instance where this value resides. Can be used to access additional + information relevant to the write process (e.g. ). + + + + + This method is sealed, override . + + + + + In the vast majority of cases writing a parameter to the buffer won't need to perform I/O. + + + + + Simple type handlers override instead of this. + + + + + Simple type handlers override instead of this. + + + + + Called to validate and get the length of a value of a non-generic . + Type handlers generally don't need to override this. + + + + + Called to write the value of a non-generic . + Type handlers generally don't need to override this. + + + + + A simple type handler that supports a provider-specific value in addition to its default value. + This is necessary mainly in cases where the CLR type cannot represent the full range of the + PostgreSQL type, and a custom CLR type is needed (e.g. and + ). The provider-specific type will be returned + from calls to . + + + The default CLR type that this handler will read and write. For example, calling + on a column with this handler will return a value with type . + Type handlers can support additional types by implementing . + + The provider-specific CLR type that this handler will read and write. + + + + Constructs an + + + + + + Reads a value of type with the given length from the provided buffer, + with the assumption that it is entirely present in the provided memory buffer and no I/O will be + required. + + The buffer from which to read. + The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. + Additional PostgreSQL information about the type, such as the length in varchar(30). + The fully-read value. + + + + Reads a column as the type handler's provider-specific type, assuming that it is already entirely + in memory (i.e. no I/O is necessary). Called by in non-sequential mode, which + buffers entire rows in memory. + + + + + Reads a column as the type handler's provider-specific type. If it is not already entirely in + memory, sync or async I/O will be performed as specified by . + + + + + Responsible for validating that a value represents a value of the correct and which can be + written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown. + Also returns the byte length needed to write the value. + + The value to be written to PostgreSQL + + The instance where this value resides. Can be used to access additional + information relevant to the write process (e.g. ). + + The number of bytes required to write the value. + + + + Writes a value to the provided buffer, with the assumption that there is enough space in the buffer + (no I/O will occur). The Npgsql core will have taken care of that. + + The value to write. + The buffer to which to write. + + The instance where this value resides. Can be used to access additional + information relevant to the write process (e.g. ). + + + + + + + + Base class for all type handlers, which read and write CLR types into their PostgreSQL + binary representation. + Type handler writers shouldn't inherit from this class, inherit + or instead. + + + + + The PostgreSQL type handled by this type handler. + + + + + Constructs a . + + + + + Reads a value of type with the given length from the provided buffer, + using either sync or async I/O. + + The buffer from which to read. + The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. + If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously. + Additional PostgreSQL information about the type, such as the length in varchar(30). + The fully-read value. + + + + Reads a value of type with the given length from the provided buffer, + with the assumption that it is entirely present in the provided memory buffer and no I/O will be + required. This can save the overhead of async functions and improves performance. + + The buffer from which to read. + The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. + Additional PostgreSQL information about the type, such as the length in varchar(30). + The fully-read value. + + + + Reads a column as the type handler's default read type, assuming that it is already entirely + in memory (i.e. no I/O is necessary). Called by in non-sequential mode, which + buffers entire rows in memory. + + + + + Reads a column as the type handler's default read type. If it is not already entirely in + memory, sync or async I/O will be performed as specified by . + + + + + Reads a column as the type handler's provider-specific type, assuming that it is already entirely + in memory (i.e. no I/O is necessary). Called by in non-sequential mode, which + buffers entire rows in memory. + + + + + Reads a column as the type handler's provider-specific type. If it is not already entirely in + memory, sync or async I/O will be performed as specified by . + + + + + Reads a value from the buffer, assuming our read position is at the value's preceding length. + If the length is -1 (null), this method will return the default value. + + + + + Called to validate and get the length of a value of a generic . + + + + + Called to write the value of a generic . + + + + + Responsible for validating that a value represents a value of the correct and which can be + written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown. + Also returns the byte length needed to write the value. + + The value to be written to PostgreSQL + + If the byte length calculation is costly (e.g. for UTF-8 strings), its result can be stored in the + length cache to be reused in the writing process, preventing recalculation. + + + The instance where this value resides. Can be used to access additional + information relevant to the write process (e.g. ). + + The number of bytes required to write the value. + + + + Writes a value to the provided buffer, using either sync or async I/O. + + The value to write. + The buffer to which to write. + + + The instance where this value resides. Can be used to access additional + information relevant to the write process (e.g. ). + + If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously. + The that can be used to cancel the operation. + + + + Creates a type handler for arrays of this handler's type. + + + + + Creates a type handler for ranges of this handler's type. + + + + + Used to create an exception when the provided type can be converted and written, but an + instance of is required for caching of the converted value + (in . + + + + + Base class for all type handler factories, which construct type handlers that know how + to read and write CLR types from/to PostgreSQL types. + + + In general, do not inherit from this class, inherit from instead. + + + + + Creates a type handler. + + + + + The default CLR type that handlers produced by this factory will read and write. + + + + + Base class for all type handler factories, which construct type handlers that know how + to read and write CLR types from/to PostgreSQL types. Type handler factories are set up + via in either the global or connection-specific type mapper. + + + + + The default CLR type that handlers produced by this factory will read and write. + + + + Creates a type handler. + + + + + + + + + + + Base class for all type handlers, which read and write CLR types into their PostgreSQL + binary representation. Unless your type is arbitrary-length, consider inheriting from + instead. + + + The default CLR type that this handler will read and write. For example, calling + on a column with this handler will return a value with type . + Type handlers can support additional types by implementing . + + + + + Constructs an . + + + + + Reads a value of type with the given length from the provided buffer, + using either sync or async I/O. + + The buffer from which to read. + The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. + If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously. + Additional PostgreSQL information about the type, such as the length in varchar(30). + The fully-read value. + + + + Reads a value of type with the given length from the provided buffer, + using either sync or async I/O. Type handlers typically don't need to override this - + override - but may do + so in exceptional cases where reading of arbitrary types is required. + + The buffer from which to read. + The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed. + If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously. + Additional PostgreSQL information about the type, such as the length in varchar(30). + The fully-read value. + + + + + + + Called to validate and get the length of a value of a generic . + + + + + Called to write the value of a generic . + + + + + Called to validate and get the length of a value of an arbitrary type. + Checks that the current handler supports that type and throws an exception otherwise. + + + + + In the vast majority of cases writing a parameter to the buffer won't need to perform I/O. + + + + + Typically does not need to be overridden by type handlers, but may be needed in some + cases (e.g. . + Note that this method assumes it can write 4 bytes of length (already verified by + ). + + + + + Called to validate and get the length of a value of a non-generic . + Type handlers generally don't need to override this. + + + + + Called to write the value of a non-generic . + Type handlers generally don't need to override this. + + + + + + + + + + + The connector to which this type mapper belongs. + + + + + Type information for the database of this mapper. + + + + + Maps CLR types to their type handlers. + + + + + Maps CLR types to their array handlers. + + + + + Copy of at the time when this + mapper was created, to detect mapping changes. If changes are made to this connection's + mapper, the change counter is set to -1. + + + + + Looks up a type handler by its PostgreSQL type's OID. + + A PostgreSQL type OID + A type handler that can be used to encode and decode values. + + + + A counter that is incremented whenever a global mapping change occurs. + Used to invalidate bound type mappers. + + + + + A type mapper, managing how to read and write CLR values to PostgreSQL data types. + A type mapper exists for each connection, as well as a single global type mapper + (accessible via ). + + + + + + + The default name translator to convert CLR type names and member names. + + + + + Enumerates all mappings currently set up on this type mapper. + + + + + Adds a new type mapping to this mapper, overwriting any existing mapping in the process. + + + + + Removes an existing mapping from this mapper. Attempts to read or write this type + after removal will result in an exception. + + A PostgreSQL type name for the type in the database. + + + + Maps a CLR enum to a PostgreSQL enum type. + + + CLR enum labels are mapped by name to PostgreSQL enum labels. + The translation strategy can be controlled by the parameter, + which defaults to . + You can also use the on your enum fields to manually specify a PostgreSQL enum label. + If there is a discrepancy between the .NET and database labels while an enum is read or written, + an exception will be raised. + + + A PostgreSQL type name for the corresponding enum type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + The .NET enum type to be mapped + + + + Removes an existing enum mapping. + + + A PostgreSQL type name for the corresponding enum type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + + + + Maps a CLR type to a PostgreSQL composite type. + + + CLR fields and properties by string to PostgreSQL names. + The translation strategy can be controlled by the parameter, + which defaults to . + You can also use the on your members to manually specify a PostgreSQL name. + If there is a discrepancy between the .NET type and database type while a composite is read or written, + an exception will be raised. + + + A PostgreSQL type name for the corresponding composite type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + The .NET type to be mapped + + + + Removes an existing composite mapping. + + + A PostgreSQL type name for the corresponding composite type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + + + + Maps a CLR type to a composite type. + + + Maps CLR fields and properties by string to PostgreSQL names. + The translation strategy can be controlled by the parameter, + which defaults to . + If there is a discrepancy between the .NET type and database type while a composite is read or written, + an exception will be raised. + + The .NET type to be mapped. + + A PostgreSQL type name for the corresponding composite type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + + + + Removes an existing composite mapping. + + The .NET type to be unmapped. + + A PostgreSQL type name for the corresponding composite type in the database. + If null, the name translator given in will be used. + + + A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). + Defaults to + + + + + Resets all mapping changes performed on this type mapper and reverts it to its original, starting state. + + + + + Builds instances of for addition into . + + + + + The name of the PostgreSQL type name, as it appears in the pg_type catalog. + + + This can a a partial name (without the schema), or a fully-qualified name + (schema.typename) - the latter can be used if you have two types with the same + name in different schemas. + + + + + The that corresponds to this type. Setting an + 's property + to this value will make Npgsql write its value to PostgreSQL with this mapping. + + + + + A set of s that correspond to this type. Setting an + 's property + to one of these values will make Npgsql write its value to PostgreSQL with this mapping. + + + + + A set of CLR types that correspond to this type. Setting an + 's property + to one of these types will make Npgsql write its value to PostgreSQL with this mapping. + + + + + Determines what is returned from when this mapping + is used. + + + + + A factory for a type handler that will be used to read and write values for PostgreSQL type. + + + + + Builds an that can be added to an . + + + + + + Represents a type mapping for a PostgreSQL data type, which can be added to a type mapper, + managing when that data type will be read and written and how. + + + + + + + The name of the PostgreSQL type name, as it appears in the pg_type catalog. + + + This can a a partial name (without the schema), or a fully-qualified name + (schema.typename) - the latter can be used if you have two types with the same + name in different schemas. + + + + + The that corresponds to this type. Setting an + 's property + to this value will make Npgsql write its value to PostgreSQL with this mapping. + + + + + A set of s that correspond to this type. Setting an + 's property + to one of these values will make Npgsql write its value to PostgreSQL with this mapping. + + + + + A set of CLR types that correspond to this type. Setting an + 's property + to one of these types will make Npgsql write its value to PostgreSQL with this mapping. + + + + + Determines what is returned from when this mapping + is used. + + + + + A factory for a type handler that will be used to read and write values for PostgreSQL type. + + + + + The default CLR type that handlers produced by this factory will read and write. + Used by the EF Core provider (and possibly others in the future). + + + + + Returns a string that represents the current object. + + + + + Maps an Npgsql type handler to a PostgreSQL type. + + A PostgreSQL type name as it appears in the pg_type table. + + A member of which represents this PostgreSQL type. + An with set to + this value will be sent with the type handler mapped by this attribute. + + + All members of which represent this PostgreSQL type. + An with set to + one of these values will be sent with the type handler mapped by this attribute. + + + Any .NET type which corresponds to this PostgreSQL type. + An with set to + one of these values will be sent with the type handler mapped by this attribute. + + + The "primary" which best corresponds to this PostgreSQL type. + When or + set, will be set to this value. + + + + + Read-only parameter + + + + + Returns a string that represents the current object. + + + + + + Represents a timeout that will expire at some point. + + + + + A wrapper around to simplify reset management. + + + Since there's no way to reset a once it was cancelled, + we need to make sure that an existing cancellation token source hasn't been cancelled, + every time we start it (see https://github.com/dotnet/runtime/issues/4694). + + + + + Used, so we wouldn't concurently use the cts for the cancellation, while it's being disposed + + + + + Set the timeout on the wrapped + and make sure that it hasn't been cancelled yet + + An optional cancellation token that will be linked with the + contained + The from the wrapped + + + + Restart the timeout on the wrapped without reinitializing it, + even if is already set to + + + + + Reset the wrapper to contain a unstarted and uncancelled + in order make sure the next call to will not invalidate + the cancellation token. + + An optional cancellation token that will be linked with the + contained + The from the wrapped + + + + Reset the wrapper to contain a unstarted and uncancelled + in order make sure the next call to will not invalidate + the cancellation token. + + + + + Set the timeout on the wrapped + to + + + can still arrive at a state + where it's value is if the + passed to gets a cancellation request. + If this is the case it will be resolved upon the next call to + or . Calling multiple times or without calling + first will do no any harm (besides eating a tiny amount of CPU cycles). + + + + + Cancel the wrapped + + + + + Cancel the wrapped after delay + + + + + The from the wrapped + . + + + The token is only valid after calling + and before calling the next time. + Otherwise you may end up with a token that has already been + cancelled or belongs to a cancellation token source that has + been disposed. + + + + + Allocation free helper function to find if version is greater than expected + + + + + + + + Note that a connection may be closed before its TransactionScope completes. In this case we close the NpgsqlConnection + as usual but the connector in a special list in the pool; it will be closed only when the scope completes. + + + + + A set of extension methods to to allow runtime compatibility. + + + + + Appends the provided to the . + + The to append to. + The to append. + + + + Represents the date 1970-01-01 + + + + + Represents the date 0001-01-01 + + + + + A struct similar to .NET DateTime but capable of storing PostgreSQL's timestamp and timestamptz types. + DateTime is capable of storing values from year 1 to 9999 at 100-nanosecond precision, + while PostgreSQL's timestamps store values from 4713BC to 5874897AD with 1-microsecond precision. + + + + + Cast of an to a . + + An equivalent . + + + + Converts the value of the current object to Coordinated Universal Time (UTC). + + + See the MSDN documentation for DateTime.ToUniversalTime(). + Note: this method only takes into account the time zone's base offset, and does + not respect daylight savings. See https://github.com/npgsql/npgsql/pull/684 for more + details. + + + + + Converts the value of the current object to local time. + + + See the MSDN documentation for DateTime.ToLocalTime(). + Note: this method only takes into account the time zone's base offset, and does + not respect daylight savings. See https://github.com/npgsql/npgsql/pull/684 for more + details. + + + + + Returns a new that adds the value of the specified to the value of this instance. + + An NpgsqlTimeSpan interval. + An object whose value is the sum of the date and time represented by this instance and the time interval represented by value. + + + + Returns a new that adds the value of the specified TimeSpan to the value of this instance. + + A positive or negative time interval. + An object whose value is the sum of the date and time represented by this instance and the time interval represented by value. + + + + Returns a new that adds the specified number of years to the value of this instance. + + A number of years. The value parameter can be negative or positive. + An object whose value is the sum of the date and time represented by this instance and the number of years represented by value. + + + + Returns a new that adds the specified number of months to the value of this instance. + + A number of months. The months parameter can be negative or positive. + An object whose value is the sum of the date and time represented by this instance and months. + + + + Returns a new that adds the specified number of days to the value of this instance. + + A number of whole and fractional days. The value parameter can be negative or positive. + An object whose value is the sum of the date and time represented by this instance and the number of days represented by value. + + + + Returns a new that adds the specified number of hours to the value of this instance. + + A number of whole and fractional hours. The value parameter can be negative or positive. + An object whose value is the sum of the date and time represented by this instance and the number of hours represented by value. + + + + Returns a new that adds the specified number of minutes to the value of this instance. + + A number of whole and fractional minutes. The value parameter can be negative or positive. + An object whose value is the sum of the date and time represented by this instance and the number of minutes represented by value. + + + + Returns a new that adds the specified number of minutes to the value of this instance. + + A number of whole and fractional minutes. The value parameter can be negative or positive. + An object whose value is the sum of the date and time represented by this instance and the number of minutes represented by value. + + + + Returns a new that adds the specified number of milliseconds to the value of this instance. + + A number of whole and fractional milliseconds. The value parameter can be negative or positive. Note that this value is rounded to the nearest integer. + An object whose value is the sum of the date and time represented by this instance and the number of milliseconds represented by value. + + + + Returns a new that adds the specified number of ticks to the value of this instance. + + A number of 100-nanosecond ticks. The value parameter can be positive or negative. + An object whose value is the sum of the date and time represented by this instance and the time represented by value. + + + + Implicit cast of a to an + + A + An equivalent . + + + + Explicit cast of an to a . + + An . + An equivalent . + + + + Represents a PostgreSQL data type that can be written or read to the database. + Used in places such as to unambiguously specify + how to encode or decode values. + + See https://www.postgresql.org/docs/current/static/datatype.html + + + + Corresponds to the PostgreSQL 8-byte "bigint" type. + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html + + + + Corresponds to the PostgreSQL 8-byte floating-point "double" type. + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html + + + + Corresponds to the PostgreSQL 4-byte "integer" type. + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html + + + + Corresponds to the PostgreSQL arbitrary-precision "numeric" type. + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html + + + + Corresponds to the PostgreSQL floating-point "real" type. + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html + + + + Corresponds to the PostgreSQL 2-byte "smallint" type. + + See https://www.postgresql.org/docs/current/static/datatype-numeric.html + + + + Corresponds to the PostgreSQL "money" type. + + See https://www.postgresql.org/docs/current/static/datatype-money.html + + + + Corresponds to the PostgreSQL "boolean" type. + + See https://www.postgresql.org/docs/current/static/datatype-boolean.html + + + + Corresponds to the PostgreSQL geometric "box" type. + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html + + + + Corresponds to the PostgreSQL geometric "circle" type. + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html + + + + Corresponds to the PostgreSQL geometric "line" type. + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html + + + + Corresponds to the PostgreSQL geometric "lseg" type. + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html + + + + Corresponds to the PostgreSQL geometric "path" type. + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html + + + + Corresponds to the PostgreSQL geometric "point" type. + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html + + + + Corresponds to the PostgreSQL geometric "polygon" type. + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html + + + + Corresponds to the PostgreSQL "char(n)" type. + + See https://www.postgresql.org/docs/current/static/datatype-character.html + + + + Corresponds to the PostgreSQL "text" type. + + See https://www.postgresql.org/docs/current/static/datatype-character.html + + + + Corresponds to the PostgreSQL "varchar" type. + + See https://www.postgresql.org/docs/current/static/datatype-character.html + + + + Corresponds to the PostgreSQL internal "name" type. + + See https://www.postgresql.org/docs/current/static/datatype-character.html + + + + Corresponds to the PostgreSQL "citext" type for the citext module. + + See https://www.postgresql.org/docs/current/static/citext.html + + + + Corresponds to the PostgreSQL "char" type. + + + This is an internal field and should normally not be used for regular applications. + + See https://www.postgresql.org/docs/current/static/datatype-text.html + + + + + Corresponds to the PostgreSQL "bytea" type, holding a raw byte string. + + See https://www.postgresql.org/docs/current/static/datatype-binary.html + + + + Corresponds to the PostgreSQL "date" type. + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + + + Corresponds to the PostgreSQL "time" type. + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + + + Corresponds to the PostgreSQL "timestamp" type. + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + + + Corresponds to the PostgreSQL "timestamp with time zone" type. + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + + + Corresponds to the PostgreSQL "timestamp with time zone" type. + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + + + Corresponds to the PostgreSQL "interval" type. + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + + + Corresponds to the PostgreSQL "time with time zone" type. + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + + + Corresponds to the PostgreSQL "time with time zone" type. + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + + + Corresponds to the obsolete PostgreSQL "abstime" type. + + See https://www.postgresql.org/docs/current/static/datatype-datetime.html + + + + Corresponds to the PostgreSQL "inet" type. + + See https://www.postgresql.org/docs/current/static/datatype-net-types.html + + + + Corresponds to the PostgreSQL "cidr" type, a field storing an IPv4 or IPv6 network. + + See https://www.postgresql.org/docs/current/static/datatype-net-types.html + + + + Corresponds to the PostgreSQL "macaddr" type, a field storing a 6-byte physical address. + + See https://www.postgresql.org/docs/current/static/datatype-net-types.html + + + + Corresponds to the PostgreSQL "macaddr8" type, a field storing a 6-byte or 8-byte physical address. + + See https://www.postgresql.org/docs/current/static/datatype-net-types.html + + + + Corresponds to the PostgreSQL "bit" type. + + See https://www.postgresql.org/docs/current/static/datatype-bit.html + + + + Corresponds to the PostgreSQL "varbit" type, a field storing a variable-length string of bits. + + See https://www.postgresql.org/docs/current/static/datatype-boolean.html + + + + Corresponds to the PostgreSQL "tsvector" type. + + See https://www.postgresql.org/docs/current/static/datatype-textsearch.html + + + + Corresponds to the PostgreSQL "tsquery" type. + + See https://www.postgresql.org/docs/current/static/datatype-textsearch.html + + + + Corresponds to the PostgreSQL "regconfig" type. + + See https://www.postgresql.org/docs/current/static/datatype-textsearch.html + + + + Corresponds to the PostgreSQL "uuid" type. + + See https://www.postgresql.org/docs/current/static/datatype-uuid.html + + + + Corresponds to the PostgreSQL "xml" type. + + See https://www.postgresql.org/docs/current/static/datatype-xml.html + + + + Corresponds to the PostgreSQL "json" type, a field storing JSON in text format. + + See https://www.postgresql.org/docs/current/static/datatype-json.html + + + + + Corresponds to the PostgreSQL "jsonb" type, a field storing JSON in an optimized binary. + format. + + + Supported since PostgreSQL 9.4. + See https://www.postgresql.org/docs/current/static/datatype-json.html + + + + + Corresponds to the PostgreSQL "jsonpath" type, a field storing JSON path in text format. + format. + + + Supported since PostgreSQL 12. + See https://www.postgresql.org/docs/current/datatype-json.html#DATATYPE-JSONPATH + + + + + Corresponds to the PostgreSQL "hstore" type, a dictionary of string key-value pairs. + + See https://www.postgresql.org/docs/current/static/hstore.html + + + + Corresponds to the PostgreSQL "array" type, a variable-length multidimensional array of + another type. This value must be combined with another value from + via a bit OR (e.g. NpgsqlDbType.Array | NpgsqlDbType.Integer) + + See https://www.postgresql.org/docs/current/static/arrays.html + + + + Corresponds to the PostgreSQL "range" type, continuous range of values of specific type. + This value must be combined with another value from + via a bit OR (e.g. NpgsqlDbType.Range | NpgsqlDbType.Integer) + + + Supported since PostgreSQL 9.2. + See https://www.postgresql.org/docs/9.2/static/rangetypes.html + + + + + Corresponds to the PostgreSQL "refcursor" type. + + + + + Corresponds to the PostgreSQL internal "oidvector" type. + + See https://www.postgresql.org/docs/current/static/datatype-oid.html + + + + Corresponds to the PostgreSQL internal "int2vector" type. + + + + + Corresponds to the PostgreSQL "oid" type. + + See https://www.postgresql.org/docs/current/static/datatype-oid.html + + + + Corresponds to the PostgreSQL "xid" type, an internal transaction identifier. + + See https://www.postgresql.org/docs/current/static/datatype-oid.html + + + + Corresponds to the PostgreSQL "cid" type, an internal command identifier. + + See https://www.postgresql.org/docs/current/static/datatype-oid.html + + + + Corresponds to the PostgreSQL "regtype" type, a numeric (OID) ID of a type in the pg_type table. + + + + + Corresponds to the PostgreSQL "tid" type, a tuple id identifying the physical location of a row within its table. + + + + + Corresponds to the PostgreSQL "pg_lsn" type, which can be used to store LSN (Log Sequence Number) data which + is a pointer to a location in the WAL. + + + See: https://www.postgresql.org/docs/current/datatype-pg-lsn.html and + https://git.postgresql.org/gitweb/?p=postgresql.git;a=commit;h=7d03a83f4d0736ba869fa6f93973f7623a27038a + + + + + A special value that can be used to send parameter values to the database without + specifying their type, allowing the database to cast them to another value based on context. + The value will be converted to a string and send as text. + + + This value shouldn't ordinarily be used, and makes sense only when sending a data type + unsupported by Npgsql. + + + + + The geometry type for PostgreSQL spatial extension PostGIS. + + + + + The geography (geodetic) type for PostgreSQL spatial extension PostGIS. + + + + + The PostgreSQL ltree type, each value is a label path "a.label.tree.value", forming a tree in a set. + + See http://www.postgresql.org/docs/current/static/ltree.html + + + + The PostgreSQL lquery type for PostgreSQL extension ltree + + See http://www.postgresql.org/docs/current/static/ltree.html + + + + The PostgreSQL ltxtquery type for PostgreSQL extension ltree + + See http://www.postgresql.org/docs/current/static/ltree.html + + + + Represents a built-in PostgreSQL type as it appears in pg_type, including its name and OID. + Extension types with variable OIDs are not represented. + + + + + Wraps a PostgreSQL Write-Ahead Log Sequence Number (see: https://www.postgresql.org/docs/current/datatype-pg-lsn.html) + + + Log Sequence Numbers are a fundamental concept of the PostgreSQL Write-Ahead Log and by that of + PostgreSQL replication. See https://www.postgresql.org/docs/current/wal-internals.html for what they represent. + + This struct provides conversions from/to and and beyond that tries to port + the methods and operators in https://git.postgresql.org/gitweb/?p=postgresql.git;a=blob;f=src/backend/utils/adt/pg_lsn.c + but nothing more. + + + + + Zero is used indicate an invalid Log Sequence Number. No XLOG record can begin at zero. + + + + + Initializes a new instance of . + + The value to wrap. + + + + Returns a value indicating whether this instance is equal to a specified + instance. + + A instance to compare to this instance. + if the current instance is equal to the value parameter; + otherwise, . + + + + Compares this instance to a specified and returns an indication of their + relative values. + + A instance to compare to this instance. + A signed number indicating the relative values of this instance and . + + + + Returns a value indicating whether this instance is equal to a specified object. + + An object to compare to this instance + if the current instance is equal to the value parameter; + otherwise, . + + + + Returns the hash code for this instance. + + A 32-bit signed integer hash code. + + + + Converts the numeric value of this instance to its equivalent string representation. + + The string representation of the value of this instance, consisting of two hexadecimal numbers of + up to 8 digits each, separated by a slash + + + + Converts the string representation of a Log Sequence Number to a instance. + + A string that represents the Log Sequence Number to convert. + + A equivalent to the Log Sequence Number specified in . + + The parameter is . + + The parameter represents a number less than or greater than + . + + The parameter is not in the right format. + + + + Converts the span representation of a Log Sequence Number to a instance. + + A span containing the characters that represent the Log Sequence Number to convert. + + A equivalent to the Log Sequence Number specified in . + + + The parameter represents a number less than or greater than + . + + The parameter is not in the right format. + + + + Tries to convert the string representation of a Log Sequence Number to an + instance. A return value indicates whether the conversion succeeded or failed. + + A string that represents the Log Sequence Number to convert. + + When this method returns, contains a instance equivalent to the Log Sequence + Number contained in , if the conversion succeeded, or the default value for + (0) if the conversion failed. The conversion fails if the + parameter is or , is not in the right format, or represents a number + less than or greater than . This parameter is + passed uninitialized; any value originally supplied in result will be overwritten. + + + if c> was converted successfully; otherwise, . + + + + + Tries to convert the span representation of a Log Sequence Number to an + instance. A return value indicates whether the conversion succeeded or failed. + + A span containing the characters that represent the Log Sequence Number to convert. + + When this method returns, contains a instance equivalent to the Log Sequence + Number contained in , if the conversion succeeded, or the default value for + (0) if the conversion failed. The conversion fails if the + parameter is empty, is not in the right format, or represents a number less than + or greater than . This parameter is passed + uninitialized; any value originally supplied in result will be overwritten. + + + if was converted successfully; otherwise, . + + + + Converts the value of a 64-bit unsigned integer to a instance. + + A 64-bit unsigned integer. + A new instance of initialized to . + + + + Converts the value of a instance to a 64-bit unsigned integer value. + + A instance + The contents of as 64-bit unsigned integer. + + + + Returns a value that indicates whether two specified instances of are equal. + + The first Log Sequence Number to compare. + The second Log Sequence Number to compare. + + if equals ; otherwise, . + + + + + Returns a value that indicates whether two specified instances of are not + equal. + + The first Log Sequence Number to compare. + The second Log Sequence Number to compare. + + if does not equal ; otherwise, + . + + + + + Returns a value indicating whether a specified instance is greater than + another specified instance. + + The first value to compare. + The second value to compare. + + if is greater than ; otherwise, + . + + + + + Returns a value indicating whether a specified instance is less than + another specified instance. + + The first value to compare. + The second value to compare. + + if is less than ; otherwise, + . + + + + + Returns a value indicating whether a specified instance is greater than or + equal to another specified instance. + + The first value to compare. + The second value to compare. + + if is greater than or equal to ; + otherwise, . + + + + + Returns the larger of two values. + + The first value to compare. + The second value to compare. + + The larger of the two values. + + + + + Returns the smaller of two values. + + The first value to compare. + The second value to compare. + + The smaller of the two values. + + + + + Returns a value indicating whether a specified instance is less than or + equal to another specified instance. + + The first value to compare. + The second value to compare. + + if is less than or equal to ; + otherwise, . + + + + + Subtracts two specified values. + + The first value. + The second value. + The number of bytes separating those write-ahead log locations. + + + + Subtract the number of bytes from a instance, giving a new + instance. + Handles both positive and negative numbers of bytes. + + + The instance representing a write-ahead log location. + + The number of bytes to subtract. + A new instance. + + The resulting instance would represent a number less than + . + + + + + Add the number of bytes to a instance, giving a new + instance. + Handles both positive and negative numbers of bytes. + + + The instance representing a write-ahead log location. + + The number of bytes to add. + A new instance. + + The resulting instance would represent a number greater than + . + + + + + Represents a PostgreSQL range type. + + The element type of the values in the range. + + See: https://www.postgresql.org/docs/current/static/rangetypes.html + + + + + Defined by PostgreSQL to represent an empty range. + + + + + Defined by PostgreSQL to represent an infinite lower bound. + Some element types may have specific handling for this value distinct from a missing or null value. + + + + + Defined by PostgreSQL to represent an infinite upper bound. + Some element types may have specific handling for this value distinct from a missing or null value. + + + + + Defined by PostgreSQL to represent an null bound. + Some element types may have specific handling for this value distinct from an infinite or missing value. + + + + + Defined by PostgreSQL to represent a lower inclusive bound. + + + + + Defined by PostgreSQL to represent a lower exclusive bound. + + + + + Defined by PostgreSQL to represent an upper inclusive bound. + + + + + Defined by PostgreSQL to represent an upper exclusive bound. + + + + + Defined by PostgreSQL to separate the values for the upper and lower bounds. + + + + + The used by to convert bounds into . + + + + + True if implements ; otherwise, false. + + + + + Represents the empty range. This field is read-only. + + + + + The lower bound of the range. Only valid when is false. + + + + + The upper bound of the range. Only valid when is false. + + + + + The characteristics of the boundaries. + + + + + True if the lower bound is part of the range (i.e. inclusive); otherwise, false. + + + + + True if the upper bound is part of the range (i.e. inclusive); otherwise, false. + + + + + True if the lower bound is indefinite (i.e. infinite or unbounded); otherwise, false. + + + + + True if the upper bound is indefinite (i.e. infinite or unbounded); otherwise, false. + + + + + True if the range is empty; otherwise, false. + + + + + Constructs an with inclusive and definite bounds. + + The lower bound of the range. + The upper bound of the range. + + + + Constructs an with definite bounds. + + The lower bound of the range. + True if the lower bound is is part of the range (i.e. inclusive); otherwise, false. + The upper bound of the range. + True if the upper bound is part of the range (i.e. inclusive); otherwise, false. + + + + Constructs an . + + The lower bound of the range. + True if the lower bound is is part of the range (i.e. inclusive); otherwise, false. + True if the lower bound is indefinite (i.e. infinite or unbounded); otherwise, false. + The upper bound of the range. + True if the upper bound is part of the range (i.e. inclusive); otherwise, false. + True if the upper bound is indefinite (i.e. infinite or unbounded); otherwise, false. + + + + Constructs an . + + The lower bound of the range. + The upper bound of the range. + The characteristics of the range boundaries. + + + + Attempts to determine if the range is malformed or implicitly empty. + + The lower bound of the range. + The upper bound of the range. + The characteristics of the range boundaries. + + True if the range is implicitly empty; otherwise, false. + + + + + Evaluates the boundary flags. + + True if the lower bound is is part of the range (i.e. inclusive); otherwise, false. + True if the lower bound is indefinite (i.e. infinite or unbounded); otherwise, false. + True if the upper bound is part of the range (i.e. inclusive); otherwise, false. + True if the upper bound is indefinite (i.e. infinite or unbounded); otherwise, false. + + The boundary characteristics. + + + + + Indicates whether the on the left is equal to the on the right. + + The on the left. + The on the right. + + True if the on the left is equal to the on the right; otherwise, false. + + + + + Indicates whether the on the left is not equal to the on the right. + + The on the left. + The on the right. + + True if the on the left is not equal to the on the right; otherwise, false. + + + + + + + + + + + + + + + + + Parses the well-known text representation of a PostgreSQL range type into a . + + A PosgreSQL range type in a well-known text format. + + The represented by the . + + + Malformed range literal. + + + Malformed range literal. Missing left parenthesis or bracket. + + + Malformed range literal. Missing right parenthesis or bracket. + + + Malformed range literal. Missing comma after lower bound. + + + See: https://www.postgresql.org/docs/current/static/rangetypes.html + + + + + Represents a type converter for . + + + + + Adds a to the closed form . + + + + + + + + + + + + + + + + + Represents characteristics of range type boundaries. + + + See: https://www.postgresql.org/docs/current/static/rangetypes.html + + + + + The default flag. The range is not empty and has boundaries that are definite and exclusive. + + + + + The range is empty. E.g. '(0,0)', 'empty'. + + + + + The lower bound is inclusive. E.g. '[0,5]', '[0,5)', '[0,)'. + + + + + The upper bound is inclusive. E.g. '[0,5]', '(0,5]', '(,5]'. + + + + + The lower bound is infinite or indefinite. E.g. '(null,5]', '(-infinity,5]', '(,5]'. + + + + + The upper bound is infinite or indefinite. E.g. '[0,null)', '[0,infinity)', '[0,)'. + + + + + Both the lower and upper bounds are inclusive. + + + + + Both the lower and upper bounds are indefinite. + + + + + The lower bound is both inclusive and indefinite. This represents an error condition. + + + + + The upper bound is both inclusive and indefinite. This represents an error condition. + + + + + Represents the PostgreSQL interval datatype. + + PostgreSQL differs from .NET in how it's interval type doesn't assume 24 hours in a day + (to deal with 23- and 25-hour days caused by daylight savings adjustments) and has a concept + of months that doesn't exist in .NET's class. (Neither datatype + has any concessions for leap-seconds). + For most uses just casting to and from TimeSpan will work correctly — in particular, + the results of subtracting one or the PostgreSQL date, time and + timestamp types from another should be the same whether you do so in .NET or PostgreSQL — + but if the handling of days and months in PostgreSQL is important to your application then you + should use this class instead of . + If you don't know whether these differences are important to your application, they + probably arent! Just use and do not use this class directly ☺ + To avoid forcing unnecessary provider-specific concerns on users who need not be concerned + with them a call to on a field containing an + value will return a rather than an + . If you need the extra functionality of + then use . + + + + + + + + + Represents the number of ticks (100ns periods) in one microsecond. This field is constant. + + + + + Represents the number of ticks (100ns periods) in one millisecond. This field is constant. + + + + + Represents the number of ticks (100ns periods) in one second. This field is constant. + + + + + Represents the number of ticks (100ns periods) in one minute. This field is constant. + + + + + Represents the number of ticks (100ns periods) in one hour. This field is constant. + + + + + Represents the number of ticks (100ns periods) in one day. This field is constant. + + + + + Represents the number of hours in one day (assuming no daylight savings adjustments). This field is constant. + + + + + Represents the number of days assumed in one month if month justification or unjustifcation is performed. + This is set to 30 for consistency with PostgreSQL. Note that this is means that month adjustments cause + a year to be taken as 30 × 12 = 360 rather than 356/366 days. + + + + + Represents the number of ticks (100ns periods) in one day, assuming 30 days per month. + + + + + Represents the number of months in a year. This field is constant. + + + + + Represents the maximum . This field is read-only. + + + + + Represents the minimum . This field is read-only. + + + + + Represents the zero . This field is read-only. + + + + + Initializes a new to the specified number of ticks. + + A time period expressed in 100ns units. + + + + Initializes a new to hold the same time as a + + A time period expressed in a + + + + Initializes a new to the specified number of months, days + & ticks. + + Number of months. + Number of days. + Number of 100ns units. + + + + Initializes a new to the specified number of + days, hours, minutes & seconds. + + Number of days. + Number of hours. + Number of minutes. + Number of seconds. + + + + Initializes a new to the specified number of + days, hours, minutes, seconds & milliseconds. + + Number of days. + Number of hours. + Number of minutes. + Number of seconds. + Number of milliseconds. + + + + Initializes a new to the specified number of + months, days, hours, minutes, seconds & milliseconds. + + Number of months. + Number of days. + Number of hours. + Number of minutes. + Number of seconds. + Number of milliseconds. + + + + Initializes a new to the specified number of + years, months, days, hours, minutes, seconds & milliseconds. + Years are calculated exactly equivalent to 12 months. + + Number of years. + Number of months. + Number of days. + Number of hours. + Number of minutes. + Number of seconds. + Number of milliseconds. + + + + The total number of ticks(100ns units) contained. This is the resolution of the + type. This ignores the number of days and + months held. If you want them included use first. + The resolution of the PostgreSQL + interval type is by default 1µs = 1,000 ns. It may be smaller as follows: + + + interval(0) + resolution of 1s (1 second) + + + interval(1) + resolution of 100ms = 0.1s (100 milliseconds) + + + interval(2) + resolution of 10ms = 0.01s (10 milliseconds) + + + interval(3) + resolution of 1ms = 0.001s (1 millisecond) + + + interval(4) + resolution of 100µs = 0.0001s (100 microseconds) + + + interval(5) + resolution of 10µs = 0.00001s (10 microseconds) + + + interval(6) or interval + resolution of 1µs = 0.000001s (1 microsecond) + + + As such, if the 100-nanosecond resolution is significant to an application, a PostgreSQL interval will + not suffice for those purposes. + In more frequent cases though, the resolution of the interval suffices. + will always suffice to handle the resolution of any interval value, and upon + writing to the database, will be rounded to the resolution used. + + The number of ticks in the instance. + + + + + Gets the number of whole microseconds held in the instance. + An in the range [-999999, 999999]. + + + + + Gets the number of whole milliseconds held in the instance. + An in the range [-999, 999]. + + + + + Gets the number of whole seconds held in the instance. + An in the range [-59, 59]. + + + + + Gets the number of whole minutes held in the instance. + An in the range [-59, 59]. + + + + + Gets the number of whole hours held in the instance. + Note that this can be less than -23 or greater than 23 unless + has been used to produce this instance. + + + + + Gets the number of days held in the instance. + Note that this does not pay attention to a time component with -24 or less hours or + 24 or more hours, unless has been called to produce this instance. + + + + + Gets the number of months held in the instance. + Note that this does not pay attention to a day component with -30 or less days or + 30 or more days, unless has been called to produce this instance. + + + + + Returns a representing the time component of the instance. + Note that this may have a value beyond the range ±23:59:59.9999999 unless + has been called to produce this instance. + + + + + The total number of ticks (100ns units) in the instance, assuming 24 hours in each day and + 30 days in a month. + + + + + The total number of microseconds in the instance, assuming 24 hours in each day and + 30 days in a month. + + + + + The total number of milliseconds in the instance, assuming 24 hours in each day and + 30 days in a month. + + + + + The total number of seconds in the instance, assuming 24 hours in each day and + 30 days in a month. + + + + + The total number of minutes in the instance, assuming 24 hours in each day and + 30 days in a month. + + + + + The total number of hours in the instance, assuming 24 hours in each day and + 30 days in a month. + + + + + The total number of days in the instance, assuming 24 hours in each day and + 30 days in a month. + + + + + The total number of months in the instance, assuming 24 hours in each day and + 30 days in a month. + + + + + Creates an from a number of ticks. + + The number of ticks (100ns units) in the interval. + A d with the given number of ticks. + + + + Creates an from a number of microseconds. + + The number of microseconds in the interval. + A d with the given number of microseconds. + + + + Creates an from a number of milliseconds. + + The number of milliseconds in the interval. + A d with the given number of milliseconds. + + + + Creates an from a number of seconds. + + The number of seconds in the interval. + A d with the given number of seconds. + + + + Creates an from a number of minutes. + + The number of minutes in the interval. + A d with the given number of minutes. + + + + Creates an from a number of hours. + + The number of hours in the interval. + A d with the given number of hours. + + + + Creates an from a number of days. + + The number of days in the interval. + A d with the given number of days. + + + + Creates an from a number of months. + + The number of months in the interval. + A d with the given number of months. + + + + Adds another interval to this instance and returns the result. + + An to add to this instance. + An whose values are the sums of the two instances. + + + + Subtracts another interval from this instance and returns the result. + + An to subtract from this instance. + An whose values are the differences of the two instances. + + + + Returns an whose value is the negated value of this instance. + + An whose value is the negated value of this instance. + + + + This absolute value of this instance. In the case of some, but not all, components being negative, + the rules used for justification are used to determine if the instance is positive or negative. + + An whose value is the absolute value of this instance. + + + + Equivalent to PostgreSQL's justify_days function. + + An based on this one, but with any hours outside of the range [-23, 23] + converted into days. + + + + Opposite to PostgreSQL's justify_days function. + + An based on this one, but with any days converted to multiples of ±24hours. + + + + Equivalent to PostgreSQL's justify_months function. + + An based on this one, but with any days outside of the range [-30, 30] + converted into months. + + + + Opposite to PostgreSQL's justify_months function. + + An based on this one, but with any months converted to multiples of ±30days. + + + + Equivalent to PostgreSQL's justify_interval function. + + An based on this one, + but with any months converted to multiples of ±30days + and then with any days converted to multiples of ±24hours + + + + Opposite to PostgreSQL's justify_interval function. + + An based on this one, but with any months converted to multiples of ±30days and then any days converted to multiples of ±24hours; + + + + Produces a canonical NpgslInterval with 0 months and hours in the range of [-23, 23]. + + + While the fact that for many purposes, two different instances could be considered + equivalent (e.g. one with 2days, 3hours and one with 1day 27hours) there are different possible canonical forms. + + E.g. we could move all excess hours into days and all excess days into months and have the most readable form, + or we could move everything into the ticks and have the form that allows for the easiest arithmetic) the form + chosen has two important properties that make it the best choice. + First, it is closest two how + objects are most often represented. Second, it is compatible with results of many + PostgreSQL functions, particularly with age() and the results of subtracting one date, time or timestamp from + another. + + Note that the results of casting a to is + canonicalised. + + + An based on this one, but with months converted to multiples of ±30days and with any hours outside of the range [-23, 23] + converted into days. + + + + Implicit cast of a to an + + A + An eqivalent, canonical, . + + + + Casts a to an . + + + + + Explicit cast of an to a . + + A . + An equivalent . + + + + Casts an to a . + + + + + Returns true if another is exactly the same as this instance. + + An for comparison. + true if the two instances are exactly the same, + false otherwise. + + + + Returns true if another object is an , that is exactly the same as + this instance + + An for comparison. + true if the argument is an and is exactly the same + as this one, false otherwise. + + + + Compares two instances. + + The first . + The second . + 0 if the two are equal or equivalent. A value greater than zero if x is greater than y, + a value less than zero if x is less than y. + + + + A hash code suitable for uses with hashing algorithms. + + An signed integer. + + + + Compares this instance with another/ + + An to compare this with. + 0 if the instances are equal or equivalent. A value less than zero if + this instance is less than the argument. A value greater than zero if this instance + is greater than the instance. + + + + Compares this instance with another/ + + An object to compare this with. + 0 if the argument is an and the instances are equal or equivalent. + A value less than zero if the argument is an and + this instance is less than the argument. + A value greater than zero if the argument is an and this instance + is greater than the instance. + A value greater than zero if the argument is null. + The argument is not an . + + + + Parses a and returns a instance. + Designed to use the formats generally returned by PostgreSQL. + + The to parse. + An represented by the argument. + The string was null. + A value obtained from parsing the string exceeded the values allowed for the relevant component. + The string was not in a format that could be parsed to produce an . + + + + Attempt to parse a to produce an . + + The to parse. + (out) The produced, or if the parsing failed. + true if the parsing succeeded, false otherwise. + + + + Create a representation of the instance. + The format returned is of the form: + [M mon[s]] [d day[s]] [HH:mm:ss[.f[f[f[f[f[f[f[f[f]]]]]]]]]] + A zero is represented as 00:00:00 + + Ticks are 100ns, Postgress resolution is only to 1µs at most. Hence we lose 1 or more decimal + precision in storing values in the database. Despite this, this method will output that extra + digit of precision. It's forward-compatible with any future increases in resolution up to 100ns, + and also makes this ToString() more applicable to any other use-case. + + + The representation. + + + + Adds two together. + + The first to add. + The second to add. + An whose values are the sum of the arguments. + + + + Subtracts one from another. + + The to subtract the other from. + The to subtract from the other. + An whose values are the difference of the arguments + + + + Returns true if two are exactly the same. + + The first to compare. + The second to compare. + true if the two arguments are exactly the same, false otherwise. + + + + Returns false if two are exactly the same. + + The first to compare. + The second to compare. + false if the two arguments are exactly the same, true otherwise. + + + + Compares two instances to see if the first is less than the second + + The first to compare. + The second to compare. + true if the first is less than second, false otherwise. + + + + Compares two instances to see if the first is less than or equivalent to the second + + The first to compare. + The second to compare. + true if the first is less than or equivalent to second, false otherwise. + + + + Compares two instances to see if the first is greater than the second + + The first to compare. + The second to compare. + true if the first is greater than second, false otherwise. + + + + Compares two instances to see if the first is greater than or equivalent the second + + The first to compare. + The second to compare. + true if the first is greater than or equivalent to the second, false otherwise. + + + + Returns the instance. + + + + + Returns the instance. + + + + + Negates an instance. + + An . + The negation of the argument. + + + + Represents a PostgreSQL tsquery. This is the base class for the + lexeme, not, or, and, and "followed by" nodes. + + + + + Node kind + + + + + NodeKind + + + + + Represents the empty tsquery. Should only be used at top level. + + + + + Lexeme + + + + + Not operator + + + + + And operator + + + + + Or operator + + + + + "Followed by" operator + + + + + Constructs an . + + + + + + Writes the tsquery in PostgreSQL's text format. + + + + + + Parses a tsquery in PostgreSQL's text format. + + + + + + + TsQuery Lexeme node. + + + + + Lexeme text. + + + + + Weights is a bitmask of the Weight enum. + + + + + Prefix search. + + + + + Creates a tsquery lexeme with only lexeme text. + + Lexeme text. + + + + Creates a tsquery lexeme with lexeme text and weights. + + Lexeme text. + Bitmask of enum Weight. + + + + Creates a tsquery lexeme with lexeme text, weights and prefix search flag. + + Lexeme text. + Bitmask of enum Weight. + Is prefix search? + + + + Weight enum, can be OR'ed together. + + + + + None + + + + + D + + + + + C + + + + + B + + + + + A + + + + + TsQuery Not node. + + + + + Child node + + + + + Creates a not operator, with a given child node. + + + + + + Base class for TsQuery binary operators (& and |). + + + + + Left child + + + + + Right child + + + + + Constructs a . + + + + + TsQuery And node. + + + + + Creates an and operator, with two given child nodes. + + + + + + + TsQuery Or Node. + + + + + Creates an or operator, with two given child nodes. + + + + + + + TsQuery "Followed by" Node. + + + + + The distance between the 2 nodes, in lexemes. + + + + + Creates a "followed by" operator, specifying 2 child nodes and the + distance between them in lexemes. + + + + + + + + Represents an empty tsquery. Shold only be used as top node. + + + + + Creates a tsquery that represents an empty query. Should not be used as child node. + + + + + Represents a PostgreSQL tsvector. + + + + + Parses a tsvector in PostgreSQL's text format. + + + + + + + Returns the lexeme at a specific index + + + + + + + Gets the number of lexemes. + + + + + Returns an enumerator. + + + + + + Returns an enumerator. + + + + + + Gets a string representation in PostgreSQL's format. + + + + + + Represents a lexeme. A lexeme consists of a text string and optional word entry positions. + + + + + Gets or sets the text. + + + + + Creates a lexeme with no word entry positions. + + + + + + Creates a lexeme with word entry positions. + + + + + + + Gets a word entry position. + + + + + + + Gets the number of word entry positions. + + + + + Creates a string representation in PostgreSQL's format. + + + + + + Represents a word entry position and an optional weight. + + + + + Creates a WordEntryPos with a given position and weight. + + Position values can range from 1 to 16383; larger numbers are silently set to 16383. + A weight labeled between A and D. + + + + The weight is labeled from A to D. D is the default, and not printed. + + + + + The position is a 14-bit unsigned integer indicating the position in the text this lexeme occurs. Cannot be 0. + + + + + Prints this lexeme in PostgreSQL's format, i.e. position is followed by weight (weight is only printed if A, B or C). + + + + + + Determines whether the specified object is equal to the current object. + + + + + Determines whether the specified object is equal to the current object. + + + + + Gets a hash code for the current object. + + + + + Determines whether the specified object is equal to the current object. + + + + + Determines whether the specified object is unequal to the current object. + + + + + The weight is labeled from A to D. D is the default, and not printed. + + + + + D, the default + + + + + C + + + + + B + + + + + A + + + + + Determines whether the specified object is equal to the current object. + + + + + Determines whether the specified object is equal to the current object. + + + + + Gets a hash code for the current object. + + + + + Determines whether the specified object is equal to the current object. + + + + + Determines whether the specified object is unequal to the current object. + + + + + Represents a PostgreSQL point type. + + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html + + + + + Represents a PostgreSQL line type. + + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html + + + + + Represents a PostgreSQL Line Segment type. + + + + + Represents a PostgreSQL box type. + + + See https://www.postgresql.org/docs/current/static/datatype-geometric.html + + + + + Represents a PostgreSQL Path type. + + + + + Represents a PostgreSQL Polygon type. + + + + + Represents a PostgreSQL Circle type. + + + + + Represents a PostgreSQL inet type, which is a combination of an IPAddress and a + subnet mask. + + + https://www.postgresql.org/docs/current/static/datatype-net-types.html + + + + + Represents a PostgreSQL tid value + + + https://www.postgresql.org/docs/current/static/datatype-oid.html + + + + + Block number + + + + + Tuple index within block + + + + + Indicates that this property or field correspond to a PostgreSQL field with the specified name + + + + + The name of PostgreSQL field that corresponds to this CLR property or field + + + + + Indicates that this property or field correspond to a PostgreSQL field with the specified name + + The name of PostgreSQL field that corresponds to this CLR property or field + + + + Indicates that the value of the marked element could be null sometimes, + so the check for null is necessary before its usage. + + + [CanBeNull] public object Test() { return null; } + public void UseTest() { + var p = Test(); + var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' + } + + + + + Indicates that the value of the marked element could never be null. + + + [NotNull] public object Foo() { + return null; // Warning: Possible 'null' assignment + } + + + + + Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task + and Lazy classes to indicate that the value of a collection item, of the Task.Result property + or of the Lazy.Value property can never be null. + + + + + Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task + and Lazy classes to indicate that the value of a collection item, of the Task.Result property + or of the Lazy.Value property can be null. + + + + + Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), + so this symbol will not be marked as unused (as well as by other usage inspections). + + + + + Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes + as unused (as well as by other usage inspections) + + + + Only entity marked with attribute considered used. + + + Indicates implicit assignment to a member. + + + + Indicates implicit instantiation of a type with fixed constructor signature. + That means any unused constructor parameters won't be reported as such. + + + + Indicates implicit instantiation of a type. + + + + Specify what is considered used implicitly when marked + with or . + + + + Members of entity marked with attribute are considered used. + + + Entity marked with attribute and all its members considered used. + + + + Describes dependency between method input and output. + + +

Function Definition Table syntax:

+ + FDT ::= FDTRow [;FDTRow]* + FDTRow ::= Input => Output | Output <= Input + Input ::= ParameterName: Value [, Input]* + Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} + Value ::= true | false | null | notnull | canbenull + + If method has single input parameter, it's name could be omitted.
+ Using halt (or void/nothing, which is the same) + for method output means that the methos doesn't return normally.
+ canbenull annotation is only applicable for output parameters.
+ You can use multiple [ContractAnnotation] for each FDT row, + or use single attribute with rows separated by semicolon.
+
+ + + [ContractAnnotation("=> halt")] + public void TerminationMethod() + + + [ContractAnnotation("halt <= condition: false")] + public void Assert(bool condition, string text) // regular assertion method + + + [ContractAnnotation("s:null => true")] + public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() + + + // A method that returns null if the parameter is null, + // and not null if the parameter is not null + [ContractAnnotation("null => null; notnull => notnull")] + public object Transform(object data) + + + [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] + public bool TryParse(string s, out Person result) + + +
+ + + Indicates that the function argument should be string literal and match one + of the parameters of the caller function. For example, ReSharper annotates + the parameter of . + + + public void Foo(string param) { + if (param == null) + throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol + } + + + + + Indicates that IEnumerable, passed as parameter, is not enumerated. + + +
+
diff --git a/app_data/jobs/triggered/utility/Syncfusion.Server.Base.Encryption.dll b/app_data/jobs/triggered/utility/Syncfusion.Server.Base.Encryption.dll new file mode 100644 index 000000000..116a6eb98 Binary files /dev/null and b/app_data/jobs/triggered/utility/Syncfusion.Server.Base.Encryption.dll differ diff --git a/app_data/jobs/triggered/utility/Syncfusion.Server.Base.Logger.dll b/app_data/jobs/triggered/utility/Syncfusion.Server.Base.Logger.dll new file mode 100644 index 000000000..0f4eac84b Binary files /dev/null and b/app_data/jobs/triggered/utility/Syncfusion.Server.Base.Logger.dll differ diff --git a/app_data/jobs/triggered/utility/System.Buffers.dll b/app_data/jobs/triggered/utility/System.Buffers.dll new file mode 100644 index 000000000..f2d83c514 Binary files /dev/null and b/app_data/jobs/triggered/utility/System.Buffers.dll differ diff --git a/app_data/jobs/triggered/utility/System.Buffers.xml b/app_data/jobs/triggered/utility/System.Buffers.xml new file mode 100644 index 000000000..e243dcef9 --- /dev/null +++ b/app_data/jobs/triggered/utility/System.Buffers.xml @@ -0,0 +1,38 @@ + + + System.Buffers + + + + Provides a resource pool that enables reusing instances of type . + The type of the objects that are in the resource pool. + + + Initializes a new instance of the class. + + + Creates a new instance of the class. + A new instance of the class. + + + Creates a new instance of the class using the specifed configuration. + The maximum length of an array instance that may be stored in the pool. + The maximum number of array instances that may be stored in each bucket in the pool. The pool groups arrays of similar lengths into buckets for faster access. + A new instance of the class with the specified configuration. + + + Retrieves a buffer that is at least the requested length. + The minimum length of the array. + An array of type that is at least minimumLength in length. + + + Returns an array to the pool that was previously obtained using the method on the same instance. + A buffer to return to the pool that was previously obtained using the method. + Indicates whether the contents of the buffer should be cleared before reuse. If clearArray is set to true, and if the pool will store the buffer to enable subsequent reuse, the method will clear the array of its contents so that a subsequent caller using the method will not see the content of the previous caller. If clearArray is set to false or if the pool will release the buffer, the array&#39;s contents are left unchanged. + + + Gets a shared instance. + A shared instance. + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/System.Configuration.ConfigurationManager.dll b/app_data/jobs/triggered/utility/System.Configuration.ConfigurationManager.dll new file mode 100644 index 000000000..16fff01b5 Binary files /dev/null and b/app_data/jobs/triggered/utility/System.Configuration.ConfigurationManager.dll differ diff --git a/app_data/jobs/triggered/utility/System.Configuration.ConfigurationManager.xml b/app_data/jobs/triggered/utility/System.Configuration.ConfigurationManager.xml new file mode 100644 index 000000000..d59520dc0 --- /dev/null +++ b/app_data/jobs/triggered/utility/System.Configuration.ConfigurationManager.xml @@ -0,0 +1,5300 @@ + + + + System.Configuration.ConfigurationManager + + + + Specifies that an application settings property has a common value for all users of an application. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Acts as a base class for deriving concrete wrapper classes to implement the application settings feature in Window Forms applications. + + + Occurs after the value of an application settings property is changed. + + + Occurs before the value of an application settings property is changed. + + + Occurs after the application settings are retrieved from storage. + + + Occurs before values are saved to the data store. + + + Initializes an instance of the class to its default state. + + + Initializes an instance of the class using the supplied owner component. + The component that will act as the owner of the application settings object. + + is . + + + Initializes an instance of the class using the supplied owner component and settings key. + The component that will act as the owner of the application settings object. + A that uniquely identifies separate instances of the wrapper class. + + is . + + + Initializes an instance of the class using the supplied settings key. + A that uniquely identifies separate instances of the wrapper class. + + + Returns the value of the named settings property for the previous version of the same application. + A containing the name of the settings property whose value is to be returned. + The property does not exist. The property count is zero or the property cannot be found in the data store. + An containing the value of the specified if found; otherwise, . + + + Raises the event. + The source of the event. + A that contains the event data. + + + Raises the event. + The source of the event. + A that contains the event data. + + + Raises the event. + The source of the event. + A that contains the event data. + + + Raises the event. + The source of the event. + A that contains the event data. + + + Refreshes the application settings property values from persistent storage. + + + Restores the persisted application settings values to their corresponding default properties. + The configuration file could not be parsed. + + + Stores the current values of the application settings properties. + + + Updates application settings to reflect a more recent installation of the application. + The configuration file could not be parsed. + + + Gets the application settings context associated with the settings group. + A associated with the settings group. + + + Gets or sets the value of the specified application settings property. + A containing the name of the property to access. + There are no properties associated with the current wrapper or the specified property could not be found. + An attempt was made to set a read-only property. + The value supplied is of a type incompatible with the settings property, during a set operation. + The configuration file could not be parsed. + If found, the value of the named settings property; otherwise, . + + + Gets the collection of settings properties in the wrapper. + The associated settings provider could not be found or its instantiation failed. + A containing all the objects used in the current wrapper. + + + Gets a collection of property values. + A of property values. + + + Gets the collection of application settings providers used by the wrapper. + A containing all the objects used by the settings properties of the current settings wrapper. + + + Gets or sets the settings key for the application settings group. + A containing the settings key for the current settings group. + + + Represents a grouping of related application settings sections within a configuration file. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Provides a method for reading values of a particular type from the configuration. + + + Initializes a new instance of the class. + + + Gets the value for a specified key from the property and returns an object of the specified type containing the value from the configuration. + The key for which to get the value. + The type of the object to return. + + is . + +-or- + + is . + + does not exist in the configuration section. + +-or- + + The value in the configuration section for is not of type . + The value of the specified key. + + + Provides configuration system support for the configuration section. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Gets or sets a configuration file that provides additional settings or overrides the settings specified in the element. + A configuration file that provides additional settings or overrides the settings specified in the element. + + + Gets a collection of key/value pairs that contains application settings. + A collection of key/value pairs that contains the application settings from the configuration file. + + + Provides dynamic validation of an object. + + + Initializes a new instance of the class. + The type of object that will be validated. + The used as the delegate. + + is . + + + Determines whether the type of the object can be validated. + The type of object. + + if the parameter matches the type used as the first parameter when creating an instance of ; otherwise, . + + + Determines whether the value of an object is valid. + The value of an object. + + + Specifies a object to use for code validation. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Gets or sets the name of the callback method. + The name of the method to call. + + + Gets or sets the type of the validator. + The of the current validator attribute instance. + + + Gets the validator instance. + The value of the property is . + The property is not set to a public static void method with one object parameter. + The current instance. + + + Represents a group of user-scoped application settings in a configuration file. + + + Initializes a new instance of the class. + + + Gets the collection of client settings for the section. + A containing all the client settings found in the current configuration section. + + + Represents a collection of string elements separated by commas. This class cannot be inherited. + + + Creates a new instance of the class. + + + Adds a string to the comma-delimited collection. + A string value. + + + Adds all the strings in a string array to the collection. + An array of strings to add to the collection. + + + Clears the collection. + + + Creates a copy of the collection. + A copy of the . + + + Adds a string element to the collection at the specified index. + The index in the collection at which the new element will be added. + The value of the new element to add to the collection. + + + Removes a string element from the collection. + The string to remove. + + + Sets the collection object to read-only. + + + Returns a string representation of the object. + A string representation of the object. + + + Gets a value that specifies whether the collection has been modified. + + if the has been modified; otherwise, . + + + Gets a value indicating whether the collection object is read-only. + + if the specified string element in the is read-only; otherwise, . + + + Gets or sets a string element in the collection based on the index. + The index of the string element in the collection. + A string element in the collection. + + + Converts a comma-delimited string value to and from a object. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Converts a object to a object. + The used for type conversions. + The used during conversion. + The comma-separated to convert. + A containing the converted value. + + + Converts a object to a object. + The used for type conversions. + The used during conversion. + The value to convert. + The conversion type. + The representing the converted parameter, which is a . + + + Represents a configuration file that is applicable to a particular computer, application, or resource. This class cannot be inherited. + + + Returns the specified object. + The path to the section to be returned. + The specified object, or if the requested section does not exist. + + + Gets the specified object. + The path name of the to return. + The specified, or if the requested section group does not exist. + + + Writes the configuration settings contained within this object to the current XML configuration file. + The configuration file could not be written to. + +-or- + + The configuration file has changed. + + + Writes the configuration settings contained within this object to the current XML configuration file. + A value that determines which property values to save. + The configuration file could not be written to. + +-or- + + The configuration file has changed. + + + Writes the configuration settings contained within this object to the current XML configuration file. + A value that determines which property values to save. + + to save even if the configuration was not modified; otherwise, . + The configuration file could not be written to. + +-or- + + The configuration file has changed. + + + Writes the configuration settings contained within this object to the specified XML configuration file. + The path and file name to save the configuration file to. + The configuration file could not be written to. + +-or- + + The configuration file has changed. + + + Writes the configuration settings contained within this object to the specified XML configuration file. + The path and file name to save the configuration file to. + A value that determines which property values to save. + The configuration file could not be written to. + +-or- + + The configuration file has changed. + + + Writes the configuration settings contained within this object to the specified XML configuration file. + The path and file name to save the configuration file to. + A value that determines which property values to save. + + to save even if the configuration was not modified; otherwise, . + + is null or an empty string (""). + + + Gets the object configuration section that applies to this object. + An object representing the configuration section that applies to this object. + + + Specifies a function delegate that is used to transform assembly strings in configuration files. + A delegate that transforms type strings. The default value is . + + + Gets a configuration-section object that applies to this object. + A configuration-section object representing the configuration section that applies to this object. + + + Gets the object for the object. + The object for the object. + + + Gets the physical path to the configuration file represented by this object. + The physical path to the configuration file represented by this object. + + + Gets a value that indicates whether a file exists for the resource represented by this object. + + if there is a configuration file; otherwise, . + + + Gets the locations defined within this object. + A containing the locations defined within this object. + + + Gets or sets a value indicating whether the configuration file has an XML namespace. + + if the configuration file has an XML namespace; otherwise, . + + + Gets the root for this object. + The root section group for this object. + + + Gets a collection of the section groups defined by this configuration. + A collection representing the collection of section groups for this object. + + + Gets a collection of the sections defined by this object. + A collection of the sections defined by this object. + + + Specifies the targeted version of the .NET Framework when a version earlier than the current one is targeted. + The name of the targeted version of the .NET Framework. The default value is , which indicates that the current version is targeted. + + + Specifies a function delegate that is used to transform type strings in configuration files. + A delegate that transforms type strings. The default value is . + + + Specifies the locations within the configuration-file hierarchy that can set or override the properties contained within a object. + + + The can be defined anywhere. + + + The can be defined only in the Machine.config file. + + + The can be defined in either the Machine.config file, the machine-level Web.config file found in the same directory as Machine.config, or the top-level application Web.config file found in the virtual-directory root, but not in subdirectories of a virtual root. + + + The can be defined in either the Machine.config file or the machine-level Web.config file found in the same directory as Machine.config, but not in application Web.config files. + + + Specifies the locations within the configuration-file hierarchy that can set or override the properties contained within a object. + + + The can be defined only in the Machine.config file. + + + The can be defined either in the Machine.config file or in the Exe.config file in the client application directory. This is the default value. + + + The can be defined in the Machine.config file, in the Exe.config file in the client application directory, in the User.config file in the roaming user directory, or in the User.config file in the local user directory. + + + The can be defined in the Machine.config file, in the Exe.config file in the client application directory, or in the User.config file in the roaming user directory. + + + Declaratively instructs the .NET Framework to create an instance of a configuration element collection. This class cannot be inherited. + + + Initializes a new instance of the class. + The type of the property collection to create. + + is . + + + Gets or sets the name of the configuration element. + The name that substitutes the standard name "add" for the configuration item. + + + Gets or sets the name for the configuration element. + The name that replaces the standard name "clear" for the configuration item. + + + Gets or sets the type of the attribute. + The type of the . + + + Gets the type of the collection element. + The type of the collection element. + + + Gets or sets the name for the configuration element. + The name that replaces the standard name "remove" for the configuration element. + + + The base class for the configuration converter types. + + + Initializes a new instance of the class. + + + Determines whether the conversion is allowed. + The object used for type conversions. + The to convert from. + + if the conversion is allowed; otherwise, . + + + Determines whether the conversion is allowed. + The object used for type conversion. + The type to convert to. + + if the conversion is allowed; otherwise, . + + + Represents a configuration element within a configuration file. + + + Initializes a new instance of the class. + + + Reads XML from the configuration file. + The that reads from the configuration file. + + to serialize only the collection key properties; otherwise, . + The element to read is locked. + +-or- + + An attribute of the current node is not recognized. + +-or- + + The lock status of the current node cannot be determined. + + + Compares the current instance to the specified object. + The object to compare with. + + if the object to compare with is equal to the current instance; otherwise, . The default is . + + + Gets a unique value representing the current instance. + A unique value representing the current instance. + + + Returns the transformed version of the specified assembly name. + The name of the assembly. + The transformed version of the assembly name. If no transformer is available, the parameter value is returned unchanged. The property is if no transformer is available. + + + Returns the transformed version of the specified type name. + The name of the type. + The transformed version of the specified type name. If no transformer is available, the parameter value is returned unchanged. The property is if no transformer is available. + + + Sets the object to its initial state. + + + Used to initialize a default set of values for the object. + + + Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. + + if the element has been modified; otherwise, . + + + Gets a value indicating whether the object is read-only. + + if the object is read-only; otherwise, . + + + Adds the invalid-property errors in this object, and in all subelements, to the passed list. + An object that implements the interface. + + + Gets a value indicating whether an unknown attribute is encountered during deserialization. + The name of the unrecognized attribute. + The value of the unrecognized attribute. + + when an unknown attribute is encountered while deserializing; otherwise, . + + + Gets a value indicating whether an unknown element is encountered during deserialization. + The name of the unknown subelement. + The being used for deserialization. + The element identified by is locked. + +-or- + + One or more of the element's attributes is locked. + +-or- + + is unrecognized, or the element has an unrecognized attribute. + +-or- + + The element has a Boolean attribute with an invalid value. + +-or- + + An attempt was made to deserialize a property more than once. + +-or- + + An attempt was made to deserialize a property that is not a valid member of the element. + +-or- + + The element cannot contain a CDATA or text element. + + when an unknown element is encountered while deserializing; otherwise, . + + + Throws an exception when a required property is not found. + The name of the required attribute that was not found. + In all cases. + None. + + + Called after deserialization. + + + Called before serialization. + The that will be used to serialize the . + + + Resets the internal state of the object, including the locks and the properties collections. + The parent node of the configuration element. + + + Resets the value of the method to when implemented in a derived class. + + + Writes the contents of this configuration element to the configuration file when implemented in a derived class. + The that writes to the configuration file. + + to serialize only the collection key properties; otherwise, . + The current attribute is locked at a higher configuration level. + + if any data was actually serialized; otherwise, . + + + Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. + The that writes to the configuration file. + The name of the to be written. + The element has multiple child elements. + + if writing was successful; otherwise, . + + + Sets a property to the specified value. + The element property to set. + The value to assign to the property. + + if the locks on the property should be ignored; otherwise, . + Occurs if the element is read-only or is but the locks cannot be ignored. + + + Sets the property for the object and all subelements. + + + Modifies the object to remove all values that should not be saved. + A at the current level containing a merged view of the properties. + The parent , or if this is the top level. + One of the enumeration values that determines which property values to include. + + + Gets a reference to the top-level instance that represents the configuration hierarchy that the current instance belongs to. + The top-level instance that the current instance belongs to. + + + Gets an object that contains the non-customizable information and functionality of the object. + An that contains the non-customizable information and functionality of the . + + + Gets the object that represents the object itself. + The that represents the itself. + + + Gets the object for the object. + The current element is not associated with a context. + The for the . + + + Gets a value that indicates whether the property is . + false if the property is ; otherwise, . + + + Gets or sets a property or attribute of this configuration element. + The property to access. + + is or does not exist within the element. + + is read only or locked. + The specified property, attribute, or child element. + + + Gets or sets a property, attribute, or child element of this configuration element. + The name of the to access. + + is read-only or locked. + The specified property, attribute, or child element + + + Gets the collection of locked attributes. + The of locked attributes (properties) for the element. + + + Gets the collection of locked elements. + The of locked elements. + + + Gets the collection of locked attributes. + The of locked attributes (properties) for the element. + + + Gets the collection of locked elements. + The of locked elements. + + + Gets or sets a value indicating whether the element is locked. + The element has already been locked at a higher configuration level. + + if the element is locked; otherwise, . The default is . + + + Gets the collection of properties. + The of properties for the element. + + + Represents a configuration element containing a collection of child elements. + + + Initializes a new instance of the class. + + + Creates a new instance of the class. + The comparer to use. + + is . + + + Adds a configuration element to the . + The to add. + + + Adds a configuration element to the configuration element collection. + The to add. + + to throw an exception if the specified is already contained in the ; otherwise, . + The to add already exists in the and the parameter is . + + + Adds a configuration element to the configuration element collection. + The index location at which to add the specified . + The to add. + + + Removes all configuration element objects from the collection. + The configuration is read-only. + +-or- + + A collection item has been locked in a higher-level configuration. + + + Gets the configuration element at the specified index location. + The index location of the to return. + + is less than . + +-or- + + There is no at the specified . + The at the specified index. + + + Returns the configuration element with the specified key. + The key of the element to return. + The with the specified key; otherwise, . + + + Returns an array of the keys for all of the configuration elements contained in the . + An array that contains the keys for all of the objects contained in the . + + + Gets the key for the at the specified index location. + The index location for the . + + is less than . + +-or- + + There is no at the specified . + The key for the specified . + + + Indicates the index of the specified . + The for the specified index location. + The index of the specified ; otherwise, -1. + + + Indicates whether the with the specified key has been removed from the . + The key of the element to check. + + if the with the specified key has been removed; otherwise, . The default is . + + + Removes a from the collection. + The key of the to remove. + No with the specified key exists in the collection, the element has already been removed, or the element cannot be removed because the value of its is not . + + + Removes the at the specified index location. + The index location of the to remove. + The configuration is read-only. + +-or- + + is less than or greater than the number of objects in the collection. + +-or- + + The object has already been removed. + +-or- + + The value of the object has been locked at a higher level. + +-or- + + The object was inherited. + +-or- + + The value of the object's is not or . + + + Copies the contents of the to an array. + Array to which to copy the contents of the . + Index location at which to begin copying. + + + When overridden in a derived class, creates a new . + A newly created . + + + Creates a new when overridden in a derived class. + The name of the to create. + A new with a specified name. + + + Compares the to the specified object. + The object to compare. + + if the object to compare with is equal to the current instance; otherwise, . The default is . + + + Gets the element key for a specified configuration element when overridden in a derived class. + The to return the key for. + An that acts as the key for the specified . + + + Gets an which is used to iterate through the . + An which is used to iterate through the . + + + Gets a unique value representing the instance. + A unique value representing the current instance. + + + Indicates whether the specified exists in the . + The name of the element to verify. + + if the element exists in the collection; otherwise, . The default is . + + + Indicates whether the specified can be removed from the . + The element to check. + + if the specified can be removed from this ; otherwise, . The default is . + + + Indicates whether this has been modified since it was last saved or loaded when overridden in a derived class. + + if any contained element has been modified; otherwise, + + + Indicates whether the object is read only. + + if the object is read only; otherwise, . + + + Causes the configuration system to throw an exception. + The name of the unrecognized element. + An input stream that reads XML from the configuration file. + The element specified in is the element. + + starts with the reserved prefix "config" or "lock". + + if the unrecognized element was deserialized successfully; otherwise, . The default is . + + + Resets the to its unmodified state when overridden in a derived class. + The representing the collection parent element, if any; otherwise, . + + + Resets the value of the property to when overridden in a derived class. + + + Writes the configuration data to an XML element in the configuration file when overridden in a derived class. + Output stream that writes XML to the configuration file. + + to serialize the collection key; otherwise, . + One of the elements in the collection was added or replaced and starts with the reserved prefix "config" or "lock". + + if the was written to the configuration file successfully. + + + Sets the property for the object and for all sub-elements. + + + Copies the to an array. + Array to which to copy this . + Index location at which to begin copying. + + + Reverses the effect of merging configuration information from different levels of the configuration hierarchy. + A object at the current level containing a merged view of the properties. + The parent object of the current element, or if this is the top level. + One of the enumeration value that determines which property values to include. + + + Gets or sets the name of the to associate with the add operation in the when overridden in a derived class. + The selected value starts with the reserved prefix "config" or "lock". + The name of the element. + + + Gets or sets the name for the to associate with the clear operation in the when overridden in a derived class. + The selected value starts with the reserved prefix "config" or "lock". + The name of the element. + + + Gets the type of the . + The of this collection. + + + Gets the number of elements in the collection. + The number of elements in the collection. + + + Gets the name used to identify this collection of elements in the configuration file when overridden in a derived class. + The name of the collection; otherwise, an empty string. The default is an empty string. + + + Gets or sets a value that specifies whether the collection has been cleared. + The configuration is read-only. + + if the collection has been cleared; otherwise, . The default is . + + + Gets a value indicating whether access to the collection is synchronized. + + if access to the is synchronized; otherwise, . + + + Gets or sets the name of the to associate with the remove operation in the when overridden in a derived class. + The selected value starts with the reserved prefix "config" or "lock". + The name of the element. + + + Gets an object used to synchronize access to the . + An object used to synchronize access to the . + + + Gets a value indicating whether an attempt to add a duplicate to the will cause an exception to be thrown. + + if an attempt to add a duplicate to this will cause an exception to be thrown; otherwise, . + + + Specifies the type of a object. + + + The default type of . Collections of this type contain elements that can be merged across a hierarchy of configuration files. At any particular level within such a hierarchy, , , and directives are used to modify any inherited properties and specify new ones. + + + Same as , except that this type causes the object to sort its contents such that inherited elements are listed last. + + + Collections of this type contain elements that apply to the level at which they are specified, and to all child levels. A child level cannot modify the properties specified by a parent element of this type. + + + Same as , except that this type causes the object to sort its contents such that inherited elements are listed last. + + + Specifies the property of a configuration element. This class cannot be inherited. + + + Initializes a new instance of the class, based on a supplied parameter. + A object. + + is . + + + Gets a object used to validate the object. + A object. + + + The exception that is thrown when a configuration error has occurred. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class. + The object that holds the information to deserialize. + Contextual information about the source or destination. + The current type is not a or a . + + + Initializes a new instance of the class. + A message that describes why this exception was thrown. + + + Initializes a new instance of the class. + A message that describes why this exception was thrown. + The exception that caused this exception to be thrown. + + + Initializes a new instance of a class. + A message that describes why this exception was thrown. + The inner exception that caused this exception to be thrown. + The path to the configuration file that caused this exception to be thrown. + The line number within the configuration file at which this exception was thrown. + + + Initializes a new instance of the class. + A message that describes why this exception was thrown. + The inner exception that caused this exception to be thrown. + The object that caused this exception to be thrown. + + + Initializes a new instance of the class. + A message that describes why this exception was thrown. + The inner exception that caused this exception to be thrown. + The object that caused this exception to be thrown. + + + Initializes a new instance of the class. + A message that describes why this exception was thrown. + The path to the configuration file that caused this exception to be thrown. + The line number within the configuration file at which this exception was thrown. + + + Initializes a new instance of the class. + A message that describes why this exception was thrown. + The object that caused this exception to be thrown. + + + Initializes a new instance of the class. + A message that describes why this exception was thrown. + The object that caused this exception to be thrown. + + + Gets the path to the configuration file from which the internal object was loaded when this configuration exception was thrown. + The object that caused this exception to be thrown. + The path to the configuration file from which the internal object was loaded when this configuration exception was thrown. + + + Gets the path to the configuration file that the internal was reading when this configuration exception was thrown. + The object that caused this exception to be thrown. + The path of the configuration file the internal object was accessing when the exception occurred. + + + Gets the line number within the configuration file that the internal object represented when this configuration exception was thrown. + The object that caused this exception to be thrown. + The line number within the configuration file that contains the object being parsed when this configuration exception was thrown. + + + Gets the line number within the configuration file that the internal object was processing when this configuration exception was thrown. + The object that caused this exception to be thrown. + The line number within the configuration file that the object was accessing when the exception occurred. + + + Sets the object with the file name and line number at which this configuration exception occurred. + The object that holds the information to be serialized. + The contextual information about the source or destination. + + + Gets a description of why this configuration exception was thrown. + A description of why this was thrown. + + + Gets a collection of errors that detail the reasons this exception was thrown. + An object that contains errors that identify the reasons this exception was thrown. + + + Gets the path to the configuration file that caused this configuration exception to be thrown. + The path to the configuration file that caused this to be thrown. + + + Gets the line number within the configuration file at which this configuration exception was thrown. + The line number within the configuration file at which this exception was thrown. + + + Gets an extended description of why this configuration exception was thrown. + An extended description of why this exception was thrown. + + + The exception that is thrown when a configuration system error has occurred. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class. + The object that holds the information to deserialize. + Contextual information about the source or destination. + + + Initializes a new instance of the class. + A message describing why this exception was thrown. + + + Initializes a new instance of the class. + A message describing why this exception was thrown. + The inner exception that caused this to be thrown, if any. + + + Initializes a new instance of the class. + A message describing why this exception was thrown. + The inner exception that caused this to be thrown, if any. + The path to the configuration file that caused this to be thrown. + The line number within the configuration file at which this was thrown. + + + Initializes a new instance of the class. + A message describing why this exception was thrown. + The inner exception that caused this to be thrown, if any. + The that caused this to be thrown. + + + Initializes a new instance of the class. + A message describing why this exception was thrown. + The path to the configuration file that caused this to be thrown. + The line number within the configuration file at which this was thrown. + + + Initializes a new instance of the class. + A message describing why this exception was thrown. + The that caused this to be thrown. + + + Sets the object with the file name and line number at which this configuration exception occurred. + The object that holds the information to be serialized. + The contextual information about the source or destination. + + + Gets the path to the configuration file from which the internal object was loaded when this configuration exception was thrown. + The that caused this exception to be thrown. + A representing the node file name. + + + Gets the line number within the configuration file that the internal object represented when this configuration exception was thrown. + The that caused this exception to be thrown. + An representing the node line number. + + + Gets a description of why this configuration exception was thrown. + A description of why this exception was thrown. + + + Gets the path to the configuration file that caused this configuration exception to be thrown. + The path to the configuration file that caused this exception to be thrown. + + + Gets the line number within the configuration file at which this configuration exception was thrown. + The line number within the configuration file at which this exception was thrown. + + + Gets an extended description of why this configuration exception was thrown. + An extended description of why this exception was thrown. + + + Defines the configuration file mapping for the machine configuration file. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class based on the supplied parameter. + The name of the machine configuration file. + + + Creates a copy of the existing object. + A object. + + + Gets or sets the name of the machine configuration file name. + The machine configuration file name. + + + Represents a element within a configuration file. + + + Creates an instance of a Configuration object. + A Configuration object. + + + Gets the relative path to the resource whose configuration settings are represented by this object. + The relative path to the resource whose configuration settings are represented by this . + + + Contains a collection of objects. + + + Gets the object at the specified index. + The index location of the to return. + The at the specified index. + + + Contains a collection of locked configuration objects. This class cannot be inherited. + + + Locks a configuration object by adding it to the collection. + The name of the configuration object. + Occurs when the does not match an existing configuration object within the collection. + + + Clears all configuration objects from the collection. + + + Verifies whether a specific configuration object is locked. + The name of the configuration object to verify. + + if the contains the specified configuration object; otherwise, . + + + Copies the entire collection to a compatible one-dimensional , starting at the specified index of the target array. + A one-dimensional that is the destination of the elements copied from the . The must have zero-based indexing. + The zero-based index in at which copying begins. + + + Gets an object, which is used to iterate through this collection. + An object. + + + Verifies whether a specific configuration object is read-only. + The name of the configuration object to verify. + The specified configuration object is not in the collection. + + if the specified configuration object in the collection is read-only; otherwise, . + + + Removes a configuration object from the collection. + The name of the configuration object. + Occurs when the does not match an existing configuration object within the collection. + + + Locks a set of configuration objects based on the supplied list. + A comma-delimited string. + Occurs when an item in the parameter is not a valid lockable configuration attribute. + + + Copies the entire collection to a compatible one-dimensional , starting at the specified index of the target array. + A one-dimensional that is the destination of the elements copied from the collection. The must have zero-based indexing. + The zero-based index in at which copying begins. + + + Gets a list of configuration objects contained in the collection. + A comma-delimited string that lists the lock configuration objects in the collection. + + + Gets the number of locked configuration objects contained in the collection. + The number of locked configuration objects contained in the collection. + + + Gets a value specifying whether the collection of locked objects has parent elements. + + if the collection has parent elements; otherwise, . + + + Gets a value specifying whether the collection has been modified. + + if the collection has been modified; otherwise, . + + + Gets a value specifying whether the collection is synchronized. + + if the collection is synchronized; otherwise, . + + + Gets an object used to synchronize access to this collection. + An object used to synchronize access to this collection. + + + Provides access to configuration files for client applications. This class cannot be inherited. + + + Retrieves a specified configuration section for the current application's default configuration. + The configuration section path and name. Node names are separated by forward slashes, for example "system.net/mailSettings/smtp". + A configuration file could not be loaded. + The specified object, or if the section does not exist. + + + Opens the configuration file for the current application as a object. + One of the enumeration values that specifies the user level for which you are opening the configuration. + A configuration file could not be loaded. + The configuration file for the current application. + + + Opens the specified client configuration file as a object. + The path of the executable (exe) file. + A configuration file could not be loaded. + The specified configuration file. + + + Opens the machine configuration file on the current computer as a object. + A configuration file could not be loaded. + The machine configuration file. + + + Opens the specified client configuration file as a object that uses the specified file mapping and user level. + The configuration file to use instead of the application default configuration file. + One of the enumeration values that specifies the user level for which you are opening the configuration. + A configuration file could not be loaded. + The configuration object. + + + Opens the specified client configuration file as a object that uses the specified file mapping, user level, and preload option. + The configuration file to use instead of the default application configuration file. + One of the enumeration values that specifies the user level for which you are opening the configuration. + + to preload all section groups and sections; otherwise, . + A configuration file could not be loaded. + The configuration object. + + + Opens the machine configuration file as a object that uses the specified file mapping. + The configuration file to use instead of the application default configuration file. + A configuration file could not be loaded. + The machine configuration file. + + + Refreshes the named section so the next time that it is retrieved it will be re-read from disk. + The configuration section name or the configuration path and section name of the section to refresh. + + + Gets the data for the current application's default configuration. + Could not retrieve a object with the application settings data. + The contents of the object for the current application's default configuration. + + + Gets the data for the current application's default configuration. + Could not retrieve a object. + The contents of the object for the current application's default configuration. + + + Represents an attribute or a child of a configuration element. This class cannot be inherited. + + + Initializes a new instance of the class. + The name of the configuration entity. + The type of the configuration entity. + + + Initializes a new instance of the class. + The name of the configuration entity. + The type of the configuration entity. + The default value of the configuration entity. + + + Initializes a new instance of the class. + The name of the configuration entity. + The type of the configuration entity. + The default value of the configuration entity. + The type of the converter to apply. + The validator to use. + One of the enumeration values. + + + Initializes a new instance of the class. + The name of the configuration entity. + The type of the configuration entity. + The default value of the configuration entity. + The type of the converter to apply. + The validator to use. + One of the enumeration values. + The description of the configuration entity. + + + Initializes a new instance of the class. + The name of the configuration entity. + The type of the configuration entity. + The default value of the configuration entity. + One of the enumeration values. + + + Gets the used to convert this into an XML representation for writing to the configuration file. + This cannot be converted. + A used to convert this into an XML representation for writing to the configuration file. + + + Gets the default value for this property. + An that can be cast to the type specified by the property. + + + Gets the description associated with the . + A value that describes the property. + + + Indicates whether the assembly name for the configuration property requires transformation when it is serialized for an earlier version of the .NET Framework. + + if the property requires assembly name transformation; otherwise, . + + + Gets a value that indicates whether the property is the default collection of an element. + + if the property is the default collection of an element; otherwise, . + + + Gets a value indicating whether this is the key for the containing object. + + if this object is the key for the containing element; otherwise, . The default is . + + + Gets a value indicating whether this is required. + + if the is required; otherwise, . The default is . + + + Indicates whether the type name for the configuration property requires transformation when it is serialized for an earlier version of the .NET Framework. + + if the property requires type-name transformation; otherwise, . + + + Indicates whether the configuration property's parent configuration section is queried at serialization time to determine whether the configuration property should be serialized into XML. + + if the parent configuration section should be queried; otherwise, . + + + Gets the name of this . + The name of the . + + + Gets the type of this object. + A representing the type of this object. + + + Gets the , which is used to validate this object. + The validator, which is used to validate this . + + + Declaratively instructs the .NET Framework to instantiate a configuration property. This class cannot be inherited. + + + Initializes a new instance of class. + Name of the object defined. + + + Gets or sets the default value for the decorated property. + The object representing the default value of the decorated configuration-element property. + + + Gets or sets a value indicating whether this is the default property collection for the decorated configuration property. + + if the property represents the default collection of an element; otherwise, . The default is . + + + Gets or sets a value indicating whether this is a key property for the decorated element property. + + if the property is a key property for an element of the collection; otherwise, . The default is . + + + Gets or sets a value indicating whether the decorated element property is required. + + if the property is required; otherwise, . The default is . + + + Gets the name of the decorated configuration-element property. + The name of the decorated configuration-element property. + + + Gets or sets the for the decorated configuration-element property. + One of the enumeration values associated with the property. + + + Represents a collection of configuration-element properties. + + + Initializes a new instance of the class. + + + Adds a configuration property to the collection. + The to add. + + + Removes all configuration property objects from the collection. + + + Specifies whether the configuration property is contained in this collection. + An identifier for the to verify. + + if the specified is contained in the collection; otherwise, . + + + Copies this ConfigurationPropertyCollection to an array. + Array to which to copy. + Index at which to begin copying. + + + Gets the object as it applies to the collection. + The object as it applies to the collection + + + Removes a configuration property from the collection. + The to remove. + + if the specified was removed; otherwise, . + + + Copies this collection to an array. + The array to which to copy. + The index location at which to begin copying. + + + Gets the number of properties in the collection. + The number of properties in the collection. + + + Gets a value indicating whether access to the collection is synchronized (thread safe). + + if access to the is synchronized; otherwise, . + + + Gets the collection item with the specified name. + The to return. + The with the specified . + + + Gets the object to synchronize access to the collection. + The object to synchronize access to the collection. + + + Specifies the options to apply to a property. + + + Indicates whether the assembly name for the configuration property requires transformation when it is serialized for an earlier version of the .NET Framework. + + + Indicates that the property is a default collection. + + + Indicates that the property is a collection key. + + + Indicates that the property is required. + + + Indicates whether the type name for the configuration property requires transformation when it is serialized for an earlier version of the .NET Framework. + + + Indicates whether the configuration property's parent configuration section should be queried at serialization time to determine whether the configuration property should be serialized into XML. + + + Indicates that no option applies to the property. + + + Determines which properties are written out to a configuration file. + + + Causes all properties to be written to the configuration file. This is useful mostly for creating information configuration files or moving configuration values from one machine to another. + + + Causes only properties that differ from inherited values to be written to the configuration file. + + + Causes only modified properties to be written to the configuration file, even when the value is the same as the inherited value. + + + Represents a section within a configuration file. + + + Initializes a new instance of the class. + + + Reads XML from the configuration file. + The object, which reads from the configuration file. + + found no elements in the configuration file. + + + Returns a custom object when overridden in a derived class. + The object representing the section. + + + Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class. + + if the element has been modified; otherwise, . + + + Resets the value of the method to when implemented in a derived class. + + + Creates an XML string containing an unmerged view of the object as a single section to write to a file. + The instance to use as the parent when performing the un-merge. + The name of the section to create. + The instance to use when writing to a string. + An XML string containing an unmerged view of the object. + + + Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. + The object that is a candidate for serialization. + The name of the object as it occurs in XML. + The target version of the .NET Framework. + + if the should be serialized; otherwise, . + + + Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. + The object that is a candidate for serialization. + The name of the object as it occurs in XML. + The target version of the .NET Framework. + The parent element of the property. + + if the should be serialized; otherwise, . + + + Indicates whether the current instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. + The target version of the .NET Framework. + + if the current section should be serialized; otherwise, . + + + Gets a object that contains the non-customizable information and functionality of the object. + A that contains the non-customizable information and functionality of the . + + + Represents a collection of related sections within a configuration file. + + + Adds a object to the object. + The name of the section to be added. + The section to be added. + + + Clears this object. + + + Copies this object to an array. + The array to copy the object to. + The index location at which to begin copying. + + is . + The length of is less than the value of plus . + + + Gets the specified object contained in this object. + The index of the object to be returned. + The object at the specified index. + + + Gets the specified object contained in this object. + The name of the object to be returned. + + is null or an empty string (""). + The object with the specified name. + + + Gets an enumerator that can iterate through this object. + An that can be used to iterate through this object. + + + Gets the key of the specified object contained in this object. + The index of the object whose key is to be returned. + The key of the object at the specified index. + + + Used by the system during serialization. + The applicable object. + The applicable object. + + + Removes the specified object from this object. + The name of the section to be removed. + + + Removes the specified object from this object. + The index of the section to be removed. + + + Gets the number of sections in this object. + An integer that represents the number of sections in the collection. + + + Gets the specified object. + The index of the object to be returned. + The object at the specified index. + + + Gets the specified object. + The name of the object to be returned. + The object with the specified name. + + + Gets the keys to all objects contained in this object. + A object that contains the keys of all sections in this collection. + + + Represents a group of related sections within a configuration file. + + + Initializes a new instance of the class. + + + Forces the declaration for this object. + + + Forces the declaration for this object. + + if the object must be written to the file; otherwise, . + The object is the root section group. + +-or- + + The object has a location. + + + Indicates whether the current instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. + The target version of the .NET Framework. + + if the current section group should be serialized; otherwise, . + + + Gets a value that indicates whether this object declaration is required. + + if this declaration is required; otherwise, . + + + Gets a value that indicates whether this object is declared. + + if this is declared; otherwise, . The default is . + + + Gets the name property of this object. + The name property of this object. + + + Gets the section group name associated with this . + The section group name of this object. + + + Gets a object that contains all the objects that are children of this object. + A object that contains all the objects that are children of this object. + + + Gets a object that contains all of objects within this object. + A object that contains all the objects within this object. + + + Gets or sets the type for this object. + The object is the root section group. + +-or- + + The object has a location. + The section or group is already defined at another level. + The type of this object. + + + Represents a collection of objects. + + + Adds a object to this object. + The name of the object to be added. + The object to be added. + + + Clears the collection. + + + Copies this object to an array. + The array to copy the object to. + The index location at which to begin copying. + + is . + The length of is less than the value of plus . + + + Gets the specified object contained in the collection. + The index of the object to be returned. + The object at the specified index. + + + Gets the specified object from the collection. + The name of the object to be returned. + + is null or an empty string (""). + The object with the specified name. + + + Gets an enumerator that can iterate through the object. + An that can be used to iterate through the object. + + + Gets the key of the specified object contained in this object. + The index of the section group whose key is to be returned. + The key of the object at the specified index. + + + Used by the system during serialization. + The applicable object. + The applicable object. + + + Removes the object whose name is specified from this object. + The name of the section group to be removed. + + + Removes the object whose index is specified from this object. + The index of the section group to be removed. + + + Gets the number of section groups in the collection. + An integer that represents the number of section groups in the collection. + + + Gets the object whose index is specified from the collection. + The index of the object to be returned. + The object at the specified index. + + In C#, this property is the indexer for the class. + + + Gets the object whose name is specified from the collection. + The name of the object to be returned. + The object with the specified name. + + In C#, this property is the indexer for the class. + + + Gets the keys to all objects contained in this object. + A object that contains the names of all section groups in this collection. + + + Provides runtime versions 1.0 and 1.1 support for reading configuration sections and common configuration settings. + + + Returns the object for the passed configuration section name and path. + A configuration name and path, such as "system.net/settings". + Unable to retrieve the requested section. + The object for the passed configuration section name and path. + + + The class provides backward compatibility only. Use the class or class instead. + + + Gets a read-only collection of the application settings from the configuration file. + A read-only collection of the application settings from the configuration file. + + + Used to specify which configuration file is to be represented by the Configuration object. + + + Gets the that applies to all users. + + + Gets the roaming that applies to the current user. + + + Gets the local that applies to the current user. + + + Serves as the base class for the validator attribute types. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class using the specified validator type. + The validator type to use when creating an instance of . + + is . + + is not derived from . + + + Gets the validator attribute instance. + The current . + + + Gets the type of the validator attribute. + The of the current validator attribute instance. + + + Acts as a base class for deriving a validation class so that a value of an object can be verified. + + + Initializes an instance of the class. + + + Determines whether an object can be validated based on type. + The object type. + + if the parameter value matches the expected ; otherwise, . + + + Determines whether the value of an object is valid. + The object value. + + + Wraps the corresponding type and also carries the necessary information for reporting file-name and line numbers. + + + Initializes a new instance of the class. + + + Creates a configuration element attribute. + The prefix definition. + The name that is used locally. + The URL that is assigned to the namespace. + The attribute. + + + Creates an XML CData section. + The data to use. + The value. + + + Create an XML comment. + The comment data. + The value. + + + Creates a configuration element. + The prefix definition. + The name used locally. + The namespace for the URL. + The value. + + + Creates white spaces. + The data to use. + The value. + + + Create a text node. + The text to use. + The value. + + + Creates white space. + The data to use. + The value. + + + Loads the configuration file. + The name of the file. + + + Loads a single configuration element. + The name of the file. + The source for the reader. + + + Gets the configuration file name. + The configuration file name. + + + Gets the current node line number. + The line number for the current node. + + + Gets the configuration file name. + The file name. + + + Gets the configuration line number. + The line number. + + + Represents a single, named connection string in the connection strings configuration file section. + + + Initializes a new instance of a class. + + + Initializes a new instance of a class. + The name of the connection string. + The connection string. + + + Initializes a new instance of a object. + The name of the connection string. + The connection string. + The name of the provider to use with the connection string. + + + Returns a string representation of the object. + A string representation of the object. + + + Gets or sets the connection string. + The string value assigned to the property. + + + Gets or sets the name. + The string value assigned to the property. + + + Gets or sets the provider name property. + The property. + + + Contains a collection of objects. + + + Initializes a new instance of the class. + + + Adds a object to the collection. + A object to add to the collection. + + + Removes all the objects from the collection. + + + Returns the collection index of the passed object. + A object in the collection. + The collection index of the specified object. + + + Removes the specified object from the collection. + A object in the collection. + + + Removes the specified object from the collection. + The name of a object in the collection. + + + Removes the object at the specified index in the collection. + The index of a object in the collection. + + + Gets or sets the connection string at the specified index in the collection. + The index of a object in the collection. + The object at the specified index. + + + Gets or sets the object with the specified name in the collection. + The name of a object in the collection. + The object with the specified name; otherwise, . + + + Provides programmatic access to the connection strings configuration-file section. + + + Initializes a new instance of the class. + + + Gets a collection of objects. + A collection of objects. + + + Encapsulates the context information that is associated with a object. This class cannot be inherited. + + + Provides an object containing configuration-section information based on the specified section name. + The name of the configuration section. + An object containing the specified section within the configuration. + + + Gets the context of the environment where the configuration property is being evaluated. + An object specifying the environment where the configuration property is being evaluated. + + + Gets a value specifying whether the configuration property is being evaluated at the machine configuration level. + + if the configuration property is being evaluated at the machine configuration level; otherwise, . + + + Represents a basic configuration-section handler that exposes the configuration section's XML for both read and write access. + + + Initializes a new instance of the class. + + + Specifies the default value for an application settings property. + + + Initializes an instance of the class. + A that represents the default value for the property. + + + Gets the default value for the application settings property. + A that represents the default value for the property. + + + Provides validation of an object. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Determines whether an object can be validated, based on type. + The object type. + + for all types being validated. + + + Determines whether the value of an object is valid. + The object value. + + + Provides key/value pair configuration information from a configuration section. + + + Initializes a new instance of the class. + + + Creates a new configuration handler and adds it to the section-handler collection based on the specified parameters. + Parent object. + Configuration context object. + Section XML node. + A configuration object. + + + Gets the XML attribute name to use as the key in a key/value pair. + A string value containing the name of the key attribute. + + + Gets the XML attribute name to use as the value in a key/value pair. + A string value containing the name of the value attribute. + + + Provides a object that uses the Windows data protection API (DPAPI) to encrypt and decrypt configuration data. + + + Initializes a new instance of the class using default settings. + + + Decrypts the passed object. + The object to decrypt. + + does not have set to "EncryptedData" and set to . + +-or- + + does not have a child node named "CipherData" with a child node named "CipherValue". + +-or- + + The child node named "CipherData" is an empty node. + A decrypted object. + + + Encrypts the passed object. + The object to encrypt. + An encrypted object. + + + Initializes the provider with default settings. + The provider name to use for the object. + A collection of values to use when initializing the object. + + contains an unrecognized configuration setting. + + + Gets a value that indicates whether the object is using machine-specific or user-account-specific protection. + + if the is using machine-specific protection; if it is using user-account-specific protection. + + + Contains meta-information about an individual element within the configuration. This class cannot be inherited. + + + Gets the errors for the associated element and subelements. + The collection containing the errors for the associated element and subelements + + + Gets a value indicating whether the associated object is a collection. + + if the associated object is a collection; otherwise, . + + + Gets a value that indicates whether the associated object cannot be modified. + + if the associated object cannot be modified; otherwise, . + + + Gets a value indicating whether the associated object is in the configuration file. + + if the associated object is in the configuration file; otherwise, . + + + Gets the line number in the configuration file where the associated object is defined. + The line number in the configuration file where the associated object is defined. + + + Gets a collection of the properties in the associated object. + A collection of the properties in the associated object. + + + Gets the source file where the associated object originated. + The source file where the associated object originated. + + + Gets the type of the associated object. + The type of the associated object. + + + Gets the object used to validate the associated object. + The object used to validate the associated object. + + + Defines the configuration file mapping for an .exe application. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class by using the specified machine configuration file name. + The name of the machine configuration file that includes the complete physical path (for example, c:\Windows\Microsoft.NET\Framework\v2.0.50727\CONFIG\machine.config). + + + Creates a copy of the existing object. + An object. + + + Gets or sets the name of the configuration file. + The configuration file name. + + + Gets or sets the name of the configuration file for the local user. + The configuration file name. + + + Gets or sets the name of the configuration file for the roaming user. + The configuration file name. + + + Manages the path context for the current application. This class cannot be inherited. + + + Gets the current path for the application. + A string value containing the current path. + + + Gets an object representing the path level of the current application. + A object representing the path level of the current application. + + + Converts between a string and an enumeration type. + + + Initializes a new instance of the class. + The enumeration type to convert. + + is . + + + Converts a to an type. + The object used for type conversions. + The object used during conversion. + The object to convert. + + is null or an empty string (""). + +-or- + + starts with a numeric character. + +-or- + + includes white space. + The type that represents the parameter. + + + Converts an type to a value. + The object used for type conversions. + The object used during conversion. + The value to convert to. + The type to convert to. + The that represents the parameter. + + + Defines extended capabilities for client-based application settings providers. + + + Returns the value of the specified settings property for the previous version of the same application. + A describing the current application usage. + The whose value is to be returned. + A containing the value of the specified property setting as it was last set in the previous version of the application; or if the setting cannot be found. + + + Resets the application settings associated with the specified application to their default values. + A describing the current application usage. + + + Indicates to the provider that the application has been upgraded. This offers the provider an opportunity to upgrade its stored settings as appropriate. + A describing the current application usage. + A containing the settings property group whose values are to be retrieved. + + + Handles the access to certain configuration sections. + + + Creates a configuration section handler. + Parent object. + Configuration context object. + Section XML node. + The created section handler object. + + + Provides standard configuration methods. + + + Gets the specified configuration. + The configuration key. + The object representing the configuration. + + + Used for initialization. + + + Provides the configuration setting for International Domain Name (IDN) processing in the class. + + + Initializes a new instance of the class. + + + Gets or sets the value of the configuration setting. + A that contains the current configuration setting for IDN processing. + + + Provides a wrapper type definition for configuration sections that are not handled by the types. + + + Initializes a new instance of the class. + + + Provides a legacy section-handler definition for configuration sections that are not handled by the types. + + + Initializes a new instance of the class. + + + Creates a new configuration handler and adds the specified configuration object to the section-handler collection. + The configuration settings in a corresponding parent configuration section. + The virtual path for which the configuration section handler computes configuration values. Normally this parameter is reserved and is . + An that contains the configuration information to be handled. Provides direct access to the XML contents of the configuration section. + The created configuration handler object. + + + Converts between a string and the standard infinite or integer value. + + + Initializes a new instance of the class. + + + Converts a to an . + The object used for type conversions. + The object used during conversion. + The object to convert. + The , if the parameter is the "infinite"; otherwise, the representing the parameter integer value. + + + Converts an .to a . + The object used for type conversions. + The object used during conversion. + The value to convert to. + The type to convert to. + The "infinite" if the is ; otherwise, the representing the parameter. + + + Converts between a string and the standard infinite value. + + + Initializes a new instance of the class. + + + Converts a to a . + The object used for type conversions. + The object used during conversion. + The object to convert. + The , if the parameter is the infinite; otherwise, the representing the parameter in minutes. + + + Converts a to a . + The object used for type conversions. + The used during object conversion. + The value to convert. + The conversion type. + The "infinite", if the parameter is ; otherwise, the representing the parameter in minutes. + + + Provides validation of an value. + + + Initializes a new instance of the class. + An object that specifies the minimum value. + An object that specifies the maximum value. + + + Initializes a new instance of the class. + An object that specifies the minimum value. + An object that specifies the maximum value. + + to specify that the validation range is exclusive. Inclusive means the value to be validated must be within the specified range; exclusive means that it must be below the minimum or above the maximum. + + + Initializes a new instance of the class. + An object that specifies the minimum length of the integer value. + An object that specifies the maximum length of the integer value. + A value that specifies whether the validation range is exclusive. + An object that specifies a value that must be matched. + + is less than . + +-or- + + is greater than . + + + Determines whether the type of the object can be validated. + The type of the object. + + if the parameter matches an value; otherwise, . + + + Determines whether the value of an object is valid. + The value to be validated. + + + Declaratively instructs the .NET Framework to perform integer validation on a configuration property. This class cannot be inherited. + + + Creates a new instance of the class. + + + Gets or sets a value that indicates whether to include or exclude the integers in the range defined by the and property values. + + if the value must be excluded; otherwise, . The default is . + + + Gets or sets the maximum value allowed for the property. + The selected value is less than . + An integer that indicates the allowed maximum value. + + + Gets or sets the minimum value allowed for the property. + The selected value is greater than . + An integer that indicates the allowed minimum value. + + + Gets an instance of the class. + The validator instance. + + + Delegates all members of the interface to another instance of a host. + + + Initializes a new instance of the class. + + + Creates a new configuration context. + A string representing the path to a configuration file. + A string representing a location subpath. + A representing a new configuration context. + + + Creates a deprecated configuration context. + A string representing the path to a configuration file. + A representing a deprecated configuration context. + + + Decrypts an encrypted configuration section. + An encrypted section of a configuration file. + An object containing the providers that encrypt and decrypt protected configuration data. + An object that provides programatic access to the configProtectedData configuration section. + A string representing a decrypted configuration section. + + + Deletes the object performing I/O tasks on a configuration file. + The name of a object performing I/O tasks on a configuration file. + + + Encrypts a section of a configuration object. + A section of the configuration that is not encrypted. + An object containing the providers that encrypt and decrypt protected configuration data + An object that provides programatic access to the configProtectedData configuration section. + A string representing an encrypted section of the configuration object. + + + Returns a configuration path based on a location subpath. + A string representing the path to a configuration file. + A string representing a location subpath. + A string representing a configuration path. + + + Returns a representing the type of the configuration. + A string representing the configuration type. + + if an exception should be thrown if an error is encountered; if an exception should not be thrown if an error is encountered. + A representing the type of the configuration. + + + Returns a string representing the type name of the configuration object. + A object. + A string representing the type name of the configuration object. + + + Sets the specified permission set if available within the host object. + An object. + A object. + + if the host has finished initialization; otherwise, . + + + Returns the name of a object performing I/O tasks on a configuration file. + A string representing the path to a configuration file. + A string representing the name of a object performing I/O tasks on a configuration file. + + + Returns the name of a object performing I/O tasks on a configuration source. + The name of a object performing I/O tasks on a configuration file. + A string representing the configuration source. + A string representing the name of a object performing I/O tasks on a configuration source. + + + Returns a object representing the version of a object performing I/O tasks on a configuration file. + The name of a object performing I/O tasks on a configuration file. + A object representing the version of a object performing I/O tasks on a configuration file. + + + Instructs the host to impersonate and returns an object required internally by the .NET Framework. + An value. + + + Initializes the configuration host. + An object. + A parameter object containing the values used for initializing the configuration host. + + + Initializes the host for configuration. + A string representing a location subpath (passed by reference). + A string representing the path to a configuration file. + The location configuration path. + The configuration root element. + A parameter object representing the parameters used to initialize the host. + + + Returns a value indicating whether the configuration is above the application configuration in the configuration hierarchy. + A string representing the path to a configuration file. + + if the configuration is above the application configuration in the configuration hierarchy; otherwise, . + + + Returns a value indicating whether a configuration record is required for the host configuration initialization. + A string representing the path to a configuration file. + + if a configuration record is required for the host configuration initialization; otherwise, . + + + Restricts or allows definitions in the host configuration. + A string representing the path to a configuration file. + The object. + The object. + + if the grant or restriction of definitions in the host configuration was successful; otherwise, . + + + Returns a value indicating whether the file path used by a object to read a configuration file is a valid path. + The name of a object performing I/O tasks on a configuration file. + + if the path used by a object to read a configuration file is a valid path; otherwise, . + + + Returns a value indicating whether a configuration section requires a fully trusted code access security level and does not allow the attribute to disable implicit link demands. + The object. + + if the configuration section requires a fully trusted code access security level and does not allow the attribute to disable implicit link demands; otherwise, . + + + Returns a value indicating whether the initialization of a configuration object is considered delayed. + The object. + + if the initialization of a configuration object is considered delayed; otherwise, . + + + Returns a value indicating whether the configuration object supports a location tag. + A string representing the path to a configuration file. + + if the configuration object supports a location tag; otherwise, . + + + Returns a value indicating whether a configuration path is to a configuration node whose contents should be treated as a root. + A string representing the path to a configuration file. + + if the configuration path is to a configuration node whose contents should be treated as a root; otherwise, . + + + Returns a value indicating whether the configuration path is trusted. + A string representing the path to a configuration file. + + if the configuration path is trusted; otherwise, . + + + Opens a object to read a configuration file. + The name of a object performing I/O tasks on a configuration file. + The object specified by . + + + Opens a object to read a configuration file. + The name of a object performing I/O tasks on a configuration file. + + to assert permissions; otherwise, . + The object specified by . + + + Opens a object for writing to a configuration file or for writing to a temporary file used to build a configuration file. Allows a object to be designated as a template for copying file attributes. + The name of a object performing I/O tasks on a configuration file. + The name of a object from which file attributes are to be copied as a template. + The write context of the object (passed by reference). + A object. + + + Opens a object for writing to a configuration file. Allows a object to be designated as a template for copying file attributes. + The name of a object performing I/O tasks on a configuration file. + The name of a object from which file attributes are to be copied as a template. + The write context of the object performing I/O tasks on the configuration file (passed by reference). + + to assert permissions; otherwise, . + The object specified by the parameter. + + + Returns a value indicating whether the entire configuration file could be read by a designated object. + A string representing the path to a configuration file. + The name of a object performing I/O tasks on a configuration file. + + if the entire configuration file could be read by the object designated by ; otherwise, . + + + Instructs the object to read a designated section of its associated configuration file. + A string representing the name of a section group in the configuration file. + A string representing the name of a section in the configuration file. + + if a section of the configuration file designated by the and parameters can be read by a object; otherwise, . + + + Invokes the delegated host's method that refreshes configuration paths. + + + Indicates that a new configuration record requires a complete initialization. + An object. + + + Instructs the host to monitor an associated object for changes in a configuration file. + The name of a object performing I/O tasks on a configuration file. + A object to receive the returned data representing the changes in the configuration file. + An instance containing changed configuration settings. + + + Instructs the host object to stop monitoring an associated object for changes in a configuration file. + The name of a object performing I/O tasks on a configuration file. + A object. + + + Verifies that a configuration definition is allowed for a configuration record. + A string representing the path to a configuration file. + An object. + A object + An object. + + + Indicates that all writing to the configuration file has completed. + The name of a object performing I/O tasks on a configuration file. + + if writing to the configuration file completed successfully; otherwise, . + The write context of the object performing I/O tasks on the configuration file. + + + Indicates that all writing to the configuration file has completed and specifies whether permissions should be asserted. + The name of a object performing I/O tasks on a configuration file. + + to indicate that writing was completed successfully; otherwise, . + The write context of the object performing I/O tasks on the configuration file. + + to assert permissions; otherwise, . + + + Determines if the delegated host has a local configuration. + + if the current instance has a local configuration; otherwise, . + + + Determines if the delegated host has a roaming configuration. + + if the current instance has a roaming configuration; otherwise, . + + + Gets or sets the object. + A object. + + + Determines if the application configuration file comes from a non-local URI (that is, http://) or is a local file. + + if the delegated host's sections belong to System.Net and the configuration file for the application is downloaded via HTTP using ; otherwise, . + + + Gets a value indicating whether the configuration is remote. + + if the configuration is remote; otherwise, . + + + Gets a value indicating whether the host configuration supports change notifications. + + if the host supports change notifications; otherwise, . + + + Gets a value indicating whether the host configuration supports location tags. + + if the host supports location tags; otherwise, . + + + Gets a value indicating whether the host configuration has path support. + + if the host configuration has path support; otherwise, . + + + Gets a value indicating whether the host configuration supports refresh. + + if the host configuration supports refresh; otherwise, . + + + Defines an interface used by the .NET Framework to support creating error configuration records. + + + Gets a string specifying the file name related to the configuration details. + A string specifying a filename. + + + Gets an integer specifying the line number related to the configuration details. + An integer specifying a line number. + + + Defines an interface used by the .NET Framework to support the initialization of configuration properties. + + + Initializes a configuration object. + The type of configuration host. + An array of configuration host parameters. + + + Gets the configuration host. + An object that is used by the .NET Framework to initialize application configuration properties. + + + Gets the root of the configuration hierarchy. + An object. + + + Defines an interface used by the .NET Framework to support configuration management. + + + Ensures that the networking configuration is loaded. + + + Defines an interface used by the .NET Framework to initialize configuration properties. + + + Gets the configuration file name related to the application path. + A string value representing a configuration file name. + + + Gets the local configuration directory of the application based on the entry assembly. + A string representing the local configuration directory. + + + Gets the local configuration path of the application based on the entry assembly. + A string value representing the local configuration path of the application. + + + Gets the product name of the application based on the entry assembly. + A string value representing the product name of the application. + + + Gets the product version of the application based on the entry assembly. + A string value representing the product version of the application. + + + Gets the roaming configuration directory of the application based on the entry assembly. + A string value representing the roaming configuration directory of the application. + + + Gets the roaming user's configuration path based on the application's entry assembly. + A string value representing the roaming user's configuration path. + + + Gets the configuration path for the Machine.config file. + A string value representing the path of the Machine.config file. + + + Gets a value representing the configuration system's status. + + if the configuration system is in the process of being initialized; otherwise, . + + + Gets a value that specifies whether user configuration settings are supported. + + if the configuration system supports user configuration settings; otherwise, . + + + Gets the name of the file used to store user configuration settings. + A string specifying the name of the file used to store user configuration. + + + Defines interfaces that allow the internal .NET Framework infrastructure to customize configuration. + + + Returns the path to the application configuration file. + A string representing the path to the application configuration file. + + + Returns a string representing the path to the known local user configuration file. + A string representing the path to the known local user configuration file. + + + Returns a string representing the path to the known roaming user configuration file. + A string representing the path to the known roaming user configuration file. + + + Returns a value indicating whether a configuration file path is the same as a currently known application configuration file path. + A string representing the path to the application configuration file. + + if a string representing a configuration path is the same as a path to the application configuration file; if a string representing a configuration path is not the same as a path to the application configuration file. + + + Returns a value indicating whether a configuration file path is the same as the configuration file path for the currently known local user. + A string representing the path to the application configuration file. + + if a string representing a configuration path is the same as a path to a known local user configuration file; otherwise, . + + + Returns a value indicating whether a configuration file path is the same as the configuration file path for the currently known roaming user. + A string representing the path to an application configuration file. + + if a string representing a configuration path is the same as a path to a known roaming user configuration file; otherwise, . + + + Defines the interfaces used by the internal design time API to create a object. + + + Creates and initializes a object. + The of the object to be created. + A parameter array of that contains the parameters to be applied to the created object. + A object. + + + Normalizes a location subpath of a path to a configuration file. + A string representing the path to the configuration file. + An instance of or . + A normalized subpath string. + + + Defines interfaces used by internal .NET structures to initialize application configuration properties. + + + Creates and returns a context object for a of an application configuration. + A string representing the path of the application configuration file. + A string representing a subpath location of the configuration element. + A context object for a object of an application configuration. + + + Creates and returns a deprecated context object of the application configuration. + A string representing a path to an application configuration file. + A deprecated context object of the application configuration. + + + Decrypts an encrypted configuration section and returns it as a string. + An encrypted XML string representing a configuration section. + The object. + The object. + A decrypted configuration section as a string. + + + Deletes the object performing I/O tasks on the application configuration file. + A string representing the name of the object performing I/O tasks on the configuration file. + + + Encrypts a configuration section and returns it as a string. + An XML string representing a configuration section to encrypt. + The object. + The object. + An encrypted configuration section represented as a string. + + + Returns the complete path to an application configuration file based on the location subpath. + A string representing the path of the application configuration file. + The subpath location of the configuration file. + A string representing the complete path to an application configuration file. + + + Returns a object representing the type of the configuration object. + The type name + + to throw an exception if an error occurs; otherwise, + A object representing the type of the configuration object. + + + Returns a string representing a type name from the object representing the type of the configuration. + A object. + A string representing the type name from a object representing the type of the configuration. + + + Associates the configuration with a object. + An object. + The object to associate with the configuration. + + to indicate the configuration host is has completed building associated permissions; otherwise, . + + + Returns a string representing the configuration file name associated with the object performing I/O tasks on the configuration file. + A string representing the path of the application configuration file. + A string representing the configuration file name associated with the I/O tasks on the configuration file. + + + Returns a string representing the configuration file name associated with the object performing I/O tasks on a remote configuration file. + A string representing the configuration file name associated with the object performing I/O tasks on the configuration file. + A string representing a path to a remote configuration file. + A string representing the configuration file name associated with the object performing I/O tasks on the configuration file. + + + Returns the version of the object associated with configuration file. + A string representing the name of the object performing I/O tasks on the configuration file. + The version of the object associated with configuration file. + + + Instructs the host to impersonate and returns an object required by the internal .NET structure. + An value. + + + Initializes a configuration host. + The configuration root object. + The parameter object containing the values used for initializing the configuration host. + + + Initializes a configuration object. + The subpath location of the configuration file. + A string representing the path of the application configuration file. + A string representing the location of a configuration path. + The object. + The parameter object containing the values used for initializing the configuration host. + + + Returns a value indicating whether the configuration file is located at a higher level in the configuration hierarchy than the application configuration. + A string representing the path of the application configuration file. + + the configuration file is located at a higher level in the configuration hierarchy than the application configuration; otherwise, . + + + Returns a value indicating whether a child record is required for a child configuration path. + A string representing the path of the application configuration file. + + if child record is required for a child configuration path; otherwise, . + + + Determines if a different definition is allowable for an application configuration object. + A string representing the path of the application configuration file. + A object. + A object. + + if a different definition is allowable for an application configuration object; otherwise, . + + + Returns a value indicating whether the file path used by a object to read a configuration file is a valid path. + A string representing the name of the object performing I/O tasks on the configuration file. + + if the path used by a object to read a configuration file is a valid path; otherwise, . + + + Returns a value indicating whether a configuration section requires a fully trusted code access security level and does not allow the attribute to disable implicit link demands. + The object. + + if the configuration section requires a fully trusted code access security level and does not allow the attribute to disable implicit link demands; otherwise, . + + + Returns a value indicating whether the initialization of a configuration object is considered delayed. + The object. + + if the initialization of a configuration object is considered delayed; otherwise, . + + + Returns a value indicating whether the configuration object supports a location tag. + A string representing the path of the application configuration file. + + if the configuration object supports a location tag; otherwise, . + + + Returns a value indicating whether a configuration path is to a configuration node whose contents should be treated as a root. + A string representing the path of the application configuration file. + + if the configuration path is to a configuration node whose contents should be treated as a root; otherwise, . + + + Returns a value indicating whether the configuration path is trusted. + A string representing the path of the application configuration file. + + if the configuration path is trusted; otherwise, . + + + Opens a to read a configuration file. + A string representing the name of the object performing I/O tasks on the configuration file. + A object. + + + Opens a object to read a configuration file. + A string representing the name of the object performing I/O tasks on the configuration file. + + to assert permissions; otherwise, . + The object specified by . + + + Opens a object for writing to a configuration file or for writing to a temporary file used to build a configuration file. Allows a object to be designated as a template for copying file attributes. + A string representing the name of the object performing I/O tasks on the configuration file. + The name of a object from which file attributes are to be copied as a template. + The write context of the object. + A object. + + + Opens a object for writing to a configuration file. Allows a object to be designated as a template for copying file attributes. + A string representing the name of the object performing I/O tasks on the configuration file. + The name of a from which file attributes are to be copied as a template. + The write context of the object performing I/O tasks on the configuration file. + + to assert permissions; otherwise, . + The object specified by . + + + Returns a value that indicates whether the entire configuration file could be read by a designated object. + A string representing the path of the application configuration file. + A string representing the name of the object performing I/O tasks on the configuration file. + + if the entire configuration file could be read by the object designated by ; otherwise, . + + + Instructs the object to read a designated section of its associated configuration file. + A string representing the identifying name of a configuration file section group. + A string representing the identifying name of a configuration file section. + + if a section of the configuration file designated by and could be read by a object; otherwise, . + + + Indicates a new configuration record requires a complete initialization. + An object. + + + Instructs the object to monitor an associated object for changes in a configuration file. + A string representing the name of the object performing I/O tasks on the configuration file. + A object to receive the returned data representing the changes in the configuration file. + An containing changed configuration settings. + + + Instructs the object to stop monitoring an associated object for changes in a configuration file. + A string representing the name of the object performing I/O tasks on the configuration file. + A object. + + + Verifies that a configuration definition is allowed for a configuration record. + A string representing the path of the application configuration file. + A object. + A object + An object. + + + Indicates that all writing to the configuration file has completed. + A string representing the name of the object performing I/O tasks on the configuration file. + + if the write to the configuration file was completed successfully; otherwise, . + The write context of the object performing I/O tasks on the configuration file. + + + Indicates that all writing to the configuration file has completed and specifies whether permissions should be asserted. + A string representing the name of the object performing I/O tasks on the configuration file. + + to indicate the write was completed successfully; otherwise, . + The write context of the object performing I/O tasks on the configuration file. + + to assert permissions; otherwise, . + + + Returns a value indicating whether the configuration is remote. + + if the configuration is remote; otherwise, . + + + Returns a value indicating whether the host configuration supports change notification. + + if the configuration supports change notification; otherwise, . + + + Returns a value indicating whether the host configuration supports location tags. + + if the configuration supports location tags; otherwise, . + + + Returns a value indicating whether the host configuration supports path tags. + + if the configuration supports path tags; otherwise, . + + + Returns a value indicating whether the host configuration supports configuration refresh. + + if the configuration supports configuration refresh; otherwise, . + + + Defines interfaces used by internal .NET structures to support creation of new configuration records. + + + Returns an object representing a section of a configuration from the last-known-good (LKG) configuration. + A string representing a key to a configuration section. + An instance representing the section of the last-known-good configuration specified by . + + + Returns an instance representing a section of a configuration file. + A string representing a key to a configuration section. + An instance representing a section of a configuration file. + + + Causes a specified section of the configuration object to be reinitialized. + A string representing a key to a configuration section that is to be refreshed. + + + Removes a configuration record. + + + Grants the configuration object the permission to throw an exception if an error occurs during initialization. + + + Gets a string representing a configuration file path. + A string representing a configuration file path. + + + Returns a value indicating whether an error occurred during initialization of a configuration object. + + if an error occurred during initialization of a configuration object; otherwise, . + + + Returns the name of a object performing I/O tasks on the configuration file. + A string representing the name of a object performing I/O tasks on the configuration file. + + + Defines interfaces used by internal .NET structures to support a configuration root object. + + + Represents the method that handles the event of an object. + + + Represents the method that handles the event of a object. + + + Returns an object representing a configuration specified by a configuration path. + A string representing the path to a configuration file. + An object representing a configuration specified by . + + + Returns an representing the data in a section of a configuration file. + A string representing a section of a configuration file. + A string representing the path to a configuration file. + An representing the data in a section of a configuration file. + + + Returns a value representing the file path of the nearest configuration ancestor that has configuration data. + The path of configuration file. + A string representing the file path of the nearest configuration ancestor that has configuration data. + + + Returns an object representing a unique configuration record for given configuration path. + The path of the configuration file. + An object representing a unique configuration record for a given configuration path. + + + Initializes a configuration object. + An object. + + if design time; if run time. + + + Finds and removes a configuration record and all its children for a given configuration path. + The path of the configuration file. + + + Returns a value indicating whether the configuration is a design-time configuration. + + if the configuration is a design-time configuration; if the configuration is not a design-time configuration. + + + Defines an interface used by the configuration system to set the class. + + + Indicates that initialization of the configuration system has completed. + + + Provides hierarchical configuration settings and extensions specific to ASP.NET to the configuration system. + An object used by the class. + + if the initialization process of the configuration system is complete; otherwise, . + + + Defines an interface used by the .NET Framework to initialize application configuration properties. + + + Returns the configuration object based on the specified key. + The configuration key value. + A configuration object. + + + Refreshes the configuration system based on the specified section name. + The name of the configuration section. + + + Gets a value indicating whether the user configuration is supported. + + if the user configuration is supported; otherwise, . + + + Defines a class that allows the .NET Framework infrastructure to specify event arguments for configuration events. + + + Initializes a new instance of the class. + A configuration path. + + + Gets or sets the configuration path related to the object. + A string value specifying the configuration path. + + + Defines a class used by the .NET Framework infrastructure to support configuration events. + The source object of the event. + A configuration event argument. + + + Represents a method for hosts to call when a monitored stream has changed. + The name of the object performing I/O tasks on the configuration file. + + + Defines standard functionality for controls or libraries that store and retrieve application settings. + + + Reads the control's application settings into their corresponding properties and updates the control's state. + + + Resets the control's application settings properties to their default values. + + + Persists the control's application settings properties. + + + Gets or sets a value indicating whether the control should automatically persist its application settings properties. + + if the control should automatically persist its state; otherwise, . + + + Gets or sets the value of the application settings key for the current instance of the control. + A containing the settings key for the current instance of the control. + + + Provides the configuration setting for International Resource Identifier (IRI) processing in the class. + + + Initializes a new instance of the class. + + + Gets or sets the value of the configuration setting. + A Boolean that indicates if International Resource Identifier (IRI) processing is enabled. + + + Provides an interface for defining an alternate application settings provider. + + + Returns the settings provider compatible with the specified settings property. + The that requires serialization. + If found, the that can persist the specified settings property; otherwise, . + + + Contains a collection of objects. + + + Initializes a new instance of the class. + + + Adds a object to the collection based on the supplied parameters. + A . + + + Adds a object to the collection based on the supplied parameters. + A string specifying the key. + A string specifying the value. + + + Clears the collection. + + + When overridden in a derived class, the method creates a new object. + A newly created . + + + Gets the element key for a specified configuration element when overridden in a derived class. + The to which the key should be returned. + An object that acts as the key for the specified . + + + Removes a object from the collection. + A string specifying the . + + + Gets the keys to all items contained in the collection. + A string array. + + + Gets the object based on the supplied parameter. + The key of the contained in the collection. + A configuration element, or if the key does not exist in the collection. + + + Gets a collection of configuration properties. + A collection of configuration properties. + + + Gets a value indicating whether an attempt to add a duplicate object to the collection will cause an exception to be thrown. + + if an attempt to add a duplicate to the will cause an exception to be thrown; otherwise, . + + + Represents a configuration element that contains a key/value pair. + + + Initializes a new instance of the class based on the supplied parameters. + The key of the . + The value of the . + + + Sets the object to its initial state. + + + Gets the key of the object. + The key of the . + + + Gets the collection of properties. + The of properties for the element. + + + Gets or sets the value of the object. + The value of the . + + + Provides persistence for application settings classes. + + + Initializes a new instance of the class. + + + Returns the value of the named settings property for the previous version of the same application. + A that describes where the application settings property is used. + The whose value is to be returned. + A representing the application setting if found; otherwise, . + + + Returns the collection of setting property values for the specified application instance and settings property group. + A describing the current application usage. + A containing the settings property group whose values are to be retrieved. + A user-scoped setting was encountered but the current configuration only supports application-scoped settings. + A containing the values for the specified settings property group. + + + Initializes the provider. + The friendly name of the provider. + A collection of the name/value pairs representing the provider-specific attributes specified in the configuration for this provider. + + + Resets all application settings properties associated with the specified application to their default values. + A describing the current application usage. + A user-scoped setting was encountered but the current configuration only supports application-scoped settings. + + + Sets the values of the specified group of property settings. + A describing the current application usage. + A representing the group of property settings to set. + A user-scoped setting was encountered but the current configuration only supports application-scoped settings. + + -or- + + There was a general failure saving the settings to the configuration file. + + + Attempts to migrate previous user-scoped settings from a previous version of the same application. + A describing the current application usage. + A containing the settings property group whose values are to be retrieved. + A user-scoped setting was encountered but the current configuration only supports application-scoped settings. + + -or- + + The previous version of the configuration file could not be accessed. + + + Gets or sets the name of the currently running application. + A string that contains the application's display name. + + + Provides validation of an value. + + + Initializes a new instance of the class. + An value that specifies the minimum length of the value. + An value that specifies the maximum length of the value. + + + Initializes a new instance of the class. + An value that specifies the minimum length of the value. + An value that specifies the maximum length of the value. + A value that specifies whether the validation range is exclusive. + + + Initializes a new instance of the class. + An value that specifies the minimum length of the value. + An value that specifies the maximum length of the value. + A value that specifies whether the validation range is exclusive. + An value that specifies a specific value that must be matched. + + is equal to or less than . + +-or- + + is less than . + + + Determines whether the type of the object can be validated. + The type of object. + + if the parameter matches an value; otherwise, . + + + Determines whether the value of an object is valid. + The value of an object. + + + Declaratively instructs the .NET Framework to perform long-integer validation on a configuration property. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Gets or sets a value that indicates whether to include or exclude the integers in the range defined by the and property values. + + if the value must be excluded; otherwise, . The default is . + + + Gets or sets the maximum value allowed for the property. + The selected value is less than . + A long integer that indicates the allowed maximum value. + + + Gets or sets the minimum value allowed for the property. + The selected value is greater than . + An integer that indicates the allowed minimum value. + + + Gets an instance of the class. + The validator instance. + + + Contains a collection of objects. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Adds a object to the collection. + A object. + + + Clears the . + + + Removes a object from the collection based on the provided parameter. + A object. + + + Removes a object from the collection based on the provided parameter. + The name of the object. + + + Gets the keys to all items contained in the . + A string array. + + + Gets or sets the object based on the supplied parameter. + The name of the contained in the collection. + A object. + + + A configuration element that contains a name and value. This class cannot be inherited. + + + Initializes a new instance of the class based on supplied parameters. + The name of the object. + The value of the object. + + + Gets the name of the object. + The name of the object. + + + Gets or sets the value of the object. + The value of the object. + + + Provides access to a configuration file. This type supports the .NET Framework configuration infrastructure and is not intended to be used directly from your code. + + + Initializes a new instance of the class. + + + Creates a new configuration handler and adds it to the section-handler collection based on the specified parameters. + The parent object. + The configuration context object. + The section XML node. + The file specified in the attribute of exists but cannot be loaded. + +-or- + + The attribute of does not match the root element of the file specified in the attribute. + A configuration object. + + + Provides name/value-pair configuration information from a configuration section. + + + Initializes a new instance of the class. + + + Creates a new configuration handler and adds it to the section-handler collection based on the specified parameters. + Parent object. + Configuration context object. + Section XML node. + A configuration object. + + + Gets the XML attribute name to use as the key in a key/value pair. + A value containing the name of the key attribute. + + + Gets the XML attribute name to use as the value in a key/value pair. + A value containing the name of the value attribute. + + + Specifies that a settings provider should disable any logic that gets invoked when an application upgrade is detected. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Specifies the override behavior of a configuration element for configuration elements in child directories. + + + The configuration setting of the element or group can be overridden by configuration settings that are in child directories. + + + The configuration setting of the element or group cannot be overridden by configuration settings that are in child directories. + + + The configuration setting of the element or group will be overridden by configuration settings that are in child directories if explicitly allowed by a parent element of the current configuration element or group. Permission to override is specified by using the attribute. + + + Provides validation of a object. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Determines whether the object type can be validated. + The object type. + + if the parameter matches a object; otherwise, . + + + Determines whether the value of an object is valid. + The value of an object. + + is . + + cannot be resolved as a positive value. + + + Declaratively instructs the .NET Framework to perform time validation on a configuration property. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Gets an instance of the class. + The validator instance. + + + Contains meta-information on an individual property within the configuration. This type cannot be inherited. + + + Gets the object related to the configuration attribute. + A object. + + + Gets an object containing the default value related to a configuration attribute. + An object containing the default value of the configuration attribute. + + + Gets the description of the object that corresponds to a configuration attribute. + The description of the configuration attribute. + + + Gets a value specifying whether the configuration attribute is a key. + + if the configuration attribute is a key; otherwise, . + + + Gets a value specifying whether the configuration attribute is locked. + + if the object is locked; otherwise, . + + + Gets a value specifying whether the configuration attribute has been modified. + + if the object has been modified; otherwise, . + + + Gets a value specifying whether the configuration attribute is required. + + if the object is required; otherwise, . + + + Gets the line number in the configuration file related to the configuration attribute. + A line number of the configuration file. + + + Gets the name of the object that corresponds to a configuration attribute. + The name of the object. + + + Gets the source file that corresponds to a configuration attribute. + The source file of the object. + + + Gets the of the object that corresponds to a configuration attribute. + The of the object. + + + Gets a object related to the configuration attribute. + A object. + + + Gets or sets an object containing the value related to a configuration attribute. + An object containing the value for the object. + + + Gets a object related to the configuration attribute. + A object. + + + Contains a collection of objects. This class cannot be inherited. + + + Copies the entire collection to a compatible one-dimensional , starting at the specified index of the target array. + A one-dimensional that is the destination of the elements copied from the collection. The must have zero-based indexing. + The zero-based index in at which copying begins. + + is . + The property of is less than + . + + + Gets an object, which is used to iterate through this collection. + An object, which is used to iterate through this . + + + Populates a object with the data needed to serialize the instance. + A object that contains the information required to serialize the instance. + A object that contains the source and destination of the serialized stream associated with the instance. + + is . + + + Gets the object in the collection, based on the specified property name. + The name of the configuration attribute contained in the object. + A object. + + + Specifies the level in the configuration hierarchy where a configuration property value originated. + + + The configuration property value originates from the property. + + + The configuration property value is inherited from a parent level in the configuration. + + + The configuration property value is defined at the current level of the hierarchy. + + + Provides access to the protected-configuration providers for the current application's configuration file. + + + The name of the data protection provider. + + + The name of the protected data section. + + + The name of the RSA provider. + + + Gets the name of the default protected-configuration provider. + The name of the default protected-configuration provider. + + + Gets a collection of the installed protected-configuration providers. + A collection of installed objects. + + + The base class to create providers for encrypting and decrypting protected configuration data. + + + Initializes a new instance of the class using default settings. + + + Decrypts the passed object from a configuration file. + The object to decrypt. + The object containing decrypted data. + + + Encrypts the passed object from a configuration file. + The object to encrypt. + The object containing encrypted data. + + + Provides a collection of objects. + + + Initializes a new instance of the class using default settings. + + + Adds a object to the collection. + A object to add to the collection. + + is . + + is not a object. + The object to add already exists in the collection. + +-or- + + The collection is read-only. + + + Gets a object in the collection with the specified name. + The name of a object in the collection. + The object with the specified name, or if there is no object with that name. + + + Provides programmatic access to the configuration section. This class cannot be inherited. + + + Initializes a new instance of the class using default settings. + + + Gets or sets the name of the default object in the collection property. + The name of the default object in the collection property. + + + Gets a collection of all the objects in all participating configuration files. + A collection of all the objects in all participating configuration files. + + + Represents a group of configuration elements that configure the providers for the configuration section. + + + Initializes a new instance of the class. + + + Gets a collection that represents the properties of the providers for the protected configuration data. + A that represents the properties of the providers for the protected configuration data. + + + Gets a collection of objects that represent the properties of the providers for the protected configuration data. + A collection of objects that represent the properties of the providers for the protected configuration data. + + + Provides a base implementation for the extensible provider model. + + + Initializes a new instance of the class. + + + Initializes the configuration builder. + The friendly name of the provider. + A collection of the name/value pairs representing the provider-specific attributes specified in the configuration for this provider. + The name of the provider is . + The name of the provider has a length of zero. + An attempt is made to call on a provider after the provider has already been initialized. + + + Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs). + A brief, friendly description suitable for display in administrative tools or other UIs. + + + Gets the friendly name used to refer to the provider during configuration. + The friendly name used to refer to the provider during configuration. + + + Represents a collection of provider objects that inherit from . + + + Initializes a new instance of the class. + + + Adds a provider to the collection. + The provider to be added. + The collection is read-only. + + is . + The of is . + +-or- + + The length of the of is less than 1. + + + Removes all items from the collection. + The collection is set to read-only. + + + Copies the contents of the collection to the given array starting at the specified index. + The array to copy the elements of the collection to. + The index of the collection item at which to start the copying process. + + + Returns an object that implements the interface to iterate through the collection. + An object that implements to iterate through the collection. + + + Removes a provider from the collection. + The name of the provider to be removed. + The collection has been set to read-only. + + + Sets the collection to be read-only. + + + Copies the elements of the to an array, starting at a particular array index. + The array to copy the elements of the collection to. + The index of the array at which to start copying provider instances from the collection. + + + Gets the number of providers in the collection. + The number of providers in the collection. + + + Gets a value indicating whether access to the collection is synchronized (thread safe). + + in all cases. + + + Gets the provider with the specified name. + The key by which the provider is identified. + The provider with the specified name. + + + Gets the current object. + The current object. + + + The exception that is thrown when a configuration provider error has occurred. This exception class is also used by providers to throw exceptions when internal errors occur within the provider that do not map to other pre-existing exception classes. + + + Creates a new instance of the class. + + + Creates a new instance of the class. + The object that holds the information to deserialize. + Contextual information about the source or destination. + + + Creates a new instance of the class. + A message describing why this was thrown. + + + Creates a new instance of the class. + A message describing why this was thrown. + The exception that caused this to be thrown. + + + Represents the configuration elements associated with a provider. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class. + The name of the provider to configure settings for. + The type of the provider to configure settings for. + + + Gets or sets the name of the provider configured by this class. + The name of the provider. + + + Gets a collection of user-defined parameters for the provider. + A of parameters for the provider. + + + Gets or sets the type of the provider configured by this class. + The fully qualified namespace and class name for the type of provider configured by this instance. + + + Represents a collection of objects. + + + Initializes a new instance of the class. + + + Adds a object to the collection. + The object to add. + + + Clears the collection. + + + Removes an element from the collection. + The name of the object to remove. + + + Gets or sets a value at the specified index in the collection. + The index of the to return. + The specified . + + + Gets an item from the collection. + A string reference to the object within the collection. + A object contained in the collection. + + + Provides validation of a string based on the rules provided by a regular expression. + + + Initializes a new instance of the class. + A string that specifies a regular expression. + + is null or an empty string (""). + + + Determines whether the type of the object can be validated. + The type of object. + + if the parameter matches a string; otherwise, . + + + Determines whether the value of an object is valid. + The value of an object. + + does not conform to the parameters of the class. + + + Declaratively instructs the .NET Framework to perform string validation on a configuration property using a regular expression. This class cannot be inherited. + + + Initializes a new instance of the object. + The string to use for regular expression validation. + + + Gets the string used to perform regular-expression validation. + The string containing the regular expression used to filter the string assigned to the decorated configuration-element property. + + + Gets an instance of the class. + The validator instance. + + + Provides a instance that uses RSA encryption to encrypt and decrypt configuration data. + + + Initializes a new instance of the class. + + + Adds a key to the RSA key container. + The size of the key to add. + + to indicate that the key is exportable; otherwise, . + + + Decrypts the XML node passed to it. + The to decrypt. + The decrypted XML node. + + + Removes a key from the RSA key container. + + + Encrypts the XML node passed to it. + The to encrypt. + An encrypted object. + + + Exports an RSA key from the key container. + The file name and path to export the key to. + + to indicate that private parameters are exported; otherwise, . + + is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . + + is . + The specified path, file name, or both exceed the system-defined maximum length. + The specified path is invalid, such as being on an unmapped drive. + An error occurred while opening the file. + + specified a file that is read-only. + + -or- + + This operation is not supported on the current platform. + + -or- + + specified a directory. + + -or- + + The caller does not have the required permission. + The file specified in was not found. + + is in an invalid format. + The caller does not have the required permission. + + + Imports an RSA key into the key container. + The file name and path to import the key from. + + to indicate that the key is exportable; otherwise, . + + is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . + + is . + The specified path, file name, or both exceed the system-defined maximum length. + The specified path is invalid, such as being on an unmapped drive. + An error occurred while opening the file. + + specified a file that is write-only. + + -or- + + This operation is not supported on the current platform. + + -or- + + specified a directory. + + -or- + + The caller does not have the required permission. + The file specified in was not found. + + is in an invalid format. + + + Initializes the provider with default settings. + The provider name to use for the object. + A collection of values to use when initializing the object. + + includes one or more unrecognized values. + + + Gets the name of the Windows cryptography API (crypto API) cryptographic service provider (CSP). + The name of the CryptoAPI cryptographic service provider. + + + Gets the name of the key container. + The name of the key container. + + + Gets the public key used by the provider. + An object that contains the public key used by the provider. + + + Gets a value indicating whether the provider uses FIPS. + + if the provider uses FIPS; otherwise, . + + + Gets a value that indicates whether the object is using the machine key container. + + if the object is using the machine key container; otherwise, . + + + Gets a value that indicates whether the provider is using Optimal Asymmetric Encryption Padding (OAEP) key exchange data. + + if the object is using Optimal Asymmetric Encryption Padding (OAEP) key exchange data; otherwise, . + + + Represents an element in a class. + + + Initializes a new instance of the class. + + + Gets the value of the GenericUriParserOptions entry from a instance. + The value of GenericUriParserOptions entry. + + + Gets the value of the Name entry from a instance. + The protocol used by this schema setting. + + + Represents a collection of objects. + + + Initializes a new instance of the class. + + + The index of the specified . + The for the specified index location. + The index of the specified ; otherwise, -1. + + + Gets the default collection type of . + The default collection type of . + + + Gets an item at the specified index in the collection. + The index of the to return. + The parameter is less than zero. + + -or- + + The item specified by the parameter is or has been removed. + The specified . + + + Gets an item from the collection. + A string reference to the object within the collection. + A object contained in the collection. + + + Contains metadata about an individual section within the configuration hierarchy. This class cannot be inherited. + + + Forces the associated configuration section to appear in the configuration file. + + + Forces the associated configuration section to appear in the configuration file, or removes an existing section from the configuration file. + + if the associated section should be written in the configuration file; otherwise, . + + is and the associated section cannot be exported to the child configuration file, or it is undeclared. + + + Gets the configuration section that contains the configuration section associated with this object. + The method is invoked from a parent section. + The configuration section that contains the that is associated with this object. + + + Returns an XML node object that represents the associated configuration-section object. + This configuration object is locked and cannot be edited. + The XML representation for this configuration section. + + + Marks a configuration section for protection. + The name of the protection provider to use. + The property is set to . + +-or- + + The target section is already a protected data section. + + + Causes the associated configuration section to inherit all its values from the parent section. + This method cannot be called outside editing mode. + + + Sets the object to an XML representation of the associated configuration section within the configuration file. + The XML to use. + + is . + + + Removes the protected configuration encryption from the associated configuration section. + + + Gets or sets a value that indicates where in the configuration file hierarchy the associated configuration section can be defined. + The selected value conflicts with a value that is already defined. + A value that indicates where in the configuration file hierarchy the associated object can be declared. + + + Gets or sets a value that indicates where in the configuration file hierarchy the associated configuration section can be declared. + The selected value conflicts with a value that is already defined. + A value that indicates where in the configuration file hierarchy the associated object can be declared for .exe files. + + + Gets or sets a value that indicates whether the configuration section allows the attribute. + The selected value conflicts with a value that is already defined. + + if the attribute is allowed; otherwise, . The default is . + + + Gets or sets a value that indicates whether the associated configuration section can be overridden by lower-level configuration files. + + if the section can be overridden; otherwise, . The default is . + + + Gets or sets the name of the include file in which the associated configuration section is defined, if such a file exists. + The name of the include file in which the associated is defined, if such a file exists; otherwise, an empty string (""). + + + Gets or sets a value that indicates whether the associated configuration section will be saved even if it has not been modified. + + if the associated object will be saved even if it has not been modified; otherwise, . The default is . + + + If the configuration file is saved (even if there are no modifications), ASP.NET restarts the application. + + + Gets or sets a value that indicates whether the settings that are specified in the associated configuration section are inherited by applications that reside in a subdirectory of the relevant application. + + if the settings specified in this object are inherited by child applications; otherwise, . The default is . + + + Gets a value that indicates whether the configuration section must be declared in the configuration file. + + if the associated object must be declared in the configuration file; otherwise, . + + + Gets a value that indicates whether the associated configuration section is declared in the configuration file. + + if this is declared in the configuration file; otherwise, . The default is . + + + Gets a value that indicates whether the associated configuration section is locked. + + if the section is locked; otherwise, . + + + Gets a value that indicates whether the associated configuration section is protected. + + if this is protected; otherwise, . The default is . + + + Gets the name of the associated configuration section. + The complete name of the configuration section. + + + Gets or sets the enumeration value that specifies whether the associated configuration section can be overridden by child configuration files. + An attempt was made to change both the and properties, which is not supported for compatibility reasons. + One of the enumeration values. + + + Gets or sets a value that specifies the default override behavior of a configuration section by child configuration files. + The override behavior is specified in a parent configuration section. + One of the enumeration values. + + + Gets the override behavior of a configuration section that is in turn based on whether child configuration files can lock the configuration section. + One of the enumeration values. + + + Gets the protected configuration provider for the associated configuration section. + The protected configuration provider for this object. + + + Gets a value that indicates whether the associated configuration section requires access permissions. + The selected value conflicts with a value that is already defined. + + if the attribute is set to ; otherwise, . The default is . + + + Gets or sets a value that specifies whether a change in an external configuration include file requires an application restart. + The selected value conflicts with a value that is already defined. + + if a change in an external configuration include file requires an application restart; otherwise, . The default is . + + + Gets the name of the associated configuration section. + The name of the associated object. + + + Gets or sets the section class name. + The selected value is or an empty string (""). + The selected value conflicts with a value that is already defined. + The name of the class that is associated with this section. + + + Represents a custom settings attribute used to associate settings information with a settings property. + + + Initializes a new instance of the class. + + + Provides data for the event. + + + Initializes an instance of the class. + A containing the name of the application setting. + A containing a category description of the setting. Often this parameter is set to the application settings group name. + A containing the application settings key. + An that contains the new value to be assigned to the application settings property. + + to cancel the event; otherwise, . + + + Gets the new value being assigned to the application settings property. + An that contains the new value to be assigned to the application settings property. + + + Gets the application settings property category. + A containing a category description of the setting. Typically, this parameter is set to the application settings group name. + + + Gets the application settings key associated with the property. + A containing the application settings key. + + + Gets the name of the application setting associated with the application settings property. + A containing the name of the application setting. + + + Represents the method that will handle the event. + The source of the event, typically an application settings wrapper class derived from the class. + A containing the data for the event. + + + Represents a simplified configuration element used for updating elements in the configuration. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class based on supplied parameters. + The name of the object. + A object. This object is an enumeration used as the serialization scheme to store configuration settings. + + + Compares the current instance to the specified object. + The object to compare with. + + if the instance is equal to the specified object; otherwise, . + + + Gets a unique value representing the current instance. + A unique value representing the current instance. + + + Gets or sets the name of the object. + The name of the object. + + + Gets or sets the serialization mechanism used to persist the values of the object. + A object. + + + Gets or sets the value of a object by using a object. + A object containing the value of the object. + + + Contains a collection of objects. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Adds a object to the collection. + The object to add to the collection. + + + Removes all objects from the collection. + + + Gets a object from the collection. + A string value representing the object in the collection. + A object. + + + Removes a object from the collection. + A object. + + + Gets the type of the configuration collection. + The object of the collection. + + + Represents a collection of key/value pairs used to describe a configuration object as well as a object. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class. + A collection of key/value pairs that are related to configuration settings. + + + Provides the base class used to support user property settings. + + + Initializes a new instance of the class. + + + Initializes internal properties used by object. + The settings context related to the settings properties. + The settings properties that will be accessible from the instance. + The initialized providers that should be used when loading and saving property values. + + + Stores the current values of the settings properties. + + + Provides a class that is synchronized (thread safe). + The class used to support user property settings. + A class that is synchronized. + + + Gets the associated settings context. + A associated with the settings instance. + + + Gets a value indicating whether access to the object is synchronized (thread safe). + + if access to the is synchronized; otherwise, . + + + Gets or sets the value of the specified settings property. + A containing the name of the property to access. + There are no properties associated with the current object, or the specified property could not be found. + An attempt was made to set a read-only property. + The value supplied is of a type incompatible with the settings property, during a set operation. + If found, the value of the named settings property. + + + Gets the collection of settings properties. + A collection containing all the objects. + + + Gets a collection of settings property values. + A collection of objects representing the actual data values for the properties managed by the instance. + + + Gets a collection of settings providers. + A containing objects. + + + Provides contextual information that the provider can use when persisting settings. + + + Initializes a new instance of the class. + + + Provides a string that describes an individual configuration property. This class cannot be inherited. + + + Initializes an instance of the class. + The used as descriptive text. + + + Gets the descriptive text for the associated configuration property. + A containing the descriptive text for the associated configuration property. + + + Provides a string that describes an application settings property group. This class cannot be inherited. + + + Initializes a new instance of the class. + A containing the descriptive text for the application settings group. + + + The descriptive text for the application settings properties group. + A containing the descriptive text for the application settings group. + + + Specifies a name for application settings property group. This class cannot be inherited. + + + Initializes a new instance of the class. + A containing the name of the application settings property group. + + + Gets the name of the application settings property group. + A containing the name of the application settings property group. + + + Provides data for the event. + + + Initializes a new instance of the class. + A object from which settings are loaded. + + + Gets the settings provider used to store configuration settings. + A settings provider. + + + Represents the method that will handle the event. + The source of the event, typically the settings class. + A object that contains the event data. + + + Provides values to indicate which services should be made available to application settings. + + + Enables application settings to be stored in roaming user profiles. For more information about roaming user profiles, see Isolated Storage and Roaming. + + + Specifies special services for application settings properties. This class cannot be inherited. + + + Initializes a new instance of the class. + A value that enumerates the services being requested. + + + Gets the set of special services that have been requested. + A value that results from using the logical operator to combine all the enumeration values corresponding to the requested services. + + + Used internally as the class that represents metadata about an individual configuration property. + + + Initializes a new instance of the class, based on the supplied parameter. + Specifies a copy of an existing object. + + + Initializes a new instance of the class. based on the supplied parameter. + Specifies the name of an existing object. + + + Creates a new instance of the class based on the supplied parameters. + The name of the object. + The type of object. + A object to use for persistence. + A value specifying whether the object is read-only. + The default value of the object. + A object. This object is an enumeration used to set the serialization scheme for storing application settings. + A object. + A Boolean value specifying whether an error will be thrown when the property is unsuccessfully deserialized. + A Boolean value specifying whether an error will be thrown when the property is unsuccessfully serialized. + + + Gets a object containing the attributes of the object. + A object. + + + Gets or sets the default value of the object. + An object containing the default value of the object. + + + Gets or sets a value specifying whether a object is read-only. + + if the is read-only; otherwise, . + + + Gets or sets the name of the . + The name of the . + + + Gets or sets the type for the . + The type for the . + + + Gets or sets the provider for the . + A object. + + + Gets or sets a object for the . + A object. + + + Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully deserialized. + + if the error will be thrown when the property is unsuccessfully deserialized; otherwise, . + + + Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully serialized. + + if the error will be thrown when the property is unsuccessfully serialized; otherwise, . + + + Contains a collection of objects. + + + Initializes a new instance of the class. + + + Adds a object to the collection. + A object. + The collection is read-only. + + + Removes all objects from the collection. + The collection is read-only. + + + Creates a copy of the existing collection. + A class. + + + Copies this object to an array. + The array to copy the object to. + The index at which to begin copying. + + + Gets the object as it applies to the collection. + The object as it applies to the collection. + + + Performs additional, custom processing when adding to the contents of the instance. + A object. + + + Performs additional, custom processing after adding to the contents of the instance. + A object. + + + Performs additional, custom processing when clearing the contents of the instance. + + + Performs additional, custom processing after clearing the contents of the instance. + + + Performs additional, custom processing when removing the contents of the instance. + A object. + + + Performs additional, custom processing after removing the contents of the instance. + A object. + + + Removes a object from the collection. + The name of the object. + The collection is read-only. + + + Sets the collection to be read-only. + + + Gets a value that specifies the number of objects in the collection. + The number of objects in the collection. + + + Gets a value that indicates whether access to the collection is synchronized (thread safe). + + if access to the is synchronized; otherwise, . + + + Gets the collection item with the specified name. + The name of the object. + The object with the specified . + + + Gets the object to synchronize access to the collection. + The object to synchronize access to the collection. + + + Provides an exception for read-only objects. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class based on the supplied parameters. + The object that holds the serialized object data about the exception being thrown. + The object that contains contextual information about the source or destination of the serialized stream. + + + Initializes a new instance of the class based on a supplied parameter. + A string containing an exception message. + + + Initializes a new instance of the class based on supplied parameters. + A string containing an exception message. + The exception that is the cause of the current exception. + + + Provides an exception for objects that are not found. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class, based on supplied parameters. + The object that holds the serialized object data about the exception being thrown. + The object that contains contextual information about the source or destination of the serialized stream. + + + Initializes a new instance of the class, based on a supplied parameter. + A string containing an exception message. + + + Initializes a new instance of the class, based on supplied parameters. + A string containing an exception message. + The exception that is the cause of the current exception. + + + Contains the value of a settings property that can be loaded and stored by an instance of . + + + Initializes a new instance of the class, based on supplied parameters. + Specifies a object. + + + Gets or sets whether the value of a object has been deserialized. + + if the value of a object has been deserialized; otherwise, . + + + Gets or sets whether the value of a object has changed. + + if the value of a object has changed; otherwise, . + + + Gets the name of the property from the associated object. + The name of the object. + + + Gets the object. + The object that describes the object. + + + Gets or sets the value of the object. + While attempting to use the default value from the property, an error occurred. Either the attempt to convert property to a valid type failed, or the resulting value was not compatible with the type defined by . + The value of the object. When this value is set, the property is set to and is set to . + + When a value is first accessed from the property, and if the value was initially stored into the object as a serialized representation using the property, the property will trigger deserialization of the underlying value. As a side effect, the property will be set to . + + If this chain of events occurs in ASP.NET, and if an error occurs during the deserialization process, the error is logged using the health-monitoring feature of ASP.NET. By default, this means that deserialization errors will show up in the Application Event Log when running under ASP.NET. If this process occurs outside of ASP.NET, and if an error occurs during deserialization, the error is suppressed, and the remainder of the logic during deserialization occurs. If there is no serialized value to deserialize when the deserialization is attempted, then object will instead attempt to return a default value if one was configured as defined on the associated instance. In this case, if the property was set to either , or to the string "[null]", then the object will initialize the property to either for reference types, or to the default value for the associated value type. On the other hand, if property holds a valid object reference or string value (other than "[null]"), then the property is returned instead. + + If there is no serialized value to deserialize when the deserialization is attempted, and no default value was specified, then an empty string will be returned for string types. For all other types, a default instance will be returned by calling - for reference types this means an attempt will be made to create an object instance using the parameterless constructor. If this attempt fails, then is returned. + + + Gets or sets the serialized value of the object. + The serialization options for the property indicated the use of a string type converter, but a type converter was not available. + The serialized value of a object. + + + Gets a Boolean value specifying whether the value of the object is the default value as defined by the property value on the associated object. + + if the value of the object is the default value; otherwise, . + + + Contains a collection of settings property values that map objects to objects. + + + Initializes a new instance of the class. + + + Adds a object to the collection. + A object. + An attempt was made to add an item to the collection, but the collection was marked as read-only. + + + Removes all objects from the collection. + + + Creates a copy of the existing collection. + A class. + + + Copies this collection to an array. + The array to copy the collection to. + The index at which to begin copying. + + + Gets the object as it applies to the collection. + The object as it applies to the collection. + + + Removes a object from the collection. + The name of the object. + An attempt was made to remove an item from the collection, but the collection was marked as read-only. + + + Sets the collection to be read-only. + + + Gets a value that specifies the number of objects in the collection. + The number of objects in the collection. + + + Gets a value that indicates whether access to the collection is synchronized (thread safe). + + if access to the collection is synchronized; otherwise, . + + + Gets an item from the collection. + A object. + The object with the specified . + + + Gets the object to synchronize access to the collection. + The object to synchronize access to the collection. + + + Provides an exception that is thrown when an invalid type is used with a object. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class based on the supplied parameters. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination of the serialized stream. + + + Initializes a new instance of the class based on the supplied parameter. + A string containing an exception message. + + + Initializes a new instance of the class based on the supplied parameters. + A string containing an exception message. + The exception that is the cause of the current exception. + + + Acts as a base class for deriving custom settings providers in the application settings architecture. + + + Initializes an instance of the class. + + + Returns the collection of settings property values for the specified application instance and settings property group. + A describing the current application use. + A containing the settings property group whose values are to be retrieved. + A containing the values for the specified settings property group. + + + Sets the values of the specified group of property settings. + A describing the current application usage. + A representing the group of property settings to set. + + + Gets or sets the name of the currently running application. + A that contains the application's shortened name, which does not contain a full path or extension, for example, SimpleAppSettings. + + + Specifies the settings provider used to provide storage for the current application settings class or property. This class cannot be inherited. + + + Initializes an instance of the class. + A containing the name of the settings provider. + + + Initializes a new instance of the class. + A containing the settings provider type. + + + Gets the type name of the settings provider. + A containing the name of the settings provider. + + + Represents a collection of application settings providers. + + + Initializes a new instance of the class. + + + Adds a new settings provider to the collection. + A to add to the collection. + The parameter is not of type . + + -or- + + The property of the provider parameter is null or an empty string. + + -or- + + A settings provider with the same already exists in the collection. + The collection is read-only. + The parameter is . + + + Gets the settings provider in the collection that matches the specified name. + A containing the friendly name of the settings provider. + The parameter is . + The collection is read-only when setting this value. + If found, the whose name matches that specified by the name parameter; otherwise, . + + + Represents the method that will handle the event. + The source of the event, typically a data container or data-bound collection. + A that contains the event data. + + + Determines the serialization scheme used to store application settings. + + + The settings property is serialized using binary object serialization. + + + The settings provider has implicit knowledge of the property or its type and picks an appropriate serialization mechanism. Often used for custom serialization. + + + The settings property is serialized as plain text. + + + The settings property is serialized as XML using XML serialization. + + + Specifies the serialization mechanism that the settings provider should use. This class cannot be inherited. + + + Initializes an instance of the class. + A enumerated value that specifies the serialization scheme. + + + Gets the enumeration value that specifies the serialization scheme. + A enumerated value that specifies the serialization scheme. + + + Contains the XML representing the serialized value of the setting. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Compares the current instance to the specified object. + The object to compare. + + if the instance is equal to the specified object; otherwise, . + + + Gets a unique value representing the current instance. + A unique value representing the current instance. + + + Gets or sets the value of a object by using an object. + An object containing the value of a . + + + Handles configuration sections that are represented by a single XML tag in the .config file. + + + Initializes a new instance of the class. + + + Used internally to create a new instance of this object. + The parent of this object. + The context of this object. + The object in the configuration. + The created object handler. + + + Specifies the special setting category of a application settings property. + + + The configuration property represents a connection string, typically for a data store or network resource. + + + The configuration property represents a Uniform Resource Locator (URL) to a Web service. + + + Indicates that an application settings property has a special significance. This class cannot be inherited. + + + Initializes a new instance of the class. + A enumeration value defining the category of the application settings property. + + + Gets the value describing the special setting category of the application settings property. + A enumeration value defining the category of the application settings property. + + + Provides validation of a string. + + + Initializes a new instance of the class, based on a supplied parameter. + An integer that specifies the minimum length of the string value. + + + Initializes a new instance of the class, based on supplied parameters. + An integer that specifies the minimum length of the string value. + An integer that specifies the maximum length of the string value. + + + Initializes a new instance of the class, based on supplied parameters. + An integer that specifies the minimum length of the string value. + An integer that specifies the maximum length of the string value. + A string that represents invalid characters. + + + Determines whether an object can be validated based on type. + The object type. + + if the parameter matches a string; otherwise, . + + + Determines whether the value of an object is valid. + The object value. + + is less than or greater than as defined in the constructor. + +-or- + + contains invalid characters. + + + Declaratively instructs the .NET Framework to perform string validation on a configuration property. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Gets or sets the invalid characters for the property. + The string that contains the set of characters that are not allowed for the property. + + + Gets or sets the maximum length allowed for the string to assign to the property. + The selected value is less than . + An integer that indicates the maximum allowed length for the string to assign to the property. + + + Gets or sets the minimum allowed value for the string to assign to the property. + The selected value is greater than . + An integer that indicates the allowed minimum length for the string to assign to the property. + + + Gets an instance of the class. + A current settings in a validator instance. + + + Validates that an object is a derived class of a specified type. + + + Initializes a new instance of the class. + The base class to validate against. + + is . + + + Determines whether an object can be validated based on type. + The object type. + + if the parameter matches a type that can be validated; otherwise, . + + + Determines whether the value of an object is valid. + The object value. + + is not of a that can be derived from as defined in the constructor. + + + Declaratively instructs the .NET Framework to perform validation on a configuration property. This class cannot be inherited. + + + Initializes a new instance of the class. + The base class type. + + + Gets the base type of the object being validated. + The base type of the object being validated. + + + Gets the validator attribute instance. + The current instance. + + + Converts a time span expressed in minutes. + + + Initializes a new instance of the class. + + + Converts a to a . + The object used for type conversions. + The object used during conversion. + The object to convert. + The representing the parameter in minutes. + + + Converts a to a . + The object used for type conversions. + The object used during conversion. + The value to convert to. + The type to convert to. + The representing the parameter in minutes. + + + Converts a expressed in minutes or as a standard infinite time span. + + + Initializes a new instance of the class. + + + Converts a to a . + The object used for type conversions. + The object used during conversion. + The object to convert. + The , if the parameter is the "infinite"; otherwise, the representing the parameter in minutes. + + + Converts a to a . + The object used for type conversions. + The object used during conversion. + The value to convert. + The conversion type. + The "infinite", if the parameter is ; otherwise, the representing the parameter in minutes. + + + Converts a time span expressed in seconds. + + + Initializes a new instance of the class. + + + Converts a to a . + The object used for type conversions. + The object used during conversion. + The object to convert. + + cannot be parsed as an integer value. + The representing the parameter in seconds. + + + Converts a to a . + The object used for type conversions. + The object used during conversion. + The value to convert to. + The type to convert to. + The that represents the parameter in minutes. + + + Converts a expressed in seconds or as a standard infinite time span. + + + Initializes a new instance of the class. + + + Converts a to a . + The object used for type conversions. + The object used during conversion. + The object to convert. + The , if the parameter is the "infinite"; otherwise, the representing the parameter in seconds. + + + Converts a to a. . + The object used for type conversions. + The object used during conversion. + The value to convert. + The conversion type. + The "infinite", if the parameter is ; otherwise, the representing the parameter in seconds. + + + Provides validation of a object. + + + Initializes a new instance of the class, based on supplied parameters. + A object that specifies the minimum time allowed to pass validation. + A object that specifies the maximum time allowed to pass validation. + + + Initializes a new instance of the class, based on supplied parameters. + A object that specifies the minimum time allowed to pass validation. + A object that specifies the maximum time allowed to pass validation. + A value that specifies whether the validation range is exclusive. + + + Initializes a new instance of the class, based on supplied parameters. + A object that specifies the minimum time allowed to pass validation. + A object that specifies the maximum time allowed to pass validation. + A value that specifies whether the validation range is exclusive. + An value that specifies a number of seconds. + + is less than . + +-or- + + is greater than . + + + Determines whether the type of the object can be validated. + The type of the object. + + if the parameter matches a value; otherwise, . + + + Determines whether the value of an object is valid. + The value of an object. + + + Declaratively instructs the .NET Framework to perform time validation on a configuration property. This class cannot be inherited. + + + Gets the absolute maximum value allowed. + + + Gets the absolute minimum value allowed. + + + Initializes a new instance of the class. + + + Gets or sets a value that indicates whether to include or exclude the integers in the range as defined by and . + + if the value must be excluded; otherwise, . The default is . + + + Gets the absolute maximum value. + The allowed maximum value. + + + Gets or sets the relative maximum value. + The selected value represents less than . + The allowed maximum value. + + + Gets the absolute minimum value. + The allowed minimum value. + + + Gets or sets the relative minimum value. + The selected value represents more than . + The minimum allowed value. + + + Gets an instance of the class. + The validator instance. + + + Converts between type and string values. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Converts a object to a object. + The object used for type conversions. + The object used during conversion. + The object to convert. + The value cannot be resolved. + The that represents the parameter. + + + Converts a object to a object. + The object used for type conversions. + The object used during conversion. + The value to convert to. + The type to convert to. + The that represents the parameter. + + + Represents the Uri section within a configuration file. + + + Initializes a new instance of the class. + + + Gets an object that contains the configuration setting for International Domain Name (IDN) processing in the class. + The configuration setting for International Domain Name (IDN) processing in the class. + + + Gets an object that contains the configuration setting for International Resource Identifiers (IRI) parsing in the class. + The configuration setting for International Resource Identifiers (IRI) parsing in the class. + + + Gets a object that contains the configuration settings for scheme parsing in the class. + The configuration settings for scheme parsing in the class + + + Specifies that an application settings group or property contains distinct values for each user of an application. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Represents a grouping of related user settings sections within a configuration file. This class cannot be inherited. + + + Initializes a new instance of the class. + + + Represents a method to be called after the validation of an object. + The callback method. + + + Converts a string to its canonical format. + + + Initializes a new instance of the class. + + + Converts a to canonical form. + The object used for type conversions. + The object used during conversion. + The object to convert. + An object representing the converted value. + + + Converts a to canonical form. + The object used for type conversions. + The object used during conversion. + The value to convert to. + The type to convert to. + An object representing the converted value. + + + Represents the configuration section used by classes in the namespace. + + + Initializes a new instance of the class. + + + Gets or sets the suffix to append to a file name indicated by a when an assembly is declared with a or a . + The bitmap suffix. + + + Provides the possible values for the configuration setting of the in the namespace. + + + This value will convert any Unicode domain names to their Punycode equivalents (IDN names). + + + This value will convert all external Unicode domain names to use the Punycode equivalents (IDN names). In this case to handle international names on the local Intranet, the DNS servers that are used for the Intranet should support Unicode names. + + + This value will not convert any Unicode domain names to use Punycode. This is the default value which is consistent with the .NET Framework 2.0 behavior. + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/System.Diagnostics.DiagnosticSource.dll b/app_data/jobs/triggered/utility/System.Diagnostics.DiagnosticSource.dll new file mode 100644 index 000000000..d0bc651cd Binary files /dev/null and b/app_data/jobs/triggered/utility/System.Diagnostics.DiagnosticSource.dll differ diff --git a/app_data/jobs/triggered/utility/System.Diagnostics.DiagnosticSource.xml b/app_data/jobs/triggered/utility/System.Diagnostics.DiagnosticSource.xml new file mode 100644 index 000000000..fe0a7d7c0 --- /dev/null +++ b/app_data/jobs/triggered/utility/System.Diagnostics.DiagnosticSource.xml @@ -0,0 +1,438 @@ + + + + System.Diagnostics.DiagnosticSource + + + + Represents an operation with context to be used for logging. + + + Initializes a new instance of the class. + The name of the operation. + + + Gets the flags (defined by the W3C ID specification) associated with the activity. + the flags associated with the activity. + + + Updates the to have a new baggage item with the specified key and value. + The baggage key. + The baggage value. + + for convenient chaining. + + + Updates the to have a new tag with the provided and . . + The tag key. + The tag value. + + for convenient chaining. + + + Gets a collection of key/value pairs that represents information that is passed to children of this . + An enumeration of string-string key-value pairs. + + + Gets or sets the current operation () for the current thread. This flows across async calls. + The current operation for the current thread. + + + Gets or sets the default ID format for the . + + + Gets the duration of the operation. + The delta between and the end time if the has ended ( or was called), or if the has not ended and was not called. + + + Gets or sets a valud that detrmines if the is always used to define the default ID format. + + to always use the ; otherwise, . + + + Returns the value of a key-value pair added to the activity with . + The baggage key. + The value of the key-value-pair item if it exists, or if it does not exist. + + + Gets an identifier that is specific to a particular request. + The activity ID. + + + Gets the format for the . + The format for the . + + + Gets the operation name. + The name of the operation. + + + Gets the parent that created this activity. + The parent of this , if it is from the same process, or if this instance has no parent (it is a root activity) or if the parent is from outside the process. + + + Gets the ID of this activity's parent. + The parent ID, if one exists, or if it does not. + + + Gets the parent's . + The parent's . + + + Gets a value that indicates whether the W3CIdFlags.Recorded flag is set. + + if the W3CIdFlags.Recorded flag is set; otherwise, . + + + Gets the root ID of this . + The root ID, or if the current instance has either a or an . + + + Updates the to set its as the difference between and the specified stop time. + The UTC stop time. + + for convenient chaining. + + + Sets the ID format on this before it is started. + One of the enumeration values that specifies the format of the property. + + for convenient chaining. + + + Sets the parent ID using the W3C convention of a TraceId and a SpanId. + The parent activity's TraceId. + The parent activity's SpanId. + One of the enumeration values that specifies flags defined by the W3C standard that are associated with an activity. + + for convenient chaining. + + + Updates this to indicate that the with an ID of caused this . + The ID of the parent operation. + + for convenient chaining. + + + Sets the start time of this . + The start time in UTC. + + for convenient chaining. + + + Gets the SPAN part of the . + The ID for the SPAN part of , if the has the W3C format; otherwise, a zero . + + + Starts the activity. + + for convenient chaining. + + + Gets the time when the operation started. + The UTC time that the operation started. + + + Stops the activity. + + + Gets a collection of key/value pairs that represent information that will be logged along with the to the logging system. + An enumeration of string-string key-value-pairs. + + + Gets the TraceId part of the . + The ID for the TraceId part of the , if the ID has the W3C format; otherwise, a zero TraceId. + + + Gets the W3C header. + The W3C header. + + + Specifies the format of the property. + + + The hierarchical format. + + + An unknown format. + + + The W3C format. + + + Represents a formatted based on a W3C standard. + + + Copies the 8 bytes of the current to a specified span. + The span to which the 8 bytes of the SpanID are to be copied. + + + Creates a new value from a read-only span of eight bytes. + A read-only span of eight bytes. + The new span ID. + + does not contain eight bytes. + + + Creates a new value from a read-only span of 16 hexadecimal characters. + A span that contains 16 hexadecimal characters. + The new span ID. + + does not contain 16 hexadecimal characters. +-or- +The characters in are not all lower-case hexadecimal characters or all zeros. + + + Creates a new value from a read-only span of UTF8-encoded bytes. + A read-only span of UTF8-encoded bytes. + The new span ID. + + + Creates a new based on a random number (that is very likely to be unique). + The new span ID. + + + Determines whether this instance and the specified instance have the same value. + The instance to compare. + + if has the same hex value as the current instance; otherwise, . + + + the current instance and a specified object, which also must be an instance, have the same value. + The object to compare. + + if is an instance of and has the same hex value as the current instance; otherwise, . + + + Returns the hash code of the SpanId. + The hash code of the SpanId. + + + Determines whether two specified instances have the same value. + The first instance to compare. + The second instance to compare. + + if the SpanId of is the same as the SpanId of ; otherwise, . + + + Determine whether two specified instances have unequal values. + The first instance to compare. + The second instance to compare. + + if the SpanId of is different from the SpanId of ; otherwise, . + + + Returns a 16-character hexadecimal string that represents this span ID. + The 16-character hecxadecimal string representation of this span ID. + + + Returns a 16-character hexadecimal string that represents this span ID. + The 16-character hexadecimal string representation of this span ID. + + + Specifies flags defined by the W3C standard that are associated with an activity. + + + The activity has not been marked. + + + The activity (or more likely its parents) has been marked as useful to record. + + + Represents a whose format is based on a W3C standard. + + + Copies the 16 bytes of the current to a specified span. + The span to which the 16 bytes of the trace ID are to be copied. + + + Creates a new value from a read-only span of 16 bytes. + A read-only span of 16 bytes. + The new trace ID. + + does not contain eight bytes. + + + Creates a new value from a read-only span of 32 hexadecimal characters. + A span that contains 32 hexadecimal characters. + The new trace ID. + + does not contain 16 hexadecimal characters. +-or- +The characters in are not all lower-case hexadecimal characters or all zeros. + + + Creates a new value from a read-only span of UTF8-encoded bytes. + A read-only span of UTF8-encoded bytes. + The new trace ID. + + + Creates a new based on a random number (that is very likely to be unique). + The new span ID. + + + Determines whether the current instance and a specified are equal. + The instance to compare. + + if has the same hex value as the current instance; otherwise, . + + + Determines whether this instance and a specified object, which must also be an instance, have the same value. + The object to compare. + + if is an instance of and has the same hex value as the current instance; otherwise, . + + + Returns the hash code of the TraceId. + The hash code of the TraceId. + + + Determines whether two specified instances have the same value. + The first instance to compare. + The second instance to compare. + + if the TraceId of is the same as the TraceId of ; otherwise, . + + + Determines whether two specified instances have the same value. + The first instance to compare. + The second instance to compare. + + if the TraceId of is different from the TraceId of ; otherwise, . + + + Returns a 16-character hexadecimal string that represents this span ID. + The 32-character hexadecimal string representation of this trace ID. + + + Returns a 32-character hexadecimal string that represents this trace ID. + The 32-character hecxadecimal string representation of this trace ID. + + + Provides an implementation of the abstract class that represents a named place to which a source sends its information (events). + + + Creates a new . + The name of this . + + + Gets the collection of listeners for this . + + + Disposes the NotificationListeners. + + + Determines whether there are any registered subscribers. + + if there are any registered subscribers, otherwise. + + + Checks whether the is enabled. + + + if notifications are enabled; otherwise, . + + + Checks if the DiagnosticListener is enabled. + + + + + if it is enabled, otherwise. + + + Gets the name of this . + The name of the . + + + Invokes the OnActivityExport method of all the subscribers. + The activity affected by an external event. + An object that represents the outgoing request. + + + Invokes the OnActivityImport method of all the subscribers. + The activity affected by an external event. + An object that represents the incoming request. + + + Adds a subscriber. + A subscriber. + A reference to an interface that allows the listener to stop receiving notifications before the has finished sending them. + + + Adds a subscriber, and optionally filters events based on their name and up to two context objects. + A subscriber. + A delegate that filters events based on their name and up to two context objects (which can be ), or to if an event filter is not desirable. + A reference to an interface that allows the listener to stop receiving notifications before the has finished sending them. + + + Adds a subscriber, optionally filters events based on their name and up to two context objects, and specifies methods to call when providers import or export activites from outside the process. + A subscriber. + A delegate that filters events based on their name and up to two context objects (which can be ), or if an event filter is not desirable. + An action delegate that receives the activity affected by an external event and an object that represents the incoming request. + An action delegate that receives the activity affected by an external event and an object that represents the outgoing request. + A reference to an interface that allows the listener to stop receiving notifications before the has finished sending them. + + + Adds a subscriber, and optionally filters events based on their name. + A subscriber. + A delegate that filters events based on their name (). The delegate should return if the event is enabled. + A reference to an interface that allows the listener to stop receiving notifications before the has finished sending them. + + + Returns a string with the name of this DiagnosticListener. + The name of this DiagnosticListener. + + + Logs a notification. + The name of the event to log. + An object that represents the payload for the event. + + + An abstract class that allows code to be instrumented for production-time logging of rich data payloads for consumption within the process that was instrumented. + + + Initializes an instance of the class. + + + Verifies if the notification event is enabled. + The name of the event being written. + + if the notification event is enabled, otherwise. + + + Verifies it the notification event is enabled. + The name of the event being written. + An object that represents the additional context for IsEnabled. Consumers should expect to receive which may indicate that producer called pure IsEnabled(string) to check if consumer wants to get notifications for such events at all. Based on that, producer may call IsEnabled(string, object, object) again with non- context. + Optional. An object that represents the additional context for IsEnabled. by default. Consumers should expect to receive which may indicate that producer called pure IsEnabled(string) or producer passed all necessary context in . + + if the notification event is enabled, otherwise. + + + Transfers state from an activity to some event or operation, such as an outgoing HTTP request, that will occur outside the process. + The activity affected by an external event. + An object that represents the outgoing request. + + + Transfers state to an activity from some event or operation, such as an incoming request, that occurred outside the process. + The activity affected by an external event. + A payload that represents the incoming request. + + + Starts an and writes a start event. + The to be started. + An object that represent the value being passed as a payload for the event. + The started activity for convenient chaining. + + + Stops the given , maintains the global activity, and notifies consumers that the was stopped. + The activity to be stopped. + An object that represents the value passed as a payload for the event. + + + Provides a generic way of logging complex payloads. + The name of the event being written. + An object that represents the value being passed as a payload for the event. This is often an anonymous type which contains several sub-values. + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/System.Memory.Data.dll b/app_data/jobs/triggered/utility/System.Memory.Data.dll new file mode 100644 index 000000000..e36c2c870 Binary files /dev/null and b/app_data/jobs/triggered/utility/System.Memory.Data.dll differ diff --git a/app_data/jobs/triggered/utility/System.Memory.Data.xml b/app_data/jobs/triggered/utility/System.Memory.Data.xml new file mode 100644 index 000000000..1698023ed --- /dev/null +++ b/app_data/jobs/triggered/utility/System.Memory.Data.xml @@ -0,0 +1,167 @@ + + + + System.Memory.Data + + + + + A lightweight abstraction for a payload of bytes that supports converting between string, stream, JSON, and bytes. + + + + + The backing store for the instance. + + + + + Creates a instance by wrapping the + provided byte array. + + The array to wrap. + + + + Creates a instance by serializing the provided object to JSON + using . + + + The object that will be serialized to JSON using + . + The options to use when serializing to JSON. + The type to use when serializing the data. If not specified, will + be used to determine the type. + + + + Creates a instance by wrapping the + provided bytes. + + Byte data to wrap. + + + + Creates a instance from a string by converting + the string to bytes using the UTF-8 encoding. + + The string data. + + + + Creates a instance by wrapping the provided + . + + Byte data to wrap. + A wrapper over . + + + + Creates a instance by wrapping the provided + byte array. + + The array to wrap. + A wrapper over . + + + + Creates a instance from a string by converting + the string to bytes using the UTF-8 encoding. + + The string data. + A value representing the UTF-8 encoding of . + + + + Creates a instance from the specified stream. + The stream is not disposed by this method. + + Stream containing the data. + A value representing all of the data remaining in . + + + + Creates a instance from the specified stream. + The stream is not disposed by this method. + + Stream containing the data. + A token that may be used to cancel the operation. + A value representing all of the data remaining in . + + + + Creates a instance by serializing the provided object using + the . + + + The type to use when serializing the data. + The data to use. + The options to use when serializing to JSON. + + A value representing the UTF-8 encoding of the JSON representation of . + + + + Converts the value of this instance to a string using UTF-8. + + + A string from the value of this instance, using UTF-8 to decode the bytes. + + + + + Converts the to a read-only stream. + + A stream representing the data. + + + + Gets the value of this instance as bytes without any further interpretation. + + The value of this instance as bytes without any further interpretation. + + + + Converts the to a byte array. + + A byte array representing the data. + + + + Converts the to the specified type using + . + + The type that the data should be + converted to. + The to use when serializing to JSON. + The data converted to the specified type. + + + + Defines an implicit conversion from a to a . + + The value to be converted. + + + + Defines an implicit conversion from a to a . + + The value to be converted. + + + + Determines whether the specified object is equal to the current object. + + The object to compare with the current object. + + if the specified object is equal to the current object; otherwise, . + + + + + + + Provides a for the contents of a . + + + diff --git a/app_data/jobs/triggered/utility/System.Memory.dll b/app_data/jobs/triggered/utility/System.Memory.dll new file mode 100644 index 000000000..5d1947056 Binary files /dev/null and b/app_data/jobs/triggered/utility/System.Memory.dll differ diff --git a/app_data/jobs/triggered/utility/System.Memory.xml b/app_data/jobs/triggered/utility/System.Memory.xml new file mode 100644 index 000000000..4d12fd71e --- /dev/null +++ b/app_data/jobs/triggered/utility/System.Memory.xml @@ -0,0 +1,355 @@ + + + System.Memory + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/System.Numerics.Vectors.dll b/app_data/jobs/triggered/utility/System.Numerics.Vectors.dll new file mode 100644 index 000000000..08659724d Binary files /dev/null and b/app_data/jobs/triggered/utility/System.Numerics.Vectors.dll differ diff --git a/app_data/jobs/triggered/utility/System.Numerics.Vectors.xml b/app_data/jobs/triggered/utility/System.Numerics.Vectors.xml new file mode 100644 index 000000000..da34d390c --- /dev/null +++ b/app_data/jobs/triggered/utility/System.Numerics.Vectors.xml @@ -0,0 +1,2621 @@ + + + System.Numerics.Vectors + + + + Represents a 3x2 matrix. + + + Creates a 3x2 matrix from the specified components. + The value to assign to the first element in the first row. + The value to assign to the second element in the first row. + The value to assign to the first element in the second row. + The value to assign to the second element in the second row. + The value to assign to the first element in the third row. + The value to assign to the second element in the third row. + + + Adds each element in one matrix with its corresponding element in a second matrix. + The first matrix. + The second matrix. + The matrix that contains the summed values of value1 and value2. + + + Creates a rotation matrix using the given rotation in radians. + The amount of rotation, in radians. + The rotation matrix. + + + Creates a rotation matrix using the specified rotation in radians and a center point. + The amount of rotation, in radians. + The center point. + The rotation matrix. + + + Creates a scaling matrix from the specified X and Y components. + The value to scale by on the X axis. + The value to scale by on the Y axis. + The scaling matrix. + + + Creates a scaling matrix that scales uniformly with the specified scale with an offset from the specified center. + The uniform scale to use. + The center offset. + The scaling matrix. + + + Creates a scaling matrix that is offset by a given center point. + The value to scale by on the X axis. + The value to scale by on the Y axis. + The center point. + The scaling matrix. + + + Creates a scaling matrix that scales uniformly with the given scale. + The uniform scale to use. + The scaling matrix. + + + Creates a scaling matrix from the specified vector scale. + The scale to use. + The scaling matrix. + + + Creates a scaling matrix from the specified vector scale with an offset from the specified center point. + The scale to use. + The center offset. + The scaling matrix. + + + Creates a skew matrix from the specified angles in radians. + The X angle, in radians. + The Y angle, in radians. + The skew matrix. + + + Creates a skew matrix from the specified angles in radians and a center point. + The X angle, in radians. + The Y angle, in radians. + The center point. + The skew matrix. + + + Creates a translation matrix from the specified 2-dimensional vector. + The translation position. + The translation matrix. + + + Creates a translation matrix from the specified X and Y components. + The X position. + The Y position. + The translation matrix. + + + Returns a value that indicates whether this instance and another 3x2 matrix are equal. + The other matrix. + true if the two matrices are equal; otherwise, false. + + + Returns a value that indicates whether this instance and a specified object are equal. + The object to compare with the current instance. + true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. + + + Calculates the determinant for this matrix. + The determinant. + + + Returns the hash code for this instance. + The hash code. + + + Gets the multiplicative identity matrix. + The multiplicative identify matrix. + + + Inverts the specified matrix. The return value indicates whether the operation succeeded. + The matrix to invert. + When this method returns, contains the inverted matrix if the operation succeeded. + true if matrix was converted successfully; otherwise, false. + + + Indicates whether the current matrix is the identity matrix. + true if the current matrix is the identity matrix; otherwise, false. + + + Performs a linear interpolation from one matrix to a second matrix based on a value that specifies the weighting of the second matrix. + The first matrix. + The second matrix. + The relative weighting of matrix2. + The interpolated matrix. + + + The first element of the first row. + + + + The second element of the first row. + + + + The first element of the second row. + + + + The second element of the second row. + + + + The first element of the third row. + + + + The second element of the third row. + + + + Returns the matrix that results from multiplying two matrices together. + The first matrix. + The second matrix. + The product matrix. + + + Returns the matrix that results from scaling all the elements of a specified matrix by a scalar factor. + The matrix to scale. + The scaling value to use. + The scaled matrix. + + + Negates the specified matrix by multiplying all its values by -1. + The matrix to negate. + The negated matrix. + + + Adds each element in one matrix with its corresponding element in a second matrix. + The first matrix. + The second matrix. + The matrix that contains the summed values. + + + Returns a value that indicates whether the specified matrices are equal. + The first matrix to compare. + The second matrix to compare. + true if value1 and value2 are equal; otherwise, false. + + + Returns a value that indicates whether the specified matrices are not equal. + The first matrix to compare. + The second matrix to compare. + true if value1 and value2 are not equal; otherwise, false. + + + Returns the matrix that results from multiplying two matrices together. + The first matrix. + The second matrix. + The product matrix. + + + Returns the matrix that results from scaling all the elements of a specified matrix by a scalar factor. + The matrix to scale. + The scaling value to use. + The scaled matrix. + + + Subtracts each element in a second matrix from its corresponding element in a first matrix. + The first matrix. + The second matrix. + The matrix containing the values that result from subtracting each element in value2 from its corresponding element in value1. + + + Negates the specified matrix by multiplying all its values by -1. + The matrix to negate. + The negated matrix. + + + Subtracts each element in a second matrix from its corresponding element in a first matrix. + The first matrix. + The second matrix. + The matrix containing the values that result from subtracting each element in value2 from its corresponding element in value1. + + + Returns a string that represents this matrix. + The string representation of this matrix. + + + Gets or sets the translation component of this matrix. + The translation component of the current instance. + + + Represents a 4x4 matrix. + + + Creates a object from a specified object. + A 3x2 matrix. + + + Creates a 4x4 matrix from the specified components. + The value to assign to the first element in the first row. + The value to assign to the second element in the first row. + The value to assign to the third element in the first row. + The value to assign to the fourth element in the first row. + The value to assign to the first element in the second row. + The value to assign to the second element in the second row. + The value to assign to the third element in the second row. + The value to assign to the third element in the second row. + The value to assign to the first element in the third row. + The value to assign to the second element in the third row. + The value to assign to the third element in the third row. + The value to assign to the fourth element in the third row. + The value to assign to the first element in the fourth row. + The value to assign to the second element in the fourth row. + The value to assign to the third element in the fourth row. + The value to assign to the fourth element in the fourth row. + + + Adds each element in one matrix with its corresponding element in a second matrix. + The first matrix. + The second matrix. + The matrix that contains the summed values of value1 and value2. + + + Creates a spherical billboard that rotates around a specified object position. + The position of the object that the billboard will rotate around. + The position of the camera. + The up vector of the camera. + The forward vector of the camera. + The created billboard. + + + Creates a cylindrical billboard that rotates around a specified axis. + The position of the object that the billboard will rotate around. + The position of the camera. + The axis to rotate the billboard around. + The forward vector of the camera. + The forward vector of the object. + The billboard matrix. + + + Creates a matrix that rotates around an arbitrary vector. + The axis to rotate around. + The angle to rotate around axis, in radians. + The rotation matrix. + + + Creates a rotation matrix from the specified Quaternion rotation value. + The source Quaternion. + The rotation matrix. + + + Creates a rotation matrix from the specified yaw, pitch, and roll. + The angle of rotation, in radians, around the Y axis. + The angle of rotation, in radians, around the X axis. + The angle of rotation, in radians, around the Z axis. + The rotation matrix. + + + Creates a view matrix. + The position of the camera. + The target towards which the camera is pointing. + The direction that is &quot;up&quot; from the camera&#39;s point of view. + The view matrix. + + + Creates an orthographic perspective matrix from the given view volume dimensions. + The width of the view volume. + The height of the view volume. + The minimum Z-value of the view volume. + The maximum Z-value of the view volume. + The orthographic projection matrix. + + + Creates a customized orthographic projection matrix. + The minimum X-value of the view volume. + The maximum X-value of the view volume. + The minimum Y-value of the view volume. + The maximum Y-value of the view volume. + The minimum Z-value of the view volume. + The maximum Z-value of the view volume. + The orthographic projection matrix. + + + Creates a perspective projection matrix from the given view volume dimensions. + The width of the view volume at the near view plane. + The height of the view volume at the near view plane. + The distance to the near view plane. + The distance to the far view plane. + The perspective projection matrix. + nearPlaneDistance is less than or equal to zero. + -or- + farPlaneDistance is less than or equal to zero. + -or- + nearPlaneDistance is greater than or equal to farPlaneDistance. + + + Creates a perspective projection matrix based on a field of view, aspect ratio, and near and far view plane distances. + The field of view in the y direction, in radians. + The aspect ratio, defined as view space width divided by height. + The distance to the near view plane. + The distance to the far view plane. + The perspective projection matrix. + fieldOfView is less than or equal to zero. + -or- + fieldOfView is greater than or equal to . + nearPlaneDistance is less than or equal to zero. + -or- + farPlaneDistance is less than or equal to zero. + -or- + nearPlaneDistance is greater than or equal to farPlaneDistance. + + + Creates a customized perspective projection matrix. + The minimum x-value of the view volume at the near view plane. + The maximum x-value of the view volume at the near view plane. + The minimum y-value of the view volume at the near view plane. + The maximum y-value of the view volume at the near view plane. + The distance to the near view plane. + The distance to the far view plane. + The perspective projection matrix. + nearPlaneDistance is less than or equal to zero. + -or- + farPlaneDistance is less than or equal to zero. + -or- + nearPlaneDistance is greater than or equal to farPlaneDistance. + + + Creates a matrix that reflects the coordinate system about a specified plane. + The plane about which to create a reflection. + A new matrix expressing the reflection. + + + Creates a matrix for rotating points around the X axis. + The amount, in radians, by which to rotate around the X axis. + The rotation matrix. + + + Creates a matrix for rotating points around the X axis from a center point. + The amount, in radians, by which to rotate around the X axis. + The center point. + The rotation matrix. + + + The amount, in radians, by which to rotate around the Y axis from a center point. + The amount, in radians, by which to rotate around the Y-axis. + The center point. + The rotation matrix. + + + Creates a matrix for rotating points around the Y axis. + The amount, in radians, by which to rotate around the Y-axis. + The rotation matrix. + + + Creates a matrix for rotating points around the Z axis. + The amount, in radians, by which to rotate around the Z-axis. + The rotation matrix. + + + Creates a matrix for rotating points around the Z axis from a center point. + The amount, in radians, by which to rotate around the Z-axis. + The center point. + The rotation matrix. + + + Creates a scaling matrix from the specified vector scale. + The scale to use. + The scaling matrix. + + + Creates a uniform scaling matrix that scale equally on each axis. + The uniform scaling factor. + The scaling matrix. + + + Creates a scaling matrix with a center point. + The vector that contains the amount to scale on each axis. + The center point. + The scaling matrix. + + + Creates a uniform scaling matrix that scales equally on each axis with a center point. + The uniform scaling factor. + The center point. + The scaling matrix. + + + Creates a scaling matrix from the specified X, Y, and Z components. + The value to scale by on the X axis. + The value to scale by on the Y axis. + The value to scale by on the Z axis. + The scaling matrix. + + + Creates a scaling matrix that is offset by a given center point. + The value to scale by on the X axis. + The value to scale by on the Y axis. + The value to scale by on the Z axis. + The center point. + The scaling matrix. + + + Creates a matrix that flattens geometry into a specified plane as if casting a shadow from a specified light source. + The direction from which the light that will cast the shadow is coming. + The plane onto which the new matrix should flatten geometry so as to cast a shadow. + A new matrix that can be used to flatten geometry onto the specified plane from the specified direction. + + + Creates a translation matrix from the specified 3-dimensional vector. + The amount to translate in each axis. + The translation matrix. + + + Creates a translation matrix from the specified X, Y, and Z components. + The amount to translate on the X axis. + The amount to translate on the Y axis. + The amount to translate on the Z axis. + The translation matrix. + + + Creates a world matrix with the specified parameters. + The position of the object. + The forward direction of the object. + The upward direction of the object. Its value is usually [0, 1, 0]. + The world matrix. + + + Attempts to extract the scale, translation, and rotation components from the given scale, rotation, or translation matrix. The return value indicates whether the operation succeeded. + The source matrix. + When this method returns, contains the scaling component of the transformation matrix if the operation succeeded. + When this method returns, contains the rotation component of the transformation matrix if the operation succeeded. + When the method returns, contains the translation component of the transformation matrix if the operation succeeded. + true if matrix was decomposed successfully; otherwise, false. + + + Returns a value that indicates whether this instance and another 4x4 matrix are equal. + The other matrix. + true if the two matrices are equal; otherwise, false. + + + Returns a value that indicates whether this instance and a specified object are equal. + The object to compare with the current instance. + true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. + + + Calculates the determinant of the current 4x4 matrix. + The determinant. + + + Returns the hash code for this instance. + The hash code. + + + Gets the multiplicative identity matrix. + Gets the multiplicative identity matrix. + + + Inverts the specified matrix. The return value indicates whether the operation succeeded. + The matrix to invert. + When this method returns, contains the inverted matrix if the operation succeeded. + true if matrix was converted successfully; otherwise, false. + + + Indicates whether the current matrix is the identity matrix. + true if the current matrix is the identity matrix; otherwise, false. + + + Performs a linear interpolation from one matrix to a second matrix based on a value that specifies the weighting of the second matrix. + The first matrix. + The second matrix. + The relative weighting of matrix2. + The interpolated matrix. + + + The first element of the first row. + + + + The second element of the first row. + + + + The third element of the first row. + + + + The fourth element of the first row. + + + + The first element of the second row. + + + + The second element of the second row. + + + + The third element of the second row. + + + + The fourth element of the second row. + + + + The first element of the third row. + + + + The second element of the third row. + + + + The third element of the third row. + + + + The fourth element of the third row. + + + + The first element of the fourth row. + + + + The second element of the fourth row. + + + + The third element of the fourth row. + + + + The fourth element of the fourth row. + + + + Returns the matrix that results from multiplying two matrices together. + The first matrix. + The second matrix. + The product matrix. + + + Returns the matrix that results from scaling all the elements of a specified matrix by a scalar factor. + The matrix to scale. + The scaling value to use. + The scaled matrix. + + + Negates the specified matrix by multiplying all its values by -1. + The matrix to negate. + The negated matrix. + + + Adds each element in one matrix with its corresponding element in a second matrix. + The first matrix. + The second matrix. + The matrix that contains the summed values. + + + Returns a value that indicates whether the specified matrices are equal. + The first matrix to compare. + The second matrix to care + true if value1 and value2 are equal; otherwise, false. + + + Returns a value that indicates whether the specified matrices are not equal. + The first matrix to compare. + The second matrix to compare. + true if value1 and value2 are not equal; otherwise, false. + + + Returns the matrix that results from scaling all the elements of a specified matrix by a scalar factor. + The matrix to scale. + The scaling value to use. + The scaled matrix. + + + Returns the matrix that results from multiplying two matrices together. + The first matrix. + The second matrix. + The product matrix. + + + Subtracts each element in a second matrix from its corresponding element in a first matrix. + The first matrix. + The second matrix. + The matrix containing the values that result from subtracting each element in value2 from its corresponding element in value1. + + + Negates the specified matrix by multiplying all its values by -1. + The matrix to negate. + The negated matrix. + + + Subtracts each element in a second matrix from its corresponding element in a first matrix. + The first matrix. + The second matrix. + The matrix containing the values that result from subtracting each element in value2 from its corresponding element in value1. + + + Returns a string that represents this matrix. + The string representation of this matrix. + + + Transforms the specified matrix by applying the specified Quaternion rotation. + The matrix to transform. + The rotation t apply. + The transformed matrix. + + + Gets or sets the translation component of this matrix. + The translation component of the current instance. + + + Transposes the rows and columns of a matrix. + The matrix to transpose. + The transposed matrix. + + + Represents a three-dimensional plane. + + + Creates a object from a specified four-dimensional vector. + A vector whose first three elements describe the normal vector, and whose defines the distance along that normal from the origin. + + + Creates a object from a specified normal and the distance along the normal from the origin. + The plane&#39;s normal vector. + The plane&#39;s distance from the origin along its normal vector. + + + Creates a object from the X, Y, and Z components of its normal, and its distance from the origin on that normal. + The X component of the normal. + The Y component of the normal. + The Z component of the normal. + The distance of the plane along its normal from the origin. + + + Creates a object that contains three specified points. + The first point defining the plane. + The second point defining the plane. + The third point defining the plane. + The plane containing the three points. + + + The distance of the plane along its normal from the origin. + + + + Calculates the dot product of a plane and a 4-dimensional vector. + The plane. + The four-dimensional vector. + The dot product. + + + Returns the dot product of a specified three-dimensional vector and the normal vector of this plane plus the distance () value of the plane. + The plane. + The 3-dimensional vector. + The dot product. + + + Returns the dot product of a specified three-dimensional vector and the vector of this plane. + The plane. + The three-dimensional vector. + The dot product. + + + Returns a value that indicates whether this instance and a specified object are equal. + The object to compare with the current instance. + true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. + + + Returns a value that indicates whether this instance and another plane object are equal. + The other plane. + true if the two planes are equal; otherwise, false. + + + Returns the hash code for this instance. + The hash code. + + + The normal vector of the plane. + + + + Creates a new object whose normal vector is the source plane&#39;s normal vector normalized. + The source plane. + The normalized plane. + + + Returns a value that indicates whether two planes are equal. + The first plane to compare. + The second plane to compare. + true if value1 and value2 are equal; otherwise, false. + + + Returns a value that indicates whether two planes are not equal. + The first plane to compare. + The second plane to compare. + true if value1 and value2 are not equal; otherwise, false. + + + Returns the string representation of this plane object. + A string that represents this object. + + + Transforms a normalized plane by a 4x4 matrix. + The normalized plane to transform. + The transformation matrix to apply to plane. + The transformed plane. + + + Transforms a normalized plane by a Quaternion rotation. + The normalized plane to transform. + The Quaternion rotation to apply to the plane. + A new plane that results from applying the Quaternion rotation. + + + Represents a vector that is used to encode three-dimensional physical rotations. + + + Creates a quaternion from the specified vector and rotation parts. + The vector part of the quaternion. + The rotation part of the quaternion. + + + Constructs a quaternion from the specified components. + The value to assign to the X component of the quaternion. + The value to assign to the Y component of the quaternion. + The value to assign to the Z component of the quaternion. + The value to assign to the W component of the quaternion. + + + Adds each element in one quaternion with its corresponding element in a second quaternion. + The first quaternion. + The second quaternion. + The quaternion that contains the summed values of value1 and value2. + + + Concatenates two quaternions. + The first quaternion rotation in the series. + The second quaternion rotation in the series. + A new quaternion representing the concatenation of the value1 rotation followed by the value2 rotation. + + + Returns the conjugate of a specified quaternion. + The quaternion. + A new quaternion that is the conjugate of value. + + + Creates a quaternion from a vector and an angle to rotate about the vector. + The vector to rotate around. + The angle, in radians, to rotate around the vector. + The newly created quaternion. + + + Creates a quaternion from the specified rotation matrix. + The rotation matrix. + The newly created quaternion. + + + Creates a new quaternion from the given yaw, pitch, and roll. + The yaw angle, in radians, around the Y axis. + The pitch angle, in radians, around the X axis. + The roll angle, in radians, around the Z axis. + The resulting quaternion. + + + Divides one quaternion by a second quaternion. + The dividend. + The divisor. + The quaternion that results from dividing value1 by value2. + + + Calculates the dot product of two quaternions. + The first quaternion. + The second quaternion. + The dot product. + + + Returns a value that indicates whether this instance and another quaternion are equal. + The other quaternion. + true if the two quaternions are equal; otherwise, false. + + + Returns a value that indicates whether this instance and a specified object are equal. + The object to compare with the current instance. + true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. + + + Returns the hash code for this instance. + The hash code. + + + Gets a quaternion that represents no rotation. + A quaternion whose values are (0, 0, 0, 1). + + + Returns the inverse of a quaternion. + The quaternion. + The inverted quaternion. + + + Gets a value that indicates whether the current instance is the identity quaternion. + true if the current instance is the identity quaternion; otherwise, false. + + + Calculates the length of the quaternion. + The computed length of the quaternion. + + + Calculates the squared length of the quaternion. + The length squared of the quaternion. + + + Performs a linear interpolation between two quaternions based on a value that specifies the weighting of the second quaternion. + The first quaternion. + The second quaternion. + The relative weight of quaternion2 in the interpolation. + The interpolated quaternion. + + + Returns the quaternion that results from multiplying two quaternions together. + The first quaternion. + The second quaternion. + The product quaternion. + + + Returns the quaternion that results from scaling all the components of a specified quaternion by a scalar factor. + The source quaternion. + The scalar value. + The scaled quaternion. + + + Reverses the sign of each component of the quaternion. + The quaternion to negate. + The negated quaternion. + + + Divides each component of a specified by its length. + The quaternion to normalize. + The normalized quaternion. + + + Adds each element in one quaternion with its corresponding element in a second quaternion. + The first quaternion. + The second quaternion. + The quaternion that contains the summed values of value1 and value2. + + + Divides one quaternion by a second quaternion. + The dividend. + The divisor. + The quaternion that results from dividing value1 by value2. + + + Returns a value that indicates whether two quaternions are equal. + The first quaternion to compare. + The second quaternion to compare. + true if the two quaternions are equal; otherwise, false. + + + Returns a value that indicates whether two quaternions are not equal. + The first quaternion to compare. + The second quaternion to compare. + true if value1 and value2 are not equal; otherwise, false. + + + Returns the quaternion that results from scaling all the components of a specified quaternion by a scalar factor. + The source quaternion. + The scalar value. + The scaled quaternion. + + + Returns the quaternion that results from multiplying two quaternions together. + The first quaternion. + The second quaternion. + The product quaternion. + + + Subtracts each element in a second quaternion from its corresponding element in a first quaternion. + The first quaternion. + The second quaternion. + The quaternion containing the values that result from subtracting each element in value2 from its corresponding element in value1. + + + Reverses the sign of each component of the quaternion. + The quaternion to negate. + The negated quaternion. + + + Interpolates between two quaternions, using spherical linear interpolation. + The first quaternion. + The second quaternion. + The relative weight of the second quaternion in the interpolation. + The interpolated quaternion. + + + Subtracts each element in a second quaternion from its corresponding element in a first quaternion. + The first quaternion. + The second quaternion. + The quaternion containing the values that result from subtracting each element in value2 from its corresponding element in value1. + + + Returns a string that represents this quaternion. + The string representation of this quaternion. + + + The rotation component of the quaternion. + + + + The X value of the vector component of the quaternion. + + + + The Y value of the vector component of the quaternion. + + + + The Z value of the vector component of the quaternion. + + + + Represents a single vector of a specified numeric type that is suitable for low-level optimization of parallel algorithms. + The vector type. T can be any primitive numeric type. + + + Creates a vector whose components are of a specified type. + The numeric type that defines the type of the components in the vector. + + + Creates a vector from a specified array. + A numeric array. + values is null. + + + Creates a vector from a specified array starting at a specified index position. + A numeric array. + The starting index position from which to create the vector. + values is null. + index is less than zero. + -or- + The length of values minus index is less than . + + + Copies the vector instance to a specified destination array. + The array to receive a copy of the vector values. + destination is null. + The number of elements in the current vector is greater than the number of elements available in the destination array. + + + Copies the vector instance to a specified destination array starting at a specified index position. + The array to receive a copy of the vector values. + The starting index in destination at which to begin the copy operation. + destination is null. + The number of elements in the current instance is greater than the number of elements available from startIndex to the end of the destination array. + index is less than zero or greater than the last index in destination. + + + Returns the number of elements stored in the vector. + The number of elements stored in the vector. + Access to the property getter via reflection is not supported. + + + Returns a value that indicates whether this instance is equal to a specified vector. + The vector to compare with this instance. + true if the current instance and other are equal; otherwise, false. + + + Returns a value that indicates whether this instance is equal to a specified object. + The object to compare with this instance. + true if the current instance and obj are equal; otherwise, false. The method returns false if obj is null, or if obj is a vector of a different type than the current instance. + + + Returns the hash code for this instance. + The hash code. + + + Gets the element at a specified index. + The index of the element to return. + The element at index index. + index is less than zero. + -or- + index is greater than or equal to . + + + Returns a vector containing all ones. + A vector containing all ones. + + + Adds two vectors together. + The first vector to add. + The second vector to add. + The summed vector. + + + Returns a new vector by performing a bitwise And operation on each of the elements in two vectors. + The first vector. + The second vector. + The vector that results from the bitwise And of left and right. + + + Returns a new vector by performing a bitwise Or operation on each of the elements in two vectors. + The first vector. + The second vector. + The vector that results from the bitwise Or of the elements in left and right. + + + Divides the first vector by the second. + The first vector. + The second vector. + The vector that results from dividing left by right. + + + Returns a value that indicates whether each pair of elements in two specified vectors are equal. + The first vector to compare. + The second vector to compare. + true if left and right are equal; otherwise, false. + + + Returns a new vector by performing a bitwise XOr operation on each of the elements in two vectors. + The first vector. + The second vector. + The vector that results from the bitwise XOr of the elements in left and right. + + + Reinterprets the bits of the specified vector into a vector of type . + The vector to reinterpret. + The reinterpreted vector. + + + Reinterprets the bits of the specified vector into a vector of type . + The vector to reinterpret. + The reinterpreted vector. + + + Reinterprets the bits of the specified vector into a vector of type . + The vector to reinterpret. + The reinterpreted vector. + + + Reinterprets the bits of the specified vector into a vector of type . + The vector to reinterpret. + The reinterpreted vector. + + + Reinterprets the bits of the specified vector into a vector of type . + The vector to reinterpret. + The reinterpreted vector. + + + Reinterprets the bits of the specified vector into a vector of type . + The vector to reinterpret. + The reinterpreted vector. + + + Reinterprets the bits of the specified vector into a vector of type . + The vector to reinterpret. + The reinterpreted vector. + + + Reinterprets the bits of the specified vector into a vector of type . + The vector to reinterpret. + The reinterpreted vector. + + + Reinterprets the bits of the specified vector into a vector of type . + The vector to reinterpret. + The reinterpreted vector. + + + Reinterprets the bits of the specified vector into a vector of type . + The vector to reinterpret. + The reinterpreted vector. + + + Returns a value that indicates whether any single pair of elements in the specified vectors is equal. + The first vector to compare. + The second vector to compare. + true if any element pairs in left and right are equal. false if no element pairs are equal. + + + Multiplies two vectors together. + The first vector. + The second vector. + The product vector. + + + Multiplies a vector by a specified scalar value. + The source vector. + A scalar value. + The scaled vector. + + + Multiplies a vector by the given scalar. + The scalar value. + The source vector. + The scaled vector. + + + Returns a new vector whose elements are obtained by taking the one&#39;s complement of a specified vector&#39;s elements. + The source vector. + The one&#39;s complement vector. + + + Subtracts the second vector from the first. + The first vector. + The second vector. + The vector that results from subtracting right from left. + + + Negates a given vector. + The vector to negate. + The negated vector. + + + Returns the string representation of this vector using the specified format string to format individual elements and the specified format provider to define culture-specific formatting. + A or that defines the format of individual elements. + A format provider that supplies culture-specific formatting information. + The string representation of the current instance. + + + Returns the string representation of this vector using default formatting. + The string representation of this vector. + + + Returns the string representation of this vector using the specified format string to format individual elements. + A or that defines the format of individual elements. + The string representation of the current instance. + + + Returns a vector containing all zeroes. + A vector containing all zeroes. + + + Provides a collection of static convenience methods for creating, manipulating, combining, and converting generic vectors. + + + Returns a new vector whose elements are the absolute values of the given vector&#39;s elements. + The source vector. + The vector type. T can be any primitive numeric type. + The absolute value vector. + + + Returns a new vector whose values are the sum of each pair of elements from two given vectors. + The first vector. + The second vector. + The vector type. T can be any primitive numeric type. + The summed vector. + + + Returns a new vector by performing a bitwise And Not operation on each pair of corresponding elements in two vectors. + The first vector. + The second vector. + The vector type. T can be any primitive numeric type. + The resulting vector. + + + Reinterprets the bits of a specified vector into those of a vector of unsigned bytes. + The source vector. + The vector type. T can be any primitive numeric type. + The reinterpreted vector. + + + Reinterprets the bits of a specified vector into those of a double-precision floating-point vector. + The source vector. + The vector type. T can be any primitive numeric type. + The reinterpreted vector. + + + Reinterprets the bits of a specified vector into those of a vector of 16-bit integers. + The source vector. + The vector type. T can be any primitive numeric type. + The reinterpreted vector. + + + Reinterprets the bits of a specified vector into those of a vector of integers. + The source vector. + The vector type. T can be any primitive numeric type. + The reinterpreted vector. + + + Reinterprets the bits of a specified vector into those of a vector of long integers. + The source vector. + The vector type. T can be any primitive numeric type. + The reinterpreted vector. + + + Reinterprets the bits of a specified vector into those of a vector of signed bytes. + The source vector. + The vector type. T can be any primitive numeric type. + The reinterpreted vector. + + + Reinterprets the bits of a specified vector into those of a single-precision floating-point vector. + The source vector. + The vector type. T can be any primitive numeric type. + The reinterpreted vector. + + + Reinterprets the bits of a specified vector into those of a vector of unsigned 16-bit integers. + The source vector. + The vector type. T can be any primitive numeric type. + The reinterpreted vector. + + + Reinterprets the bits of a specified vector into those of a vector of unsigned integers. + The source vector. + The vector type. T can be any primitive numeric type. + The reinterpreted vector. + + + Reinterprets the bits of a specified vector into those of a vector of unsigned long integers. + The source vector. + The vector type. T can be any primitive numeric type. + The reinterpreted vector. + + + Returns a new vector by performing a bitwise And operation on each pair of elements in two vectors. + The first vector. + The second vector. + The vector type. T can be any primitive numeric type. + The resulting vector. + + + Returns a new vector by performing a bitwise Or operation on each pair of elements in two vectors. + The first vector. + The second vector. + The vector type. T can be any primitive numeric type. + The resulting vector. + + + Creates a new single-precision vector with elements selected between two specified single-precision source vectors based on an integral mask vector. + The integral mask vector used to drive selection. + The first source vector. + The second source vector. + The new vector with elements selected based on the mask. + + + Creates a new double-precision vector with elements selected between two specified double-precision source vectors based on an integral mask vector. + The integral mask vector used to drive selection. + The first source vector. + The second source vector. + The new vector with elements selected based on the mask. + + + Creates a new vector of a specified type with elements selected between two specified source vectors of the same type based on an integral mask vector. + The integral mask vector used to drive selection. + The first source vector. + The second source vector. + The vector type. T can be any primitive numeric type. + The new vector with elements selected based on the mask. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns a new vector whose values are the result of dividing the first vector&#39;s elements by the corresponding elements in the second vector. + The first vector. + The second vector. + The vector type. T can be any primitive numeric type. + The divided vector. + + + Returns the dot product of two vectors. + The first vector. + The second vector. + The vector type. T can be any primitive numeric type. + The dot product. + + + Returns a new integral vector whose elements signal whether the elements in two specified double-precision vectors are equal. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new integral vector whose elements signal whether the elements in two specified integral vectors are equal. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new vector whose elements signal whether the elements in two specified long integer vectors are equal. + The first vector to compare. + The second vector to compare. + The resulting long integer vector. + + + Returns a new integral vector whose elements signal whether the elements in two specified single-precision vectors are equal. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new vector of a specified type whose elements signal whether the elements in two specified vectors of the same type are equal. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + The resulting vector. + + + Returns a value that indicates whether each pair of elements in the given vectors is equal. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + true if all elements in left and right are equal; otherwise, false. + + + Returns a value that indicates whether any single pair of elements in the given vectors is equal. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + true if any element pair in left and right is equal; otherwise, false. + + + Returns a new integral vector whose elements signal whether the elements in one double-precision floating-point vector are greater than their corresponding elements in a second double-precision floating-point vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new integral vector whose elements signal whether the elements in one integral vector are greater than their corresponding elements in a second integral vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new long integer vector whose elements signal whether the elements in one long integer vector are greater than their corresponding elements in a second long integer vector. + The first vector to compare. + The second vector to compare. + The resulting long integer vector. + + + Returns a new integral vector whose elements signal whether the elements in one single-precision floating-point vector are greater than their corresponding elements in a second single-precision floating-point vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new vector whose elements signal whether the elements in one vector of a specified type are greater than their corresponding elements in the second vector of the same time. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + The resulting vector. + + + Returns a value that indicates whether all elements in the first vector are greater than the corresponding elements in the second vector. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + true if all elements in left are greater than the corresponding elements in right; otherwise, false. + + + Returns a value that indicates whether any element in the first vector is greater than the corresponding element in the second vector. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + true if any element in left is greater than the corresponding element in right; otherwise, false. + + + Returns a new integral vector whose elements signal whether the elements in one vector are greater than or equal to their corresponding elements in the single-precision floating-point second vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new long integer vector whose elements signal whether the elements in one long integer vector are greater than or equal to their corresponding elements in the second long integer vector. + The first vector to compare. + The second vector to compare. + The resulting long integer vector. + + + Returns a new integral vector whose elements signal whether the elements in one integral vector are greater than or equal to their corresponding elements in the second integral vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new integral vector whose elements signal whether the elements in one vector are greater than or equal to their corresponding elements in the second double-precision floating-point vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new vector whose elements signal whether the elements in one vector of a specified type are greater than or equal to their corresponding elements in the second vector of the same type. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + The resulting vector. + + + Returns a value that indicates whether all elements in the first vector are greater than or equal to all the corresponding elements in the second vector. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + true if all elements in left are greater than or equal to the corresponding elements in right; otherwise, false. + + + Returns a value that indicates whether any element in the first vector is greater than or equal to the corresponding element in the second vector. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + true if any element in left is greater than or equal to the corresponding element in right; otherwise, false. + + + Gets a value that indicates whether vector operations are subject to hardware acceleration through JIT intrinsic support. + true if vector operations are subject to hardware acceleration; otherwise, false. + + + Returns a new integral vector whose elements signal whether the elements in one double-precision floating-point vector are less than their corresponding elements in a second double-precision floating-point vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new integral vector whose elements signal whether the elements in one integral vector are less than their corresponding elements in a second integral vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector + + + Returns a new long integer vector whose elements signal whether the elements in one long integer vector are less than their corresponding elements in a second long integer vector. + The first vector to compare. + The second vector to compare. + The resulting long integer vector. + + + Returns a new integral vector whose elements signal whether the elements in one single-precision vector are less than their corresponding elements in a second single-precision vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new vector of a specified type whose elements signal whether the elements in one vector are less than their corresponding elements in the second vector. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + The resulting vector. + + + Returns a value that indicates whether all of the elements in the first vector are less than their corresponding elements in the second vector. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + true if all of the elements in left are less than the corresponding elements in right; otherwise, false. + + + Returns a value that indicates whether any element in the first vector is less than the corresponding element in the second vector. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + true if any element in left is less than the corresponding element in right; otherwise, false. + + + Returns a new integral vector whose elements signal whether the elements in one double-precision floating-point vector are less than or equal to their corresponding elements in a second double-precision floating-point vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new integral vector whose elements signal whether the elements in one integral vector are less than or equal to their corresponding elements in a second integral vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new long integer vector whose elements signal whether the elements in one long integer vector are less or equal to their corresponding elements in a second long integer vector. + The first vector to compare. + The second vector to compare. + The resulting long integer vector. + + + Returns a new integral vector whose elements signal whether the elements in one single-precision floating-point vector are less than or equal to their corresponding elements in a second single-precision floating-point vector. + The first vector to compare. + The second vector to compare. + The resulting integral vector. + + + Returns a new vector whose elements signal whether the elements in one vector are less than or equal to their corresponding elements in the second vector. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + The resulting vector. + + + Returns a value that indicates whether all elements in the first vector are less than or equal to their corresponding elements in the second vector. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + true if all of the elements in left are less than or equal to the corresponding elements in right; otherwise, false. + + + Returns a value that indicates whether any element in the first vector is less than or equal to the corresponding element in the second vector. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + true if any element in left is less than or equal to the corresponding element in right; otherwise, false. + + + Returns a new vector whose elements are the maximum of each pair of elements in the two given vectors. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + The maximum vector. + + + Returns a new vector whose elements are the minimum of each pair of elements in the two given vectors. + The first vector to compare. + The second vector to compare. + The vector type. T can be any primitive numeric type. + The minimum vector. + + + Returns a new vector whose values are a scalar value multiplied by each of the values of a specified vector. + The scalar value. + The vector. + The vector type. T can be any primitive numeric type. + The scaled vector. + + + Returns a new vector whose values are the product of each pair of elements in two specified vectors. + The first vector. + The second vector. + The vector type. T can be any primitive numeric type. + The product vector. + + + Returns a new vector whose values are the values of a specified vector each multiplied by a scalar value. + The vector. + The scalar value. + The vector type. T can be any primitive numeric type. + The scaled vector. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns a new vector whose elements are the negation of the corresponding element in the specified vector. + The source vector. + The vector type. T can be any primitive numeric type. + The negated vector. + + + Returns a new vector whose elements are obtained by taking the one&#39;s complement of a specified vector&#39;s elements. + The source vector. + The vector type. T can be any primitive numeric type. + The resulting vector. + + + Returns a new vector whose elements are the square roots of a specified vector&#39;s elements. + The source vector. + The vector type. T can be any primitive numeric type. + The square root vector. + + + Returns a new vector whose values are the difference between the elements in the second vector and their corresponding elements in the first vector. + The first vector. + The second vector. + The vector type. T can be any primitive numeric type. + The difference vector. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns a new vector by performing a bitwise exclusive Or (XOr) operation on each pair of elements in two vectors. + The first vector. + The second vector. + The vector type. T can be any primitive numeric type. + The resulting vector. + + + Represents a vector with two single-precision floating-point values. + + + Creates a new object whose two elements have the same value. + The value to assign to both elements. + + + Creates a vector whose elements have the specified values. + The value to assign to the field. + The value to assign to the field. + + + Returns a vector whose elements are the absolute values of each of the specified vector&#39;s elements. + A vector. + The absolute value vector. + + + Adds two vectors together. + The first vector to add. + The second vector to add. + The summed vector. + + + Restricts a vector between a minimum and a maximum value. + The vector to restrict. + The minimum value. + The maximum value. + The restricted vector. + + + Copies the elements of the vector to a specified array. + The destination array. + array is null. + The number of elements in the current instance is greater than in the array. + array is multidimensional. + + + Copies the elements of the vector to a specified array starting at a specified index position. + The destination array. + The index at which to copy the first element of the vector. + array is null. + The number of elements in the current instance is greater than in the array. + index is less than zero. + -or- + index is greater than or equal to the array length. + array is multidimensional. + + + Computes the Euclidean distance between the two given points. + The first point. + The second point. + The distance. + + + Returns the Euclidean distance squared between two specified points. + The first point. + The second point. + The distance squared. + + + Divides the first vector by the second. + The first vector. + The second vector. + The vector resulting from the division. + + + Divides the specified vector by a specified scalar value. + The vector. + The scalar value. + The vector that results from the division. + + + Returns the dot product of two vectors. + The first vector. + The second vector. + The dot product. + + + Returns a value that indicates whether this instance and a specified object are equal. + The object to compare with the current instance. + true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. + + + Returns a value that indicates whether this instance and another vector are equal. + The other vector. + true if the two vectors are equal; otherwise, false. + + + Returns the hash code for this instance. + The hash code. + + + Returns the length of the vector. + The vector&#39;s length. + + + Returns the length of the vector squared. + The vector&#39;s length squared. + + + Performs a linear interpolation between two vectors based on the given weighting. + The first vector. + The second vector. + A value between 0 and 1 that indicates the weight of value2. + The interpolated vector. + + + Returns a vector whose elements are the maximum of each of the pairs of elements in two specified vectors. + The first vector. + The second vector. + The maximized vector. + + + Returns a vector whose elements are the minimum of each of the pairs of elements in two specified vectors. + The first vector. + The second vector. + The minimized vector. + + + Multiplies two vectors together. + The first vector. + The second vector. + The product vector. + + + Multiplies a vector by a specified scalar. + The vector to multiply. + The scalar value. + The scaled vector. + + + Multiplies a scalar value by a specified vector. + The scaled value. + The vector. + The scaled vector. + + + Negates a specified vector. + The vector to negate. + The negated vector. + + + Returns a vector with the same direction as the specified vector, but with a length of one. + The vector to normalize. + The normalized vector. + + + Gets a vector whose 2 elements are equal to one. + A vector whose two elements are equal to one (that is, it returns the vector (1,1). + + + Adds two vectors together. + The first vector to add. + The second vector to add. + The summed vector. + + + Divides the first vector by the second. + The first vector. + The second vector. + The vector that results from dividing left by right. + + + Divides the specified vector by a specified scalar value. + The vector. + The scalar value. + The result of the division. + + + Returns a value that indicates whether each pair of elements in two specified vectors is equal. + The first vector to compare. + The second vector to compare. + true if left and right are equal; otherwise, false. + + + Returns a value that indicates whether two specified vectors are not equal. + The first vector to compare. + The second vector to compare. + true if left and right are not equal; otherwise, false. + + + Multiplies two vectors together. + The first vector. + The second vector. + The product vector. + + + Multiples the specified vector by the specified scalar value. + The vector. + The scalar value. + The scaled vector. + + + Multiples the scalar value by the specified vector. + The vector. + The scalar value. + The scaled vector. + + + Subtracts the second vector from the first. + The first vector. + The second vector. + The vector that results from subtracting right from left. + + + Negates the specified vector. + The vector to negate. + The negated vector. + + + Returns the reflection of a vector off a surface that has the specified normal. + The source vector. + The normal of the surface being reflected off. + The reflected vector. + + + Returns a vector whose elements are the square root of each of a specified vector&#39;s elements. + A vector. + The square root vector. + + + Subtracts the second vector from the first. + The first vector. + The second vector. + The difference vector. + + + Returns the string representation of the current instance using default formatting. + The string representation of the current instance. + + + Returns the string representation of the current instance using the specified format string to format individual elements. + A or that defines the format of individual elements. + The string representation of the current instance. + + + Returns the string representation of the current instance using the specified format string to format individual elements and the specified format provider to define culture-specific formatting. + A or that defines the format of individual elements. + A format provider that supplies culture-specific formatting information. + The string representation of the current instance. + + + Transforms a vector by a specified 3x2 matrix. + The vector to transform. + The transformation matrix. + The transformed vector. + + + Transforms a vector by a specified 4x4 matrix. + The vector to transform. + The transformation matrix. + The transformed vector. + + + Transforms a vector by the specified Quaternion rotation value. + The vector to rotate. + The rotation to apply. + The transformed vector. + + + Transforms a vector normal by the given 3x2 matrix. + The source vector. + The matrix. + The transformed vector. + + + Transforms a vector normal by the given 4x4 matrix. + The source vector. + The matrix. + The transformed vector. + + + Gets the vector (1,0). + The vector (1,0). + + + Gets the vector (0,1). + The vector (0,1). + + + The X component of the vector. + + + + The Y component of the vector. + + + + Returns a vector whose 2 elements are equal to zero. + A vector whose two elements are equal to zero (that is, it returns the vector (0,0). + + + Represents a vector with three single-precision floating-point values. + + + Creates a new object whose three elements have the same value. + The value to assign to all three elements. + + + Creates a new object from the specified object and the specified value. + The vector with two elements. + The additional value to assign to the field. + + + Creates a vector whose elements have the specified values. + The value to assign to the field. + The value to assign to the field. + The value to assign to the field. + + + Returns a vector whose elements are the absolute values of each of the specified vector&#39;s elements. + A vector. + The absolute value vector. + + + Adds two vectors together. + The first vector to add. + The second vector to add. + The summed vector. + + + Restricts a vector between a minimum and a maximum value. + The vector to restrict. + The minimum value. + The maximum value. + The restricted vector. + + + Copies the elements of the vector to a specified array. + The destination array. + array is null. + The number of elements in the current instance is greater than in the array. + array is multidimensional. + + + Copies the elements of the vector to a specified array starting at a specified index position. + The destination array. + The index at which to copy the first element of the vector. + array is null. + The number of elements in the current instance is greater than in the array. + index is less than zero. + -or- + index is greater than or equal to the array length. + array is multidimensional. + + + Computes the cross product of two vectors. + The first vector. + The second vector. + The cross product. + + + Computes the Euclidean distance between the two given points. + The first point. + The second point. + The distance. + + + Returns the Euclidean distance squared between two specified points. + The first point. + The second point. + The distance squared. + + + Divides the specified vector by a specified scalar value. + The vector. + The scalar value. + The vector that results from the division. + + + Divides the first vector by the second. + The first vector. + The second vector. + The vector resulting from the division. + + + Returns the dot product of two vectors. + The first vector. + The second vector. + The dot product. + + + Returns a value that indicates whether this instance and another vector are equal. + The other vector. + true if the two vectors are equal; otherwise, false. + + + Returns a value that indicates whether this instance and a specified object are equal. + The object to compare with the current instance. + true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. + + + Returns the hash code for this instance. + The hash code. + + + Returns the length of this vector object. + The vector&#39;s length. + + + Returns the length of the vector squared. + The vector&#39;s length squared. + + + Performs a linear interpolation between two vectors based on the given weighting. + The first vector. + The second vector. + A value between 0 and 1 that indicates the weight of value2. + The interpolated vector. + + + Returns a vector whose elements are the maximum of each of the pairs of elements in two specified vectors. + The first vector. + The second vector. + The maximized vector. + + + Returns a vector whose elements are the minimum of each of the pairs of elements in two specified vectors. + The first vector. + The second vector. + The minimized vector. + + + Multiplies a scalar value by a specified vector. + The scaled value. + The vector. + The scaled vector. + + + Multiplies two vectors together. + The first vector. + The second vector. + The product vector. + + + Multiplies a vector by a specified scalar. + The vector to multiply. + The scalar value. + The scaled vector. + + + Negates a specified vector. + The vector to negate. + The negated vector. + + + Returns a vector with the same direction as the specified vector, but with a length of one. + The vector to normalize. + The normalized vector. + + + Gets a vector whose 3 elements are equal to one. + A vector whose three elements are equal to one (that is, it returns the vector (1,1,1). + + + Adds two vectors together. + The first vector to add. + The second vector to add. + The summed vector. + + + Divides the first vector by the second. + The first vector. + The second vector. + The vector that results from dividing left by right. + + + Divides the specified vector by a specified scalar value. + The vector. + The scalar value. + The result of the division. + + + Returns a value that indicates whether each pair of elements in two specified vectors is equal. + The first vector to compare. + The second vector to compare. + true if left and right are equal; otherwise, false. + + + Returns a value that indicates whether two specified vectors are not equal. + The first vector to compare. + The second vector to compare. + true if left and right are not equal; otherwise, false. + + + Multiplies two vectors together. + The first vector. + The second vector. + The product vector. + + + Multiples the specified vector by the specified scalar value. + The vector. + The scalar value. + The scaled vector. + + + Multiples the scalar value by the specified vector. + The vector. + The scalar value. + The scaled vector. + + + Subtracts the second vector from the first. + The first vector. + The second vector. + The vector that results from subtracting right from left. + + + Negates the specified vector. + The vector to negate. + The negated vector. + + + Returns the reflection of a vector off a surface that has the specified normal. + The source vector. + The normal of the surface being reflected off. + The reflected vector. + + + Returns a vector whose elements are the square root of each of a specified vector&#39;s elements. + A vector. + The square root vector. + + + Subtracts the second vector from the first. + The first vector. + The second vector. + The difference vector. + + + Returns the string representation of the current instance using default formatting. + The string representation of the current instance. + + + Returns the string representation of the current instance using the specified format string to format individual elements. + A or that defines the format of individual elements. + The string representation of the current instance. + + + Returns the string representation of the current instance using the specified format string to format individual elements and the specified format provider to define culture-specific formatting. + A or that defines the format of individual elements. + A format provider that supplies culture-specific formatting information. + The string representation of the current instance. + + + Transforms a vector by a specified 4x4 matrix. + The vector to transform. + The transformation matrix. + The transformed vector. + + + Transforms a vector by the specified Quaternion rotation value. + The vector to rotate. + The rotation to apply. + The transformed vector. + + + Transforms a vector normal by the given 4x4 matrix. + The source vector. + The matrix. + The transformed vector. + + + Gets the vector (1,0,0). + The vector (1,0,0). + + + Gets the vector (0,1,0). + The vector (0,1,0).. + + + Gets the vector (0,0,1). + The vector (0,0,1). + + + The X component of the vector. + + + + The Y component of the vector. + + + + The Z component of the vector. + + + + Gets a vector whose 3 elements are equal to zero. + A vector whose three elements are equal to zero (that is, it returns the vector (0,0,0). + + + Represents a vector with four single-precision floating-point values. + + + Creates a new object whose four elements have the same value. + The value to assign to all four elements. + + + Constructs a new object from the specified object and a W component. + The vector to use for the X, Y, and Z components. + The W component. + + + Creates a new object from the specified object and a Z and a W component. + The vector to use for the X and Y components. + The Z component. + The W component. + + + Creates a vector whose elements have the specified values. + The value to assign to the field. + The value to assign to the field. + The value to assign to the field. + The value to assign to the field. + + + Returns a vector whose elements are the absolute values of each of the specified vector&#39;s elements. + A vector. + The absolute value vector. + + + Adds two vectors together. + The first vector to add. + The second vector to add. + The summed vector. + + + Restricts a vector between a minimum and a maximum value. + The vector to restrict. + The minimum value. + The maximum value. + The restricted vector. + + + Copies the elements of the vector to a specified array. + The destination array. + array is null. + The number of elements in the current instance is greater than in the array. + array is multidimensional. + + + Copies the elements of the vector to a specified array starting at a specified index position. + The destination array. + The index at which to copy the first element of the vector. + array is null. + The number of elements in the current instance is greater than in the array. + index is less than zero. + -or- + index is greater than or equal to the array length. + array is multidimensional. + + + Computes the Euclidean distance between the two given points. + The first point. + The second point. + The distance. + + + Returns the Euclidean distance squared between two specified points. + The first point. + The second point. + The distance squared. + + + Divides the first vector by the second. + The first vector. + The second vector. + The vector resulting from the division. + + + Divides the specified vector by a specified scalar value. + The vector. + The scalar value. + The vector that results from the division. + + + Returns the dot product of two vectors. + The first vector. + The second vector. + The dot product. + + + Returns a value that indicates whether this instance and another vector are equal. + The other vector. + true if the two vectors are equal; otherwise, false. + + + Returns a value that indicates whether this instance and a specified object are equal. + The object to compare with the current instance. + true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. + + + Returns the hash code for this instance. + The hash code. + + + Returns the length of this vector object. + The vector&#39;s length. + + + Returns the length of the vector squared. + The vector&#39;s length squared. + + + Performs a linear interpolation between two vectors based on the given weighting. + The first vector. + The second vector. + A value between 0 and 1 that indicates the weight of value2. + The interpolated vector. + + + Returns a vector whose elements are the maximum of each of the pairs of elements in two specified vectors. + The first vector. + The second vector. + The maximized vector. + + + Returns a vector whose elements are the minimum of each of the pairs of elements in two specified vectors. + The first vector. + The second vector. + The minimized vector. + + + Multiplies two vectors together. + The first vector. + The second vector. + The product vector. + + + Multiplies a vector by a specified scalar. + The vector to multiply. + The scalar value. + The scaled vector. + + + Multiplies a scalar value by a specified vector. + The scaled value. + The vector. + The scaled vector. + + + Negates a specified vector. + The vector to negate. + The negated vector. + + + Returns a vector with the same direction as the specified vector, but with a length of one. + The vector to normalize. + The normalized vector. + + + Gets a vector whose 4 elements are equal to one. + Returns . + + + Adds two vectors together. + The first vector to add. + The second vector to add. + The summed vector. + + + Divides the first vector by the second. + The first vector. + The second vector. + The vector that results from dividing left by right. + + + Divides the specified vector by a specified scalar value. + The vector. + The scalar value. + The result of the division. + + + Returns a value that indicates whether each pair of elements in two specified vectors is equal. + The first vector to compare. + The second vector to compare. + true if left and right are equal; otherwise, false. + + + Returns a value that indicates whether two specified vectors are not equal. + The first vector to compare. + The second vector to compare. + true if left and right are not equal; otherwise, false. + + + Multiplies two vectors together. + The first vector. + The second vector. + The product vector. + + + Multiples the specified vector by the specified scalar value. + The vector. + The scalar value. + The scaled vector. + + + Multiples the scalar value by the specified vector. + The vector. + The scalar value. + The scaled vector. + + + Subtracts the second vector from the first. + The first vector. + The second vector. + The vector that results from subtracting right from left. + + + Negates the specified vector. + The vector to negate. + The negated vector. + + + Returns a vector whose elements are the square root of each of a specified vector&#39;s elements. + A vector. + The square root vector. + + + Subtracts the second vector from the first. + The first vector. + The second vector. + The difference vector. + + + Returns the string representation of the current instance using default formatting. + The string representation of the current instance. + + + Returns the string representation of the current instance using the specified format string to format individual elements. + A or that defines the format of individual elements. + The string representation of the current instance. + + + Returns the string representation of the current instance using the specified format string to format individual elements and the specified format provider to define culture-specific formatting. + A or that defines the format of individual elements. + A format provider that supplies culture-specific formatting information. + The string representation of the current instance. + + + Transforms a four-dimensional vector by the specified Quaternion rotation value. + The vector to rotate. + The rotation to apply. + The transformed vector. + + + Transforms a four-dimensional vector by a specified 4x4 matrix. + The vector to transform. + The transformation matrix. + The transformed vector. + + + Transforms a three-dimensional vector by the specified Quaternion rotation value. + The vector to rotate. + The rotation to apply. + The transformed vector. + + + Transforms a two-dimensional vector by a specified 4x4 matrix. + The vector to transform. + The transformation matrix. + The transformed vector. + + + Transforms a two-dimensional vector by the specified Quaternion rotation value. + The vector to rotate. + The rotation to apply. + The transformed vector. + + + Transforms a three-dimensional vector by a specified 4x4 matrix. + The vector to transform. + The transformation matrix. + The transformed vector. + + + Gets the vector (0,0,0,1). + The vector (0,0,0,1). + + + Gets the vector (1,0,0,0). + The vector (1,0,0,0). + + + Gets the vector (0,1,0,0). + The vector (0,1,0,0).. + + + Gets a vector whose 4 elements are equal to zero. + The vector (0,0,1,0). + + + The W component of the vector. + + + + The X component of the vector. + + + + The Y component of the vector. + + + + The Z component of the vector. + + + + Gets a vector whose 4 elements are equal to zero. + A vector whose four elements are equal to zero (that is, it returns the vector (0,0,0,0). + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/System.Runtime.CompilerServices.Unsafe.dll b/app_data/jobs/triggered/utility/System.Runtime.CompilerServices.Unsafe.dll new file mode 100644 index 000000000..0c27a0e21 Binary files /dev/null and b/app_data/jobs/triggered/utility/System.Runtime.CompilerServices.Unsafe.dll differ diff --git a/app_data/jobs/triggered/utility/System.Runtime.CompilerServices.Unsafe.xml b/app_data/jobs/triggered/utility/System.Runtime.CompilerServices.Unsafe.xml new file mode 100644 index 000000000..6f2918810 --- /dev/null +++ b/app_data/jobs/triggered/utility/System.Runtime.CompilerServices.Unsafe.xml @@ -0,0 +1,252 @@ + + + + System.Runtime.CompilerServices.Unsafe + + + + Contains generic, low-level functionality for manipulating pointers. + + + Adds an element offset to the given reference. + The reference to add the offset to. + The offset to add. + The type of reference. + A new reference that reflects the addition of offset to pointer. + + + Adds an element offset to the given reference. + The reference to add the offset to. + The offset to add. + The type of reference. + A new reference that reflects the addition of offset to pointer. + + + Adds an element offset to the given void pointer. + The void pointer to add the offset to. + The offset to add. + The type of void pointer. + A new void pointer that reflects the addition of offset to the specified pointer. + + + Adds a byte offset to the given reference. + The reference to add the offset to. + The offset to add. + The type of reference. + A new reference that reflects the addition of byte offset to pointer. + + + Determines whether the specified references point to the same location. + The first reference to compare. + The second reference to compare. + The type of reference. + + if and point to the same location; otherwise, . + + + Casts the given object to the specified type. + The object to cast. + The type which the object will be cast to. + The original object, casted to the given type. + + + Reinterprets the given reference as a reference to a value of type . + The reference to reinterpret. + The type of reference to reinterpret. + The desired type of the reference. + A reference to a value of type . + + + Returns a pointer to the given by-ref parameter. + The object whose pointer is obtained. + The type of object. + A pointer to the given value. + + + Reinterprets the given read-only reference as a reference. + The read-only reference to reinterpret. + The type of reference. + A reference to a value of type . + + + Reinterprets the given location as a reference to a value of type . + The location of the value to reference. + The type of the interpreted location. + A reference to a value of type . + + + Determines the byte offset from origin to target from the given references. + The reference to origin. + The reference to target. + The type of reference. + Byte offset from origin to target i.e. - . + + + Copies a value of type to the given location. + The location to copy to. + A pointer to the value to copy. + The type of value to copy. + + + Copies a value of type to the given location. + The location to copy to. + A reference to the value to copy. + The type of value to copy. + + + Copies bytes from the source address to the destination address. + The destination address to copy to. + The source address to copy from. + The number of bytes to copy. + + + Copies bytes from the source address to the destination address. + The destination address to copy to. + The source address to copy from. + The number of bytes to copy. + + + Copies bytes from the source address to the destination address +without assuming architecture dependent alignment of the addresses. + The destination address to copy to. + The source address to copy from. + The number of bytes to copy. + + + Copies bytes from the source address to the destination address +without assuming architecture dependent alignment of the addresses. + The destination address to copy to. + The source address to copy from. + The number of bytes to copy. + + + Initializes a block of memory at the given location with a given initial value. + The address of the start of the memory block to initialize. + The value to initialize the block to. + The number of bytes to initialize. + + + Initializes a block of memory at the given location with a given initial value. + The address of the start of the memory block to initialize. + The value to initialize the block to. + The number of bytes to initialize. + + + Initializes a block of memory at the given location with a given initial value +without assuming architecture dependent alignment of the address. + The address of the start of the memory block to initialize. + The value to initialize the block to. + The number of bytes to initialize. + + + Initializes a block of memory at the given location with a given initial value +without assuming architecture dependent alignment of the address. + The address of the start of the memory block to initialize. + The value to initialize the block to. + The number of bytes to initialize. + + + Returns a value that indicates whether a specified reference is greater than another specified reference. + The first value to compare. + The second value to compare. + The type of the reference. + + if is greater than ; otherwise, . + + + Returns a value that indicates whether a specified reference is less than another specified reference. + The first value to compare. + The second value to compare. + The type of the reference. + + if is less than ; otherwise, . + + + Reads a value of type from the given location. + The location to read from. + The type to read. + An object of type read from the given location. + + + Reads a value of type from the given location +without assuming architecture dependent alignment of the addresses. + The location to read from. + The type to read. + An object of type read from the given location. + + + Reads a value of type from the given location +without assuming architecture dependent alignment of the addresses. + The location to read from. + The type to read. + An object of type read from the given location. + + + Returns the size of an object of the given type parameter. + The type of object whose size is retrieved. + The size of an object of type . + + + Subtracts an element offset from the given reference. + The reference to subtract the offset from. + The offset to subtract. + The type of reference. + A new reference that reflects the subtraction of offset from pointer. + + + Subtracts an element offset from the given reference. + The reference to subtract the offset from. + The offset to subtract. + The type of reference. + A new reference that reflects the subtraction of offset from pointer. + + + Subtracts an element offset from the given void pointer. + The void pointer to subtract the offset from. + The offset to subtract. + The type of the void pointer. + A new void pointer that reflects the subtraction of offset from the specified pointer. + + + Subtracts a byte offset from the given reference. + The reference to subtract the offset from. + The offset to subtract. + The type of reference. + A new reference that reflects the subtraction of byte offset from pointer. + + + Returns a to a boxed value. + The value to unbox. + The type to be unboxed. + A to the boxed value . + + is , and is a non-nullable value type. + + is not a boxed value type. +-or- + is not a boxed . + + cannot be found. + + + Writes a value of type to the given location. + The location to write to. + The value to write. + The type of value to write. + + + Writes a value of type to the given location +without assuming architecture dependent alignment of the addresses. + The location to write to. + The value to write. + The type of value to write. + + + Writes a value of type to the given location +without assuming architecture dependent alignment of the addresses. + The location to write to. + The value to write. + The type of value to write. + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/System.Text.Encodings.Web.dll b/app_data/jobs/triggered/utility/System.Text.Encodings.Web.dll new file mode 100644 index 000000000..6d2b20785 Binary files /dev/null and b/app_data/jobs/triggered/utility/System.Text.Encodings.Web.dll differ diff --git a/app_data/jobs/triggered/utility/System.Text.Encodings.Web.xml b/app_data/jobs/triggered/utility/System.Text.Encodings.Web.xml new file mode 100644 index 000000000..c5904a17b --- /dev/null +++ b/app_data/jobs/triggered/utility/System.Text.Encodings.Web.xml @@ -0,0 +1,932 @@ + + + + System.Text.Encodings.Web + + + + Represents an HTML character encoding. + + + Initializes a new instance of the class. + + + Creates a new instance of the HtmlEncoder class with the specified settings. + Settings that control how the instance encodes, primarily which characters to encode. + A new instance of the class. + + is . + + + Creates a new instance of the HtmlEncoder class that specifies characters the encoder is allowed to not encode. + The set of characters that the encoder is allowed to not encode. + A new instance of the class. + + is . + + + Gets a built-in instance of the class. + A built-in instance of the class. + + + Represents a JavaScript character encoding. + + + Initializes a new instance of the class. + + + Creates a new instance of JavaScriptEncoder class with the specified settings. + Settings that control how the instance encodes, primarily which characters to encode. + A new instance of the class. + + is . + + + Creates a new instance of the JavaScriptEncoder class that specifies characters the encoder is allowed to not encode. + The set of characters that the encoder is allowed to not encode. + A new instance of the class. + + is . + + + Gets a built-in instance of the class. + A built-in instance of the class. + + + Gets a built-in JavaScript encoder instance that is less strict about what is encoded. + A JavaScript encoder instance. + + + The base class of web encoders. + + + Initializes a new instance of the class. + + + Encodes characters from an array and writes them to a object. + The stream to which to write the encoded text. + The array of characters to encode. + The array index of the first character to encode. + The number of characters in the array to encode. + + is . + The method failed. The encoder does not implement correctly. + + is . + + is out of range. + + is out of range. + + + Encodes the specified string to a object. + The stream to which to write the encoded text. + The string to encode. + + + Encodes a substring and writes it to a object. + The stream to which to write the encoded text. + The string whose substring is to be encoded. + The index where the substring starts. + The number of characters in the substring. + + is . + The method failed. The encoder does not implement correctly. + + is . + + is out of range. + + is out of range. + + + Encodes the supplied characters. + A source buffer containing the characters to encode. + The destination buffer to which the encoded form of will be written. + The number of characters consumed from the buffer. + The number of characters written to the buffer. + + to indicate there is no further source data that needs to be encoded; otherwise, . + An enumeration value that describes the result of the encoding operation. + + + Encodes the supplied string and returns the encoded text as a new string. + The string to encode. + The encoded string. + + is . + The method failed. The encoder does not implement correctly. + + + Encodes the supplied UTF-8 text. + A source buffer containing the UTF-8 text to encode. + The destination buffer to which the encoded form of will be written. + The number of bytes consumed from the buffer. + The number of bytes written to the buffer. + + to indicate there is no further source data that needs to be encoded; otherwise, . + A status code that describes the result of the encoding operation. + + + Finds the index of the first character to encode. + The text buffer to search. + The number of characters in . + The index of the first character to encode. + + + Finds the first element in a UTF-8 text input buffer that would be escaped by the current encoder instance. + The UTF-8 text input buffer to search. + The index of the first element in that would be escaped by the current encoder instance, or -1 if no data in requires escaping. + + + Gets the maximum number of characters that this encoder can generate for each input code point. + The maximum number of characters. + + + Encodes a Unicode scalar value and writes it to a buffer. + A Unicode scalar value. + A pointer to the buffer to which to write the encoded text. + The length of the destination in characters. + When the method returns, indicates the number of characters written to the . + + if is too small to fit the encoded text; otherwise, returns . + + + Determines if a given Unicode scalar value will be encoded. + A Unicode scalar value. + + if the value will be encoded by this encoder; otherwise, returns . + + + Represents a filter that allows only certain Unicode code points. + + + Instantiates an empty filter (allows no code points through by default). + + + Instantiates a filter by cloning the allowed list of another object. + The other object to be cloned. + + + Instantiates a filter where only the character ranges specified by are allowed by the filter. + The allowed character ranges. + + is . + + + Allows the character specified by through the filter. + The allowed character. + + + Allows all characters specified by through the filter. + The allowed characters. + + is . + + + Allows all code points specified by . + The allowed code points. + + is . + + + Allows all characters specified by through the filter. + The range of characters to be allowed. + + is . + + + Allows all characters specified by through the filter. + The ranges of characters to be allowed. + + is . + + + Resets this object by disallowing all characters. + + + Disallows the character through the filter. + The disallowed character. + + + Disallows all characters specified by through the filter. + The disallowed characters. + + is . + + + Disallows all characters specified by through the filter. + The range of characters to be disallowed. + + is . + + + Disallows all characters specified by through the filter. + The ranges of characters to be disallowed. + + is . + + + Gets an enumerator of all allowed code points. + The enumerator of allowed code points. + + + Represents a URL character encoding. + + + Initializes a new instance of the class. + + + Creates a new instance of UrlEncoder class with the specified settings. + Settings that control how the instance encodes, primarily which characters to encode. + A new instance of the class. + + is . + + + Creates a new instance of the UrlEncoder class that specifies characters the encoder is allowed to not encode. + The set of characters that the encoder is allowed to not encode. + A new instance of the class. + + is . + + + Gets a built-in instance of the class. + A built-in instance of the class. + + + Represents a contiguous range of Unicode code points. + + + Creates a new that includes a specified number of characters starting at a specified Unicode code point. + The first code point in the range. + The number of code points in the range. + + is less than zero or greater than 0xFFFF. +-or- + is less than zero. +-or- + plus is greater than 0xFFFF. + + + Creates a new instance from a span of characters. + The first character in the range. + The last character in the range. + A range that includes all characters between and . + + precedes . + + + Gets the first code point in the range represented by this instance. + The first code point in the range. + + + Gets the number of code points in the range represented by this instance. + The number of code points in the range. + + + Provides static properties that return predefined instances that correspond to blocks from the Unicode specification. + + + Gets a range that consists of the entire Basic Multilingual Plane (BMP), from U+0000 to U+FFFF). + A range that consists of the entire BMP. + + + Gets the Alphabetic Presentation Forms Unicode block (U+FB00-U+FB4F). + The Alphabetic Presentation Forms Unicode block (U+FB00-U+FB4F). + + + Gets the Arabic Unicode block (U+0600-U+06FF). + The Arabic Unicode block (U+0600-U+06FF). + + + Gets the Arabic Extended-A Unicode block (U+08A0-U+08FF). + The Arabic Extended-A Unicode block (U+08A0-U+08FF). + + + Gets the Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF). + The Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF). + + + Gets the Arabic Presentation Forms-B Unicode block (U+FE70-U+FEFF). + The Arabic Presentation Forms-B Unicode block (U+FE70-U+FEFF). + + + Gets the Arabic Supplement Unicode block (U+0750-U+077F). + The Arabic Supplement Unicode block (U+0750-U+077F). + + + Gets the Armenian Unicode block (U+0530-U+058F). + The Armenian Unicode block (U+0530-U+058F). + + + Gets the Arrows Unicode block (U+2190-U+21FF). + The Arrows Unicode block (U+2190-U+21FF). + + + Gets the Balinese Unicode block (U+1B00-U+1B7F). + The Balinese Unicode block (U+1B00-U+1B7F). + + + Gets the Bamum Unicode block (U+A6A0-U+A6FF). + The Bamum Unicode block (U+A6A0-U+A6FF). + + + Gets the Basic Latin Unicode block (U+0021-U+007F). + The Basic Latin Unicode block (U+0021-U+007F). + + + Gets the Batak Unicode block (U+1BC0-U+1BFF). + The Batak Unicode block (U+1BC0-U+1BFF). + + + Gets the Bengali Unicode block (U+0980-U+09FF). + The Bengali Unicode block (U+0980-U+09FF). + + + Gets the Block Elements Unicode block (U+2580-U+259F). + The Block Elements Unicode block (U+2580-U+259F). + + + Gets the Bopomofo Unicode block (U+3100-U+312F). + The Bopomofo Unicode block (U+3105-U+312F). + + + Gets the Bopomofo Extended Unicode block (U+31A0-U+31BF). + The Bopomofo Extended Unicode block (U+31A0-U+31BF). + + + Gets the Box Drawing Unicode block (U+2500-U+257F). + The Box Drawing Unicode block (U+2500-U+257F). + + + Gets the Braille Patterns Unicode block (U+2800-U+28FF). + The Braille Patterns Unicode block (U+2800-U+28FF). + + + Gets the Buginese Unicode block (U+1A00-U+1A1F). + The Buginese Unicode block (U+1A00-U+1A1F). + + + Gets the Buhid Unicode block (U+1740-U+175F). + The Buhid Unicode block (U+1740-U+175F). + + + Gets the Cham Unicode block (U+AA00-U+AA5F). + The Cham Unicode block (U+AA00-U+AA5F). + + + Gets the Cherokee Unicode block (U+13A0-U+13FF). + The Cherokee Unicode block (U+13A0-U+13FF). + + + Gets the Cherokee Supplement Unicode block (U+AB70-U+ABBF). + The Cherokee Supplement Unicode block (U+AB70-U+ABBF). + + + Gets the CJK Compatibility Unicode block (U+3300-U+33FF). + The CJK Compatibility Unicode block (U+3300-U+33FF). + + + Gets the CJK Compatibility Forms Unicode block (U+FE30-U+FE4F). + The CJK Compatibility Forms Unicode block (U+FE30-U+FE4F). + + + Gets the CJK Compatibility Ideographs Unicode block (U+F900-U+FAD9). + The CJK Compatibility Ideographs Unicode block (U+F900-U+FAD9). + + + Gets the CJK Radicals Supplement Unicode block (U+2E80-U+2EFF). + The CJK Radicals Supplement Unicode block (U+2E80-U+2EFF). + + + Gets the CJK Strokes Unicode block (U+31C0-U+31EF). + The CJK Strokes Unicode block (U+31C0-U+31EF). + + + Gets the CJK Symbols and Punctuation Unicode block (U+3000-U+303F). + The CJK Symbols and Punctuation Unicode block (U+3000-U+303F). + + + Gets the CJK Unified Ideographs Unicode block (U+4E00-U+9FCC). + The CJK Unified Ideographs Unicode block (U+4E00-U+9FCC). + + + Gets the CJK Unitied Ideographs Extension A Unicode block (U+3400-U+4DB5). + The CJK Unitied Ideographs Extension A Unicode block (U+3400-U+4DB5). + + + Gets the Combining Diacritical Marks Unicode block (U+0300-U+036F). + The Combining Diacritical Marks Unicode block (U+0300-U+036F). + + + Gets the Combining Diacritical Marks Extended Unicode block (U+1AB0-U+1AFF). + The Combining Diacritical Marks Extended Unicode block (U+1AB0-U+1AFF). + + + Gets the Combining Diacritical Marks for Symbols Unicode block (U+20D0-U+20FF). + The Combining Diacritical Marks for Symbols Unicode block (U+20D0-U+20FF). + + + Gets the Combining Diacritical Marks Supplement Unicode block (U+1DC0-U+1DFF). + The Combining Diacritical Marks Supplement Unicode block (U+1DC0-U+1DFF). + + + Gets the Combining Half Marks Unicode block (U+FE20-U+FE2F). + The Combining Half Marks Unicode block (U+FE20-U+FE2F). + + + Gets the Common Indic Number Forms Unicode block (U+A830-U+A83F). + The Common Indic Number Forms Unicode block (U+A830-U+A83F). + + + Gets the Control Pictures Unicode block (U+2400-U+243F). + The Control Pictures Unicode block (U+2400-U+243F). + + + Gets the Coptic Unicode block (U+2C80-U+2CFF). + The Coptic Unicode block (U+2C80-U+2CFF). + + + Gets the Currency Symbols Unicode block (U+20A0-U+20CF). + The Currency Symbols Unicode block (U+20A0-U+20CF). + + + Gets the Cyrillic Unicode block (U+0400-U+04FF). + The Cyrillic Unicode block (U+0400-U+04FF). + + + Gets the Cyrillic Extended-A Unicode block (U+2DE0-U+2DFF). + The Cyrillic Extended-A Unicode block (U+2DE0-U+2DFF). + + + Gets the Cyrillic Extended-B Unicode block (U+A640-U+A69F). + The Cyrillic Extended-B Unicode block (U+A640-U+A69F). + + + A corresponding to the 'Cyrillic Extended-C' Unicode block (U+1C80..U+1C8F). + + + Gets the Cyrillic Supplement Unicode block (U+0500-U+052F). + The Cyrillic Supplement Unicode block (U+0500-U+052F). + + + Gets the Devangari Unicode block (U+0900-U+097F). + The Devangari Unicode block (U+0900-U+097F). + + + Gets the Devanagari Extended Unicode block (U+A8E0-U+A8FF). + The Devanagari Extended Unicode block (U+A8E0-U+A8FF). + + + Gets the Dingbats Unicode block (U+2700-U+27BF). + The Dingbats Unicode block (U+2700-U+27BF). + + + Gets the Enclosed Alphanumerics Unicode block (U+2460-U+24FF). + The Enclosed Alphanumerics Unicode block (U+2460-U+24FF). + + + Gets the Enclosed CJK Letters and Months Unicode block (U+3200-U+32FF). + The Enclosed CJK Letters and Months Unicode block (U+3200-U+32FF). + + + Gets the Ethiopic Unicode block (U+1200-U+137C). + The Ethiopic Unicode block (U+1200-U+137C). + + + Gets the Ethipic Extended Unicode block (U+2D80-U+2DDF). + The Ethipic Extended Unicode block (U+2D80-U+2DDF). + + + Gets the Ethiopic Extended-A Unicode block (U+AB00-U+AB2F). + The Ethiopic Extended-A Unicode block (U+AB00-U+AB2F). + + + Gets the Ethiopic Supplement Unicode block (U+1380-U+1399). + The Ethiopic Supplement Unicode block (U+1380-U+1399). + + + Gets the General Punctuation Unicode block (U+2000-U+206F). + The General Punctuation Unicode block (U+2000-U+206F). + + + Gets the Geometric Shapes Unicode block (U+25A0-U+25FF). + The Geometric Shapes Unicode block (U+25A0-U+25FF). + + + Gets the Georgian Unicode block (U+10A0-U+10FF). + The Georgian Unicode block (U+10A0-U+10FF). + + + A corresponding to the 'Georgian Extended' Unicode block (U+1C90..U+1CBF). + + + Gets the Georgian Supplement Unicode block (U+2D00-U+2D2F). + The Georgian Supplement Unicode block (U+2D00-U+2D2F). + + + Gets the Glagolitic Unicode block (U+2C00-U+2C5F). + The Glagolitic Unicode block (U+2C00-U+2C5F). + + + Gets the Greek and Coptic Unicode block (U+0370-U+03FF). + The Greek and Coptic Unicode block (U+0370-U+03FF). + + + Gets the Greek Extended Unicode block (U+1F00-U+1FFF). + The Greek Extended Unicode block (U+1F00-U+1FFF). + + + Gets the Gujarti Unicode block (U+0A81-U+0AFF). + The Gujarti Unicode block (U+0A81-U+0AFF). + + + Gets the Gurmukhi Unicode block (U+0A01-U+0A7F). + The Gurmukhi Unicode block (U+0A01-U+0A7F). + + + Gets the Halfwidth and Fullwidth Forms Unicode block (U+FF00-U+FFEE). + The Halfwidth and Fullwidth Forms Unicode block (U+FF00-U+FFEE). + + + Gets the Hangul Compatibility Jamo Unicode block (U+3131-U+318F). + The Hangul Compatibility Jamo Unicode block (U+3131-U+318F). + + + Gets the Hangul Jamo Unicode block (U+1100-U+11FF). + The Hangul Jamo Unicode block (U+1100-U+11FF). + + + Gets the Hangul Jamo Extended-A Unicode block (U+A960-U+A9F). + The Hangul Jamo Extended-A Unicode block (U+A960-U+A97F). + + + Gets the Hangul Jamo Extended-B Unicode block (U+D7B0-U+D7FF). + The Hangul Jamo Extended-B Unicode block (U+D7B0-U+D7FF). + + + Gets the Hangul Syllables Unicode block (U+AC00-U+D7AF). + The Hangul Syllables Unicode block (U+AC00-U+D7AF). + + + Gets the Hanunoo Unicode block (U+1720-U+173F). + The Hanunoo Unicode block (U+1720-U+173F). + + + Gets the Hebrew Unicode block (U+0590-U+05FF). + The Hebrew Unicode block (U+0590-U+05FF). + + + Gets the Hiragana Unicode block (U+3040-U+309F). + The Hiragana Unicode block (U+3040-U+309F). + + + Gets the Ideographic Description Characters Unicode block (U+2FF0-U+2FFF). + The Ideographic Description Characters Unicode block (U+2FF0-U+2FFF). + + + Gets the IPA Extensions Unicode block (U+0250-U+02AF). + The IPA Extensions Unicode block (U+0250-U+02AF). + + + Gets the Javanese Unicode block (U+A980-U+A9DF). + The Javanese Unicode block (U+A980-U+A9DF). + + + Gets the Kanbun Unicode block (U+3190-U+319F). + The Kanbun Unicode block (U+3190-U+319F). + + + Gets the Kangxi Radicals Supplement Unicode block (U+2F00-U+2FDF). + The Kangxi Radicals Supplement Unicode block (U+2F00-U+2FDF). + + + Gets the Kannada Unicode block (U+0C81-U+0CFF). + The Kannada Unicode block (U+0C81-U+0CFF). + + + Gets the Katakana Unicode block (U+30A0-U+30FF). + The Katakana Unicode block (U+30A0-U+30FF). + + + Gets the Katakana Phonetic Extensions Unicode block (U+31F0-U+31FF). + The Katakana Phonetic Extensions Unicode block (U+31F0-U+31FF). + + + Gets the Kayah Li Unicode block (U+A900-U+A92F). + The Kayah Li Unicode block (U+A900-U+A92F). + + + Gets the Khmer Unicode block (U+1780-U+17FF). + The Khmer Unicode block (U+1780-U+17FF). + + + Gets the Khmer Symbols Unicode block (U+19E0-U+19FF). + The Khmer Symbols Unicode block (U+19E0-U+19FF). + + + Gets the Lao Unicode block (U+0E80-U+0EDF). + The Lao Unicode block (U+0E80-U+0EDF). + + + Gets the Latin-1 Supplement Unicode block (U+00A1-U+00FF). + The Latin-1 Supplement Unicode block (U+00A1-U+00FF). + + + Gets the Latin Extended-A Unicode block (U+0100-U+017F). + The Latin Extended-A Unicode block (U+0100-U+017F). + + + Gets the Latin Extended Additional Unicode block (U+1E00-U+1EFF). + The Latin Extended Additional Unicode block (U+1E00-U+1EFF). + + + Gets the Latin Extended-B Unicode block (U+0180-U+024F). + The Latin Extended-B Unicode block (U+0180-U+024F). + + + Gets the Latin Extended-C Unicode block (U+2C60-U+2C7F). + The Latin Extended-C Unicode block (U+2C60-U+2C7F). + + + Gets the Latin Extended-D Unicode block (U+A720-U+A7FF). + The Latin Extended-D Unicode block (U+A720-U+A7FF). + + + Gets the Latin Extended-E Unicode block (U+AB30-U+AB6F). + The Latin Extended-E Unicode block (U+AB30-U+AB6F). + + + Gets the Lepcha Unicode block (U+1C00-U+1C4F). + The Lepcha Unicode block (U+1C00-U+1C4F). + + + Gets the Letterlike Symbols Unicode block (U+2100-U+214F). + The Letterlike Symbols Unicode block (U+2100-U+214F). + + + Gets the Limbu Unicode block (U+1900-U+194F). + The Limbu Unicode block (U+1900-U+194F). + + + Gets the Lisu Unicode block (U+A4D0-U+A4FF). + The Lisu Unicode block (U+A4D0-U+A4FF). + + + Gets the Malayalam Unicode block (U+0D00-U+0D7F). + The Malayalam Unicode block (U+0D00-U+0D7F). + + + Gets the Mandaic Unicode block (U+0840-U+085F). + The Mandaic Unicode block (U+0840-U+085F). + + + Gets the Mathematical Operators Unicode block (U+2200-U+22FF). + The Mathematical Operators Unicode block (U+2200-U+22FF). + + + Gets the Meetei Mayek Unicode block (U+ABC0-U+ABFF). + The Meetei Mayek Unicode block (U+ABC0-U+ABFF). + + + Gets the Meetei Mayek Extensions Unicode block (U+AAE0-U+AAFF). + The Meetei Mayek Extensions Unicode block (U+AAE0-U+AAFF). + + + Gets the Miscellaneous Mathematical Symbols-A Unicode block (U+27C0-U+27EF). + The Miscellaneous Mathematical Symbols-A Unicode block (U+27C0-U+27EF). + + + Gets the Miscellaneous Mathematical Symbols-B Unicode block (U+2980-U+29FF). + The Miscellaneous Mathematical Symbols-B Unicode block (U+2980-U+29FF). + + + Gets the Miscellaneous Symbols Unicode block (U+2600-U+26FF). + The Miscellaneous Symbols Unicode block (U+2600-U+26FF). + + + Gets the Miscellaneous Symbols and Arrows Unicode block (U+2B00-U+2BFF). + The Miscellaneous Symbols and Arrows Unicode block (U+2B00-U+2BFF). + + + Gets the Miscellaneous Technical Unicode block (U+2300-U+23FF). + The Miscellaneous Technical Unicode block (U+2300-U+23FF). + + + Gets the Modifier Tone Letters Unicode block (U+A700-U+A71F). + The Modifier Tone Letters Unicode block (U+A700-U+A71F). + + + Gets the Mongolian Unicode block (U+1800-U+18AF). + The Mongolian Unicode block (U+1800-U+18AF). + + + Gets the Myanmar Unicode block (U+1000-U+109F). + The Myanmar Unicode block (U+1000-U+109F). + + + Gets the Myanmar Extended-A Unicode block (U+AA60-U+AA7F). + The Myanmar Extended-A Unicode block (U+AA60-U+AA7F). + + + Gets the Myanmar Extended-B Unicode block (U+A9E0-U+A9FF). + The Myanmar Extended-B Unicode block (U+A9E0-U+A9FF). + + + Gets the New Tai Lue Unicode block (U+1980-U+19DF). + The New Tai Lue Unicode block (U+1980-U+19DF). + + + Gets the NKo Unicode block (U+07C0-U+07FF). + The NKo Unicode block (U+07C0-U+07FF). + + + Gets an empty Unicode range. + A Unicode range with no elements. + + + Gets the Number Forms Unicode block (U+2150-U+218F). + The Number Forms Unicode block (U+2150-U+218F). + + + Gets the Ogham Unicode block (U+1680-U+169F). + The Ogham Unicode block (U+1680-U+169F). + + + Gets the Ol Chiki Unicode block (U+1C50-U+1C7F). + The Ol Chiki Unicode block (U+1C50-U+1C7F). + + + Gets the Optical Character Recognition Unicode block (U+2440-U+245F). + The Optical Character Recognition Unicode block (U+2440-U+245F). + + + Gets the Oriya Unicode block (U+0B00-U+0B7F). + The Oriya Unicode block (U+0B00-U+0B7F). + + + Gets the Phags-pa Unicode block (U+A840-U+A87F). + The Phags-pa Unicode block (U+A840-U+A87F). + + + Gets the Phonetic Extensions Unicode block (U+1D00-U+1D7F). + The Phonetic Extensions Unicode block (U+1D00-U+1D7F). + + + Gets the Phonetic Extensions Supplement Unicode block (U+1D80-U+1DBF). + The Phonetic Extensions Supplement Unicode block (U+1D80-U+1DBF). + + + Gets the Rejang Unicode block (U+A930-U+A95F). + The Rejang Unicode block (U+A930-U+A95F). + + + Gets the Runic Unicode block (U+16A0-U+16FF). + The Runic Unicode block (U+16A0-U+16FF). + + + Gets the Samaritan Unicode block (U+0800-U+083F). + The Samaritan Unicode block (U+0800-U+083F). + + + Gets the Saurashtra Unicode block (U+A880-U+A8DF). + The Saurashtra Unicode block (U+A880-U+A8DF). + + + Gets the Sinhala Unicode block (U+0D80-U+0DFF). + The Sinhala Unicode block (U+0D80-U+0DFF). + + + Gets the Small Form Variants Unicode block (U+FE50-U+FE6F). + The Small Form Variants Unicode block (U+FE50-U+FE6F). + + + Gets the Spacing Modifier Letters Unicode block (U+02B0-U+02FF). + The Spacing Modifier Letters Unicode block (U+02B0-U+02FF). + + + Gets the Specials Unicode block (U+FFF0-U+FFFF). + The Specials Unicode block (U+FFF0-U+FFFF). + + + Gets the Sundanese Unicode block (U+1B80-U+1BBF). + The Sundanese Unicode block (U+1B80-U+1BBF). + + + Gets the Sundanese Supplement Unicode block (U+1CC0-U+1CCF). + The Sundanese Supplement Unicode block (U+1CC0-U+1CCF). + + + Gets the Superscripts and Subscripts Unicode block (U+2070-U+209F). + The Superscripts and Subscripts Unicode block (U+2070-U+209F). + + + Gets the Supplemental Arrows-A Unicode block (U+27F0-U+27FF). + The Supplemental Arrows-A Unicode block (U+27F0-U+27FF). + + + Gets the Supplemental Arrows-B Unicode block (U+2900-U+297F). + The Supplemental Arrows-B Unicode block (U+2900-U+297F). + + + Gets the Supplemental Mathematical Operators Unicode block (U+2A00-U+2AFF). + The Supplemental Mathematical Operators Unicode block (U+2A00-U+2AFF). + + + Gets the Supplemental Punctuation Unicode block (U+2E00-U+2E7F). + The Supplemental Punctuation Unicode block (U+2E00-U+2E7F). + + + Gets the Syloti Nagri Unicode block (U+A800-U+A82F). + The Syloti Nagri Unicode block (U+A800-U+A82F). + + + Gets the Syriac Unicode block (U+0700-U+074F). + The Syriac Unicode block (U+0700-U+074F). + + + A corresponding to the 'Syriac Supplement' Unicode block (U+0860..U+086F). + + + Gets the Tagalog Unicode block (U+1700-U+171F). + The Tagalog Unicode block (U+1700-U+171F). + + + Gets the Tagbanwa Unicode block (U+1760-U+177F). + The Tagbanwa Unicode block (U+1760-U+177F). + + + Gets the Tai Le Unicode block (U+1950-U+197F). + The Tai Le Unicode block (U+1950-U+197F). + + + Gets the Tai Tham Unicode block (U+1A20-U+1AAF). + The Tai Tham Unicode block (U+1A20-U+1AAF). + + + Gets the Tai Viet Unicode block (U+AA80-U+AADF). + The Tai Viet Unicode block (U+AA80-U+AADF). + + + Gets the Tamil Unicode block (U+0B80-U+0BFF). + The Tamil Unicode block (U+0B82-U+0BFA). + + + Gets the Telugu Unicode block (U+0C00-U+0C7F). + The Telugu Unicode block (U+0C00-U+0C7F). + + + Gets the Thaana Unicode block (U+0780-U+07BF). + The Thaana Unicode block (U+0780-U+07BF). + + + Gets the Thai Unicode block (U+0E00-U+0E7F). + The Thai Unicode block (U+0E00-U+0E7F). + + + Gets the Tibetan Unicode block (U+0F00-U+0FFF). + The Tibetan Unicode block (U+0F00-U+0FFF). + + + Gets the Tifinagh Unicode block (U+2D30-U+2D7F). + The Tifinagh Unicode block (U+2D30-U+2D7F). + + + Gets the Unified Canadian Aboriginal Syllabics Unicode block (U+1400-U+167F). + The Unified Canadian Aboriginal Syllabics Unicode block (U+1400-U+167F). + + + Gets the Unified Canadian Aboriginal Syllabics Extended Unicode block (U+18B0-U+18FF). + The Unified Canadian Aboriginal Syllabics Extended Unicode block (U+18B0-U+18FF). + + + Gets the Vai Unicode block (U+A500-U+A63F). + The Vai Unicode block (U+A500-U+A63F). + + + Gets the Variation Selectors Unicode block (U+FE00-U+FE0F). + The Variation Selectors Unicode block (U+FE00-U+FE0F). + + + Gets the Vedic Extensions Unicode block (U+1CD0-U+1CFF). + The Vedic Extensions Unicode block (U+1CD0-U+1CFF). + + + Gets the Vertical Forms Unicode block (U+FE10-U+FE1F). + The Vertical Forms Unicode block (U+FE10-U+FE1F). + + + Gets the Yijing Hexagram Symbols Unicode block (U+4DC0-U+4DFF). + The Yijing Hexagram Symbols Unicode block (U+4DC0-U+4DFF). + + + Gets the Yi Radicals Unicode block (U+A490-U+A4CF). + The Yi Radicals Unicode block (U+A490-U+A4CF). + + + Gets the Yi Syllables Unicode block (U+A000-U+A48F). + The Yi Syllables Unicode block (U+A000-U+A48F). + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/System.Text.Json.dll b/app_data/jobs/triggered/utility/System.Text.Json.dll new file mode 100644 index 000000000..dbd97228d Binary files /dev/null and b/app_data/jobs/triggered/utility/System.Text.Json.dll differ diff --git a/app_data/jobs/triggered/utility/System.Text.Json.xml b/app_data/jobs/triggered/utility/System.Text.Json.xml new file mode 100644 index 000000000..0071c5d20 --- /dev/null +++ b/app_data/jobs/triggered/utility/System.Text.Json.xml @@ -0,0 +1,2346 @@ + + + + System.Text.Json + + + + Defines how the struct handles comments. + + + Allows comments within the JSON input and treats them as valid tokens. While reading, the caller can access the comment values. + + + Doesn't allow comments within the JSON input. Comments are treated as invalid JSON if found, and a is thrown. This is the default value. + + + Allows comments within the JSON input and ignores them. The behaves as if no comments are present. + + + Provides a mechanism for examining the structural content of a JSON value without automatically instantiating data values. + + + Releases the resources used by this instance. + + + Parses a sequence as UTF-8-encoded text representing a single JSON byte value into a JsonDocument. + The JSON text to parse. + Options to control the reader behavior during parsing. + A JsonDocument representation of the JSON value. + + does not represent a valid single JSON value. + + contains unsupported options. + + + Parses a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The stream is read to completion. + The JSON data to parse. + Options to control the reader behavior during parsing. + A JsonDocument representation of the JSON value. + + does not represent a valid single JSON value. + + contains unsupported options. + + + Parses memory as UTF-8-encoded text representing a single JSON byte value into a JsonDocument. + The JSON text to parse. + Options to control the reader behavior during parsing. + A JsonDocument representation of the JSON value. + + does not represent a valid single JSON value. + + contains unsupported options. + + + Parses text representing a single JSON character value into a JsonDocument. + The JSON text to parse. + Options to control the reader behavior during parsing. + A JsonDocument representation of the JSON value. + + does not represent a valid single JSON value. + + contains unsupported options. + + + Parses text representing a single JSON string value into a JsonDocument. + The JSON text to parse. + Options to control the reader behavior during parsing. + A JsonDocument representation of the JSON value. + + does not represent a valid single JSON value. + + contains unsupported options. + + + Parses a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The stream is read to completion. + The JSON data to parse. + Options to control the reader behavior during parsing. + The token to monitor for cancellation requests. + A task to produce a JsonDocument representation of the JSON value. + + does not represent a valid single JSON value. + + contains unsupported options. + + + Parses one JSON value (including objects or arrays) from the provided reader. + The reader to read. + A JsonDocument representing the value (and nested values) read from the reader. + + contains unsupported options. +-or- +The current token does not start or represent a value. + A value could not be read from the reader. + + + Gets the root element of this JSON document. + A representing the value of the document. + + + Attempts to parse one JSON value (including objects or arrays) from the provided reader. + The reader to read. + When the method returns, contains the parsed document. + + if a value was read and parsed into a JsonDocument; if the reader ran out of data while parsing. All other situations result in an exception being thrown. + + contains unsupported options. +-or- +The current token does not start or represent a value. + A value could not be read from the reader. + + + Writes the document to the provided writer as a JSON value. + The writer to which to write the document. + The parameter is . + The of this would result in invalid JSON. + The parent has been disposed. + + + Provides the ability for the user to define custom behavior when parsing JSON to create a . + + + Gets or sets a value that indicates whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read. + + if an extra comma at the end of a list of JSON values in an object or array is allowed; otherwise, . Default is + + + Gets or sets a value that determines how the handles comments when reading through the JSON data. + One of the enumeration values that indicates how comments are handled. + The comment handling enum is set to a value that is not supported (or not within the enum range). + + + Gets or sets the maximum depth allowed when parsing JSON data, with the default (that is, 0) indicating a maximum depth of 64. + The maximum depth allowed when parsing JSON data. + The max depth is set to a negative value. + + + Represents a specific JSON value within a . + + + Represents an enumerator for the contents of a JSON array. + + + Gets the element in the collection at the current position of the enumerator. + The element in the collection at the current position of the enumerator. + + + Releases the resources used by this instance. + + + Returns an enumerator that iterates through a collection. + An enumerator that can be used to iterate through the array. + + + Advances the enumerator to the next element of the collection. + + if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. + + + Sets the enumerator to its initial position, which is before the first element in the collection. + + + Returns an enumerator that iterates through a collection. + An enumerator for an array of that can be used to iterate through the collection. + + + Returns an enumerator that iterates through a collection. + An enumerator that can be used to iterate through the collection. + + + Gets the element in the collection at the current position of the enumerator. + The element in the collection at the current position of the enumerator. + + + Gets a JsonElement that can be safely stored beyond the lifetime of the original . + A JsonElement that can be safely stored beyond the lifetime of the original . + + + Gets an enumerator to enumerate the values in the JSON array represented by this JsonElement. + An enumerator to enumerate the values in the JSON array represented by this JsonElement. + This value's is not . + The parent has been disposed. + + + Gets an enumerator to enumerate the properties in the JSON object represented by this JsonElement. + An enumerator to enumerate the properties in the JSON object represented by this JsonElement. + This value's is not . + The parent has been disposed. + + + Gets the number of values contained within the current array value. + The number of values contained within the current array value. + This value's is not . + The parent has been disposed. + + + Gets the value of the element as a . + The value of the element as a . + This value's is neither nor . + The parent has been disposed. + + + Gets the current JSON number as a . + The current JSON number as a . + This value's is not . + The value cannot be represented as a . + The parent has been disposed. + + + Gets the value of the element as a byte array. + The value decoded as a byte array. + This value's is not . + The value is not encoded as Base64 text and hence cannot be decoded to bytes. + The parent has been disposed. + + + Gets the value of the element as a . + The value of the element as a . + This value's is not . + The value cannot be read as a . + The parent has been disposed. + + + Gets the value of the element as a . + The value of the element as a . + This value's is not . + The value cannot be read as a . + The parent has been disposed. + + + Gets the current JSON number as a . + The current JSON number as a . + This value's is not . + The value cannot be represented as a . + The parent has been disposed. + + + Gets the current JSON number as a . + The current JSON number as a . + This value's is not . + The value cannot be represented as a . + The parent has been disposed. + + + Gets the value of the element as a . + The value of the element as a . + This value's is not . + The value cannot be represented as a . + The parent has been disposed. + + + Gets the current JSON number as an . + The current JSON number as an . + This value's is not . + The value cannot be represented as an . + The parent has been disposed. + + + Gets the current JSON number as an . + The current JSON number as an . + This value's is not . + The value cannot be represented as an . + The parent has been disposed. + + + Gets the current JSON number as an . + The current JSON number as an . + This value's is not . + The value cannot be represented as a . + The parent has been disposed. + + + Gets a representing the value of a required property identified by . + The UTF-8 representation (with no Byte-Order-Mark (BOM)) of the name of the property to return. + A representing the value of the requested property. + This value's is not . + No property was found with the requested name. + The parent has been disposed. + + + Gets a representing the value of a required property identified by . + The name of the property whose value is to be returned. + A representing the value of the requested property. + This value's is not . + No property was found with the requested name. + The parent has been disposed. + + + Gets a representing the value of a required property identified by . + The name of the property whose value is to be returned. + A representing the value of the requested property. + This value's is not . + No property was found with the requested name. + + is . + The parent has been disposed. + + + Gets a string that represents the original input data backing this value. + The original input data backing this value. + The parent has been disposed. + + + Gets the current JSON number as an . + The current JSON number as an . + This value's is not . + The value cannot be represented as an . + The parent has been disposed. + + + Gets the current JSON number as a . + The current JSON number as a . + This value's is not . + The value cannot be represented as a . + The parent has been disposed. + + + Gets the value of the element as a . + The value of the element as a . + This value's is neither nor . + The parent has been disposed. + + + Gets the current JSON number as a . + The current JSON number as a . + This value's is not . + The value cannot be represented as a . + The parent has been disposed. + + + Gets the current JSON number as a . + The current JSON number as a . + This value's is not . + The value cannot be represented as a . + The parent has been disposed. + + + Gets the current JSON number as a . + The current JSON number as a . + This value's is not . + The value cannot be represented as a . + The parent has been disposed. + + + Gets the value at the specified index if the current value is an . + The item index. + The value at the specified index. + This value's is not . + + is not in the range [0, ()). + The parent has been disposed. + + + Represents an enumerator for the properties of a JSON object. + + + Gets the element in the collection at the current position of the enumerator. + The element in the collection at the current position of the enumerator. + + + Releases the resources used by this instance. + + + Returns an enumerator that iterates the properties of an object. + An enumerator that can be used to iterate through the object. + + + Advances the enumerator to the next element of the collection. + + if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. + + + Sets the enumerator to its initial position, which is before the first element in the collection. + + + Returns an enumerator that iterates through a collection. + An enumerator for objects that can be used to iterate through the collection. + + + Returns an enumerator that iterates through a collection. + An enumerator that can be used to iterate through the collection. + + + Gets the element in the collection at the current position of the enumerator. + The element in the collection at the current position of the enumerator. + + + Gets a string representation for the current value appropriate to the value type. + A string representation for the current value appropriate to the value type. + The parent has been disposed. + + + Attempts to represent the current JSON number as a . + When the method returns, contains the byte equivalent of the current JSON number if the conversion succeeded. + + if the number can be represented as a ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON string as a byte array, assuming that it is Base64 encoded. + If the method succeeds, contains the decoded binary representation of the Base64 text. + + if the entire token value is encoded as valid Base64 text and can be successfully decoded to bytes; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON string as a . + When this method returns, contains the date and time value equivalent to the current JSON string. + + if the string can be represented as a ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON string as a . + When this method returns, contains the date and time equivalent to the current JSON string. + + if the string can be represented as a ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON number as a . + When this method returns, contains the decimal equivalent of the current JSON number. + + if the number can be represented as a ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON number as a . + When this method returns, contains a double-precision floating point value equivalent to the current JSON number. + + if the number can be represented as a ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON string as a . + When this method returns, contains the GUID equivalent to the current JSON string. + + if the string can be represented as a ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON number as an . + When the method returns, contains the 16-bit integer equivalent of the current JSON number if the conversion succeeded. + + if the number can be represented as an ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON number as an . + When this method returns, contains the 32-biut integer value equivalent to the current JSON number. + + if the number can be represented as an ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON number as a . + When this method returns, contains the 64-bit integer value equivalent to the current JSON number. + + if the number can be represented as a ; otherwise, . + This value's is not . + The parent has been disposed. + + + Looks for a property named in the current object, returning a value that indicates whether or not such a property exists. When the property exists, the method assigns its value to the argument. + The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. + Receives the value of the located property. + + if the property was found; otherwise, . + This value's is not . + The parent has been disposed. + + + Looks for a property named in the current object, returning a value that indicates whether or not such a property exists. When the property exists, the method assigns its value to the argument. + The name of the property to find. + When this method returns, contains the value of the specified property. + + if the property was found; otherwise, . + This value's is not . + The parent has been disposed. + + + Looks for a property named in the current object, returning a value that indicates whether or not such a property exists. When the property exists, its value is assigned to the argument. + The name of the property to find. + When this method returns, contains the value of the specified property. + + if the property was found; otherwise, . + This value's is not . + + is . + The parent has been disposed. + + + Attempts to represent the current JSON number as an . + When the method returns, contains the signed byte equivalent of the current JSON number if the conversion succeeded. + + if the number can be represented as an ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON number as a . + When this method returns, contains the single-precision floating point value equivalent to the current JSON number. + + if the number can be represented as a ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON number as a . + When the method returns, contains the unsigned 16-bit integer equivalent of the current JSON number if the conversion succeeded. + + if the number can be represented as a ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON number as a . + When this method returns, contains unsigned 32-bit integer value equivalent to the current JSON number. + + if the number can be represented as a ; otherwise, . + This value's is not . + The parent has been disposed. + + + Attempts to represent the current JSON number as a . + When this method returns, contains unsigned 64-bit integer value equivalent to the current JSON number. + + if the number can be represented as a ; otherwise, . + This value's is not . + The parent has been disposed. + + + Compares the text represented by a UTF8-encoded byte span to the string value of this element. + The UTF-8 encoded text to compare against. + + if the string value of this element has the same UTF-8 encoding as + ; otherwise, . + This value's is not . + + + Compares a specified read-only character span to the string value of this element. + The text to compare against. + + if the string value of this element matches ; otherwise, . + This value's is not . + + + Compares a specified string to the string value of this element. + The text to compare against. + + if the string value of this element matches ; otherwise, . + This value's is not . + + + Gets the type of the current JSON value. + The type of the current JSON value. + The parent has been disposed. + + + Writes the element to the specified writer as a JSON value. + The writer to which to write the element. + The parameter is . + The of this value is . + The parent has been disposed. + + + Provides methods to transform UTF-8 or UTF-16 encoded text into a form that is suitable for JSON. + + + Encodes a UTF-8 text value as a JSON string. + The UTF-8 encoded text to convert to JSON encoded text. + The encoder to use when escaping the string, or to use the default encoder. + The encoded JSON text. + + is too large. +-or- + contains invalid UTF-8 bytes. + + + Encodes a specified text value as a JSON string. + The value to convert to JSON encoded text. + The encoder to use when escaping the string, or to use the default encoder. + The encoded JSON text. + + is too large. +-or- + contains invalid UTF-16 characters. + + + Encodes the string text value as a JSON string. + The value to convert to JSON encoded text. + The encoder to use when escaping the string, or to use the default encoder. + The encoded JSON text. + + is . + + is too large. +-or- + contains invalid UTF-16 characters. + + + Gets the UTF-8 encoded representation of the pre-encoded JSON text. + The UTF-8 encoded representation of the pre-encoded JSON text. + + + Determines whether this instance and a specified object, which must also be a instance, have the same value. + The object to compare to this instance. + + if the current instance and are equal; otherwise, . + + + Determines whether this instance and another specified instance have the same value. + The object to compare to this instance. + + if this instance and have the same value; otherwise, . + + + Returns the hash code for this . + The hash code for this instance. + + + Converts the value of this instance to a . + The underlying UTF-16 encoded string. + + + Defines a custom exception object that is thrown when invalid JSON text is encountered, when the defined maximum depth is passed, or the JSON text is not compatible with the type of a property on an object. + + + Initializes a new instance of the class. + + + Creates a new exception object with serialized data. + The serialized object data about the exception being thrown. + An object that contains contextual information about the source or destination. + + is . + + + Initializes a new instance of the class with a specified error message. + The context-specific error message. + + + Initializes a new instance of the class, with a specified error message and a reference to the inner exception that is the cause of this exception. + The context-specific error message. + The exception that caused the current exception. + + + Creates a new exception object to relay error information to the user. + The context-specific error message. + The path where the invalid JSON was encountered. + The line number (starting at 0) at which the invalid JSON was encountered when deserializing. + The byte count within the current line (starting at 0) where the invalid JSON was encountered. + + + Creates a new exception object to relay error information to the user that includes a specified inner exception. + The context-specific error message. + The path where the invalid JSON was encountered. + The line number (starting at 0) at which the invalid JSON was encountered when deserializing. + The byte count (starting at 0) within the current line where the invalid JSON was encountered. + The exception that caused the current exception. + + + Gets the zero-based number of bytes read within the current line before the exception. + The zero-based number of bytes read within the current line before the exception. + + + Sets the with information about the exception. + The serialized object data about the exception being thrown. + An object that contains contextual information about the source or destination. + + + Gets the zero-based number of lines read before the exception. + The zero-based number of lines read before the exception. + + + Gets a message that describes the current exception. + The error message that describes the current exception. + + + Gets The path within the JSON where the exception was encountered. + The path within the JSON where the exception was encountered. + + + Determines the naming policy used to convert a string-based name to another format, such as a camel-casing format. + + + Initializes a new instance of . + + + Gets the naming policy for camel-casing. + The naming policy for camel-casing. + + + When overridden in a derived class, converts the specified name according to the policy. + The name to convert. + The converted name. + + + Represents a single property for a JSON object. + + + Gets the name of this property. + The name of this property. + + + Compares the specified UTF-8 encoded text to the name of this property. + The UTF-8 encoded text to compare against. + + if the name of this property has the same UTF-8 encoding as ; otherwise, . + This value's is not . + + + Compares the specified text as a character span to the name of this property. + The text to compare against. + + if the name of this property matches ; otherwise, . + This value's is not . + + + Compares the specified string to the name of this property. + The text to compare against. + + if the name of this property matches ; otherwise . + This value's is not . + + + Provides a string representation of the property for debugging purposes. + A string containing the uninterpreted value of the property, beginning at the declaring open-quote and ending at the last character that is part of the value. + + + Gets the value of this property. + The value of this property. + + + Writes the property to the provided writer as a named JSON object property. + The writer to which to write the property. + + is . + + is too large to be a JSON object property. + The of this JSON property's would result in invalid JSON. + The parent has been disposed. + + + Provides the ability for the user to define custom behavior when reading JSON. + + + Gets or sets a value that defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read. + + if an exra comma is allowed; otherwise, . + + + Gets or sets a value that determines how the handles comments when reading through the JSON data. + One of the enumeration values that indicates how comments are handled. + The property is being set to a value that is not a member of the enumeration. + + + Gets or sets the maximum depth allowed when reading JSON, with the default (that is, 0) indicating a maximum depth of 64. + The maximum depth allowed when reading JSON. + The maximum depth is being set to a negative value. + + + Defines an opaque type that holds and saves all the relevant state information, which must be provided to the to continue reading after processing incomplete data. + + + Constructs a new instance. + Defines the customized behavior of the that is different from the JSON RFC (for example how to handle comments, or the maximum depth allowed when reading). By default, the follows the JSON RFC strictly (comments within the JSON are invalid) and reads up to a maximum depth of 64. + The maximum depth is set to a non-positive value (< 0). + + + Gets the custom behavior to use when reading JSON data using the struct that may deviate from strict adherence to the JSON specification, which is the default behavior. + The custom behavior to use when reading JSON data. + + + Provides functionality to serialize objects or value types to JSON and to deserialize JSON into objects or value types. + + + Parses the UTF-8 encoded text representing a single JSON value into an instance of a specified type. + The JSON text to parse. + The type of the object to convert to and return. + Options to control the behavior during parsing. + A representation of the JSON value. + + is . + The JSON is invalid. +-or- + is not compatible with the JSON. +-or- +There is remaining data in the span beyond a single JSON value. + + + Parses the text representing a single JSON value into an instance of a specified type. + The JSON text to parse. + The type of the object to convert to and return. + Options to control the behavior during parsing. + A representation of the JSON value. + + or is . + The JSON is invalid. +-or- + is not compatible with the JSON. +-or- +There is remaining data in the string beyond a single JSON value. + + + Reads one JSON value (including objects or arrays) from the provided reader and converts it into an instance of a specified type. + The reader to read the JSON from. + The type of the object to convert to and return. + Options to control the serializer behavior during reading. + A representation of the JSON value. + + is . + The JSON is invalid. +-or- + is not compatible with the JSON. +-or- +A value could not be read from the reader. + + is using unsupported options. + + + Parses the UTF-8 encoded text representing a single JSON value into an instance of the type specified by a generic type parameter. + The JSON text to parse. + Options to control the behavior during parsing. + The target type of the UTF-8 encoded text. + A representation of the JSON value. + The JSON is invalid. +-or- + is not compatible with the JSON. +-or- +There is remaining data in the span beyond a single JSON value. + + + Parses the text representing a single JSON value into an instance of the type specified by a generic type parameter. + The JSON text to parse. + Options to control the behavior during parsing. + The target type of the JSON value. + A representation of the JSON value. + + is . + The JSON is invalid. +-or- + is not compatible with the JSON. +-or- +There is remaining data in the string beyond a single JSON value. + + + Reads one JSON value (including objects or arrays) from the provided reader into an instance of the type specified by a generic type parameter. + The reader to read the JSON from. + Options to control serializer behavior during reading. + The target type of the JSON value. + A representation of the JSON value. + The JSON is invalid. +-or- + is not compatible with the JSON. +-or- +A value could not be read from the reader. + + uses unsupported options. + + + Asynchronously reads the UTF-8 encoded text representing a single JSON value into an instance of a specified type. The stream will be read to completion. + The JSON data to parse. + The type of the object to convert to and return. + Options to control the behavior during reading. + A cancellation token that may be used to cancel the read operation. + A representation of the JSON value. + + or is . + The JSON is invalid. +-or- + is not compatible with the JSON. +-or- +There is remaining data in the stream. + + + Asynchronously reads the UTF-8 encoded text representing a single JSON value into an instance of a type specified by a generic type parameter. The stream will be read to completion. + The JSON data to parse. + Options to control the behavior during reading. + A token that may be used to cancel the read operation. + The target type of the JSON value. + A representation of the JSON value. + The JSON is invalid. +-or- + is not compatible with the JSON. +-or- +There is remaining data in the stream. + + + Converts the value of a specified type into a JSON string. + The value to convert. + The type of the to convert. + Options to control the conversion behavior. + The JSON string representation of the value. + + + Writes the JSON representation of the specified type to the provided writer. + The JSON writer to write to. + The value to convert and write. + The type of the to convert. + Options to control serialization behavior. + + + Converts the value of a type specified by a generic type parameter into a JSON string. + The value to convert. + Options to control serialization behavior. + The type of the value to serialize. + A JSON string representation of the value. + + + Writes the JSON representation of a type specified by a generic type parameter to the provided writer. + A JSON writer to write to. + The value to convert and write. + Options to control serialization behavior. + The type of the value to serialize. + + + Asynchronously converts the value of a specified type to UTF-8 encoded JSON text and writes it to the specified stream. + The UTF-8 stream to write to. + The value to convert. + The type of the to convert. + Options to control serialization behavior. + A token that may be used to cancel the write operation. + A task that represents the asynchronous write operation. + + + Asynchronously converts a value of a type specified by a generic type parametaer to UTF-8 encoded JSON text and writes it to a stream. + The UTF-8 stream to write to. + The value to convert. + Options to control serialization behavior. + A token that may be used to cancel the write operation. + The type of the value to serialize. + A task that represents the asynchronous write operation. + + + Converts a value of the specified type into a JSON string, encoded as UTF-8 bytes. + The value to convert. + The type of the to convert. + Options to control the conversion behavior. + A JSON string representation of the value, encoded as UTF-8 bytes. + + + Converts the value of a type specifed by a generic type parameter into a JSON string, encoded as UTF-8 bytes. + The value to convert. + Options to control the conversion behavior. + The type of the value. + A JSON string representation of the value, encoded as UTF-8 bytes. + + + Provides options to be used with . + + + Initializes a new instance of the class. + + + Get or sets a value that indicates whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being deserialized. + + if an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored); otherwise. + This property was set after serialization or deserialization has occurred. + + + Gets the list of user-defined converters that were registered. + The list of custom converters. + + + Gets or sets the default buffer size, in bytes, to use when creating temporary buffers. + The default buffer size in bytes. + The buffer size is less than 1. + This property was set after serialization or deserialization has occurred. + + + Gets or sets the policy used to convert a key's name to another format, such as camel-casing. + The policy used to convert a key's name to another format. + + + Gets or sets the encoder to use when escaping strings, or to use the default encoder. + The JavaScript character encoding. + + + Returns the converter for the specified type. + The type to return a converter for. + The first converter that supports the given type, or if there is no converter. + + + Gets or sets a value that determines whether values are ignored during serialization and deserialization. The default value is . + + to ignore null values during serialization and deserialization; otherwise, see langword="false" />. + This property was set after serialization or deserialization has occurred. + + + Gets a value that determines whether read-only properties are ignored during serialization. The default value is . + + to ignore read-only properties during serialization; otherwise, . + This property was set after serialization or deserialization has occurred. + + + Gets or sets the maximum depth allowed when serializing or deserializing JSON, with the default value of 0 indicating a maximum depth of 64. + The maximum depth allowed when serializing or deserializing JSON. + This property was set after serialization or deserialization has occurred. + The max depth is set to a negative value. + + + Gets or sets a value that determines whether a property's name uses a case-insensitive comparison during deserialization. The default value is . + + to compare property names using case-insensitive comparison; otherwise, . + + + Gets or sets a value that specifies the policy used to convert a property's name on an object to another format, such as camel-casing. + One of the enum values from . + + + Gets or sets a value that defines how comments are handled during deserialization. + A value that indicates whether comments are allowed, disallowed, or skipped. + This property was set after serialization or deserialization has occurred. + The comment handling enum is set to a value that is not supported (or not within the enum range). + + + Gets or sets a value that defines whether JSON should use pretty printing. By default, JSON is serialized without any extra white space. + + if JSON should pretty print on serialization; otherwise, . The default is . + This property was set after serialization or deserialization has occurred. + + + Defines the various JSON tokens that make up a JSON text. + + + The token type is a comment string. + + + The token type is the end of a JSON array. + + + The token type is the end of a JSON object. + + + The token type is the JSON literal false. + + + There is no value (as distinct from ). + + + The token type is the JSON literal null. + + + The token type is a JSON number. + + + The token type is a JSON property name. + + + The token type is the start of a JSON array. + + + The token type is the start of a JSON object. + + + The token type is a JSON string. + + + The token type is the JSON literal true. + + + Specifies the data type of a JSON value. + + + A JSON array. + + + The JSON value false. + + + The JSON value null. + + + A JSON number. + + + A JSON object. + + + A JSON string. + + + The JSON value true. + + + There is no value (as distinct from ). + + + Allows the user to define custom behavior when writing JSON using the . + + + Gets or sets the encoder to use when escaping strings, or to use the default encoder. + The JavaScript character encoder used to override the escaping behavior. + + + Gets or sets a value that indicates whether the should format the JSON output, which includes indenting nested JSON tokens, adding new lines, and adding white space between property names and values. + + to format the JSON output; to write without any extra white space. The default is . + + + Gets or sets a value that indicates whether the should skip structural validation and allow the user to write invalid JSON. + + to skip structural validation and allow invalid JSON; to throw an on any attempt to write invalid JSON. + + + Provides the base class for serialization attributes. + + + Creates a new instance of the . + + + Converts an object or value to or from JSON. + + + When overridden in a derived class, determines whether the converter instance can convert the specified object type. + The type of the object to check whether it can be converted by this converter instance. + + if the instance can convert the specified object type; otherwise, . + + + Converts an object or value to or from JSON. + The type of object or value handled by the converter. + + + Initializes a new instance. + + + Determines whether the specified type can be converted. + The type to compare against. + + if the type can be converted; otherwise, . + + + Reads and converts the JSON to type . + The reader. + The type to convert. + An object that specifies serialization options to use. + The converted value. + + + Writes a specified value as JSON. + The writer to write to. + The value to convert to JSON. + An object that specifies serialization options to use. + + + When placed on a property or type, specifies the converter type to use. + + + Initializes a new instance of . + + + Initializes a new instance of with the specified converter type. + The type of the converter. + + + Gets the type of the , or if it was created without a type. + The type of the , or if it was created without a type. + + + When overridden in a derived class and is , allows the derived class to create a in order to pass additional state. + The type of the converter. + The custom converter. + + + Supports converting several types by using a factory pattern. + + + When overidden in a derived class, initializes a new instance of the class. + + + Creates a converter for a specified type. + The type handled by the converter. + The serialization options to use. + A converter for which is compatible with . + + + When placed on a property of type , any properties that do not have a matching member are added to that dictionary during deserialization and written during serialization. + + + Instantiates a new instance of the class. + + + Prevents a property from being serialized or deserialized. + + + Initializes a new instance of . + + + Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by . + + + Initializes a new instance of with the specified property name. + The name of the property. + + + Gets the name of the property. + The name of the property. + + + Converts enumeration values to and from strings. + + + Initializes an instance of the class with the default naming policy that allows integer values. + + + Initializes an instance of the class with a specified naming policy and a value that indicates whether undefined enumeration values are allowed. + The optional naming policy for writing enum values. + + to allow undefined enum values; otherwise, . When , if an enum value isn't defined, it will output as a number rather than a string. + + + Determines whether the specified type can be converted to an enum. + The type to be checked. + + if the type can be converted; otherwise, . + + + Creates a converter for the specified type. + The type handled by the converter. + The serialization options to use. + A converter for which is compatible with . + + + Provides a high-performance API for forward-only, read-only access to UTF-8 encoded JSON text. + + + Initializes a new instance of the structure that processes a read-only sequence of UTF-8 encoded text and indicates whether the input contains all the text to process. + The UTF-8 encoded JSON text to process. + + to indicate that the input sequence contains the entire data to process; to indicate that the input span contains partial data with more data to follow. + An object that contains the reader state. If this is the first call to the constructor, pass in a default state. Otherwise, capture the state from the previous instance of the by getting the value of the property and pass that back. + + + Initializes a new instance of the structure that processes a read-only sequence of UTF-8 encoded text using the specified options. + The UTF-8 encoded JSON text to process. + Defines customized behavior of the that differs from the JSON RFC (for example how to handle comments or maximum depth allowed when reading). By default, the follows the JSON RFC strictly; comments within the JSON are invalid, and the maximum depth is 64. + + + Initializes a new instance of the structure that processes a read-only span of UTF-8 encoded text and indicates whether the input contains all the text to process. + The UTF-8 encoded JSON text to process. + + to indicate that the input sequence contains the entire data to process; to indicate that the input span contains partial data with more data to follow. + An object that contains the reader state. If it's the first call to the constructor, pass in the default state. Otherwise, capture the state from the previous instance instance of the by getting the value of the property and pass that back. + + + Initializes a new instance of the structure that processes a read-only span of UTF-8 encoded text using the specified options. + The UTF-8 encoded JSON text to process. + Defines customized behavior of the that differs from the JSON RFC (for example how to handle comments or maximum depth allowed when reading). By default, the follows the JSON RFC strictly; comments within the JSON are invalid, and the maximum depth is 64. + + + Gets the total number of bytes consumed so far by this instance of the . + The total number of bytes consumed so far. + + + Gets the depth of the current token. + The depth of the current token. + + + Gets the current state to pass to a constructor with more data. + The current reader state. + + + Reads the next JSON token value from the source as a . + + if the is ; if the is . + The value of the JSON token isn't a boolean value (that is, or ). + + + Parses the current JSON token value from the source as a . + The value of the UTF-8 encoded token. + The value of the JSON token is not a . + The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation). +-or- +The JSON token value represents a number less than or greater than . + + + Parses the current JSON token value from the source and decodes the Base64 encoded JSON string as a byte array. + The byte array that represents the current JSON token value. + The type of the JSON token is not a . + The value is not encoded as Base64 text, so it can't be decoded to bytes. + + + Parses the current JSON token value from the source as a comment, transcoded it as a . + The comment that represents the current JSON token value. + The JSON token is not a comment. + + + Reads the next JSON token value from the source and parses it to a . + The date and time value, if the entire UTF-8 encoded token value can be successfully parsed. + The value of the JSON token isn't a . + The JSON token value cannot be read as a . +-or- +The entire UTF-8 encoded token value cannot be parsed to a value. + + + Reads the next JSON token value from the source and parses it to a . + The date and time offset, if the entire UTF-8 encoded token value can be successfully parsed. + The value of the JSON token isn't a . + The JSON token value cannot be read as a . +-or- +The entire UTF-8 encoded token value cannot be parsed to a value. + + + Reads the next JSON token value from the source and parses it to a . + The UTF-8 encoded token value parsed to a . + The JSON token value isn't a . + The JSON token value represents a number less than or greater than . + + + Reads the next JSON token value from the source and parses it to a . + The UTF-8 encoded token value parsed to a . + The JSON token value isn't a . + The JSON token value represents a number less than or greater than . + + + Reads the next JSON token value from the source and parses it to a . + The GUID value, if the entire UTF-8 encoded token value can be successfully parsed. + The value of the JSON token isn't a . + The JSON token value is in an unsupported format for a Guid. +-or- +The entire UTF-8 encoded token value cannot be parsed to a value. + + + Parses the current JSON token value from the source as a . + The UTF-8 encoded token value parsed to an . + The value of the JSON token is not a . + The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation). +-or- +The JSON token value represents a number less than or greater than . + + + Reads the next JSON token value from the source and parses it to an . + The UTF-8 encoded token value parsed to an . + The JSON token value isn't a . + The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. +-or- +The JSON token value represents a number less than or greater than . + + + Reads the next JSON token value from the source and parses it to an . + The UTF-8 encoded token value parsed to an . + The JSON token value isn't a . + The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. +-or- +The JSON token value represents a number less than or greater than . + + + Parses the current JSON token value from the source as an . + The UTF-8 encoded token value parsed to an . + The value of the JSON token is not a . + The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation). +-or- +The JSON token value represents a number less than or greater than . + + + Reads the next JSON token value from the source and parses it to a . + The UTF-8 encoded token value parsed to a . + The JSON token value isn't a . + The JSON token value represents a number less than or greater than . + + + Reads the next JSON token value from the source, unescaped, and transcoded as a string. + The token value parsed to a string, or if is . + The JSON token value isn't a string (that is, not a , , or ). +-or- +The JSON string contains invalid UTF-8 bytes or invalid UTF-16 surrogates. + + + Parses the current JSON token value from the source as a . + The UTF-8 encoded token value parsed to a . + The value of the JSON token is not a . + The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation). +-or- +The JSON token value represents a number less than or greater than . + + + Reads the next JSON token value from the source and parses it to a . + The UTF-8 encoded token value parsed to a . + The JSON token value isn't a . + The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. +-or- +The JSON token value represents a number less than or greater than . + + + Reads the next JSON token value from the source and parses it to a . + The UTF-8 encoded token value parsed to a . + The JSON token value isn't a . + The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. +-or- +The JSON token value represents a number less than or greater than . + + + Gets a value that indicates which Value property to use to get the token value. + + if should be used to get the token value; if should be used instead. + + + Gets the mode of this instance of the which indicates whether all the JSON data was provided or there is more data to come. + + if the reader was constructed with the input span or sequence containing the entire JSON data to process; if the reader was constructed with an input span or sequence that may contain partial JSON data with more data to follow. + + + Gets the current within the provided UTF-8 encoded input ReadOnlySequence<byte> or a default if the struct was constructed with a ReadOnlySpan<byte>. + The current within the provided UTF-8 encoded input ReadOnlySequence<byte> or a default if the struct was constructed with a ReadOnlySpan<byte>. + + + Reads the next JSON token from the input source. + + if the token was read successfully; otherwise, . + An invalid JSON token according to the JSON RFC is encountered. +-or- +The current depth exceeds the recursive limit set by the maximum depth. + + + Skips the children of the current JSON token. + The reader was given partial data with more data to follow (that is, is ). + An invalid JSON token was encountered while skipping, according to the JSON RFC. +-or- +The current depth exceeds the recursive limit set by the maximum depth. + + + Gets the index that the last processed JSON token starts at (within the given UTF-8 encoded input text), skipping any white space. + The starting index of the last processed JSON token within the given UTF-8 encoded input text. + + + Gets the type of the last processed JSON token in the UTF-8 encoded JSON text. + The type of the last processed JSON token. + + + Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + The JSON token value isn't a . + + + Tries to parse the current JSON token value from the source and decodes the Base64 encoded JSON string as a byte array and returns a value that indicates whether the operation succeeded. + When this method returns, contains the decoded binary representation of the Base64 text. + + if the entire token value is encoded as valid Base64 text and can be successfully decoded to bytes; otherwise, . + The JSON token is not a . + + + Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + The value of the JSON token isn't a . + + + Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + The value of the JSON token isn't a . + + + Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + The JSON token value isn't a . + + + Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + The JSON token value isn't a . + + + Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + The value of the JSON token isn't a . + + + Tries to parse the current JSON token value from the source as an and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + The JSON token value isn't a . + + + Tries to parse the current JSON token value from the source as an and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . + The JSON token value isn't a . + + + Tries to parse the current JSON token value from the source as an and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . + The JSON token value isn't a . + + + Tries to parse the current JSON token value from the source as an and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . + The JSON token value isn't a . + + + Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . + The JSON token value isn't a . + + + Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + The JSON token value isn't a . + + + Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + The JSON token value isn't a . + + + Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. + When this method returns, contains the parsed value. + + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + The JSON token value isn't a . + + + Tries to skip the children of the current JSON token. + + if there was enough data for the children to be skipped successfully; otherwise, . + An invalid JSON token was encountered while skipping, according to the JSON RFC. +-or - +The current depth exceeds the recursive limit set by the maximum depth. + + + Gets the raw value of the last processed token as a ReadOnlySequence<byte> slice of the input payload, only if the token is contained within multiple segments. + A byte read-only sequence. + + + Gets the raw value of the last processed token as a ReadOnlySpan<byte> slice of the input payload, if the token fits in a single segment or if the reader was constructed with a JSON payload contained in a ReadOnlySpan<byte>. + A read-only span of bytes. + + + Compares the UTF-8 encoded text in a read-only byte span to the unescaped JSON token value in the source and returns a value that indicates whether they match. + The UTF-8 encoded text to compare against. + + if the JSON token value in the source matches the UTF-8 encoded lookup text; otherwise, . + The JSON token is not a JSON string (that is, it is not or ). + + + Compares the text in a read-only character span to the unescaped JSON token value in the source and returns a value that indicates whether they match. + The text to compare against. + + if the JSON token value in the source matches the lookup text; otherwise, . + The JSON token is not a JSON string (that is, it is not or ). + + + Compares the string text to the unescaped JSON token value in the source and returns a value that indicates whether they match. + The text to compare against. + + if the JSON token value in the source matches the lookup text; otherwise, . + The JSON token is not a JSON string (that is, it is not or ). + + + Provides a high-performance API for forward-only, non-cached writing of UTF-8 encoded JSON text. + + + Initializes a new instance of the class using the specified to write the output to and customization options. + The destination for writing JSON text. + Defines the customized behavior of the . By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC. + + is . + + + Initializes a new instance of the class using the specified stream to write the output to and customization options. + The destination for writing JSON text. + Defines the customized behavior of the . By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC. + + is . + + + Gets the total number of bytes committed to the output by the current instance so far. + The total number of bytes committed to the output by the so far. + + + Gets the number of bytes written by the so far that have not yet been flushed to the output and committed. + The number of bytes written so far by the that have not yet been flushed to the output and committed. + + + Gets the depth of the current token. + The depth of the current token. + + + Commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance. + + + Asynchronously commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance. + A task representing the asynchronous dispose operation. + + + Commits the JSON text written so far, which makes it visible to the output destination. + This instance has been disposed. + + + Asynchronously commits the JSON text written so far, which makes it visible to the output destination. + The token to monitor for cancellation requests. The default value is . + A task representing the asynchronous flush operation. + This instance has been disposed. + + + Gets the custom behavior when writing JSON using this instance, which indicates whether to format the output while writing, whether to skip structural JSON validation, and which characters to escape. + The custom behavior of this instance of the writer for formatting, validating, and escaping. + + + Resets the internal state of this instance so that it can be reused. + This instance has been disposed. + + + Resets the internal state of this instance so that it can be reused with a new instance of . + The destination for writing JSON text. + + is . + This instance has been disposed. + + + Resets the internal state of this instance so that it can be reused with a new instance of . + The destination for writing JSON text. + + is . + This instance has been disposed. + + + Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object. + The UTF-8 encoded name of the property to write. + The binary data to write as Base64 encoded text. + The specified property name or value is too large. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object. + The property name of the JSON object to be transcoded and written as UTF-8. + The binary data to write as Base64 encoded text. + The specified property name or value is too large. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object. + The property name of the JSON object to be transcoded and written as UTF-8. + The binary data to write as Base64 encoded text. + The specified property name or value is too large. + Validation is enabled, and this method would result in writing invalid JSON. + The parameter is . + + + Writes the pre-encoded property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object. + The JSON-encoded name of the property to write. + The binary data to write as Base64 encoded text. + The specified value is too large. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes the raw bytes value as a Base64 encoded JSON string as an element of a JSON array. + The binary data to be written as a Base64 encoded JSON string element of a JSON array. + The specified value is too large. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes a property name specified as a read-only span of bytes and a value (as a JSON literal true or false) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON literal true or false as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a property name specified as a read-only character span and a value (as a JSON literal true or false) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON literal true or false as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a property name specified as a string and a value (as a JSON literal true or false) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON literal true or false as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the operation would result in writing invalid JSON. + The parameter is . + + + Writes the pre-encoded property name and value (as a JSON literal true or false) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON literal true or false as part of the name/value pair. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes a value (as a JSON literal true or false) as an element of a JSON array. + The value to be written as a JSON literal true or false as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a UTF-8 text value as a JSON comment. + The UTF-8 encoded value to be written as a JSON comment within /*..*/. + The specified value is too large. +-or- + contains a comment delimiter (that is, */). + + + Writes a UTF-16 text value as a JSON comment. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/. + The specified value is too large. +-or- + contains a comment delimiter (that is, */). + + + Writes a string text value as a JSON comment. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/. + The specified value is too large. +-or- + contains a comment delimiter (that is, */). + The parameter is . + + + Writes the end of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes the end of a JSON object. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a property name specified as a read-only span of bytes and the JSON literal null as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only character span and the JSON literal null as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a string and the JSON literal null as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes the pre-encoded property name and the JSON literal null as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes the JSON literal null as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only span of bytes and an value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only span of bytes and an value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only character span and an value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only character span and an value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes a property name specified as a string and an value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes a property name specified as a string and an value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes a value (as a JSON number) as an element of a JSON array. + The value to be written as a JSON number as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a value (as a JSON number) as an element of a JSON array. + The value to be written as a JSON number as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes an value (as a JSON number) as an element of a JSON array. + The value to be written as a JSON number as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes an value (as a JSON number) as an element of a JSON array. + The value to be written as a JSON number as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a value (as a JSON number) as an element of a JSON array. + The value to be written as a JSON number as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a value (as a JSON number) as an element of a JSON array. + The value to be written as a JSON number as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a value (as a JSON number) as an element of a JSON array. + The value to be written as a JSON number as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes the UTF-8 property name (as a JSON string) as the first part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The specified property name is too large. + Validation is enabled, and this write operation would produce invalid JSON. + + + Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object. + The property name of the JSON object to be transcoded and written as UTF-8. + The specified property name is too large. + Validation is enabled, and this write operation would produce invalid JSON. + + + Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object. + The property name of the JSON object to be transcoded and written as UTF-8. + The specified property name is too large. + Validation is enabled, and this write operation would produce invalid JSON. + + is . + + + Writes the pre-encoded property name (as a JSON string) as the first part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + Validation is enabled, and this write operation would produce invalid JSON. + + + Writes the beginning of a JSON array. + The depth of the JSON exceeds the maximum depth of 1000. +-or- +Validation is enabled, and this write operation would produce invalid JSON. + + + Writes the beginning of a JSON array with a property name specified as a read-only span of bytes as the key. + The UTF-8 encoded property name of the JSON array to be written. + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. +-or- +Validation is enabled, and this write operation would produce invalid JSON. + + + Writes the beginning of a JSON array with a property name specified as a read-only character span as the key. + The UTF-16 encoded property name of the JSON array to be transcoded and written as UTF-8. + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. +-or- +Validation is enabled, and this write operation would produce invalid JSON. + + + Writes the beginning of a JSON array with a property name specified as a string as the key. + The UTF-16 encoded property name of the JSON array to be transcoded and written as UTF-8. + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. +-or- +Validation is enabled, and this write operation would produce invalid JSON. + The parameter is . + + + Writes the beginning of a JSON array with a pre-encoded property name as the key. + The JSON encoded property name of the JSON array to be transcoded and written as UTF-8. + The depth of the JSON has exceeded the maximum depth of 1000. +-or- +Validation is enabled, and this method would result in writing invalid JSON. + + + Writes the beginning of a JSON object. + The depth of the JSON exceeds the maximum depth of 1000. +-or- +Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes the beginning of a JSON object with a property name specified as a read-only span of bytes as the key. + The UTF-8 encoded property name of the JSON object to be written. + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. +-or- +Validation is enabled, and this write operation would produce invalid JSON. + + + Writes the beginning of a JSON object with a property name specififed as a read-only character span as the key. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. +-or- +Validation is enabled, and this write operation would produce invalid JSON. + + + Writes the beginning of a JSON object with a property name specified as a string as the key. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. +-or- +Validation is enabled, and this write operation would produce invalid JSON. + The parameter is . + + + Writes the beginning of a JSON object with a pre-encoded property name as the key. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The depth of the JSON has exceeded the maximum depth of 1000. +-or- +Validation is enabled, and this method would result in writing invalid JSON. + + + Writes a UTF-8 property name and a value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a UTF-8 property name and a value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a UTF-8 property name and a value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a UTF-8 property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a UTF-8 property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a UTF-8 property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes the UTF-8 property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-8 encoded property name of the JSON object to be written. + The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and this method would result in writing invalid JSON. + + + Writes a property name specified as a read-only character span and a value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only character span and a value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a read-only character span and a value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a UTF-16 property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a UTF-16 property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a UTF-16 property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes the property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. + The property name of the JSON object to be transcoded and written as UTF-8. + The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a property name specified as a string and a value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes a property name specified as a string and a value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes a property name specified as a string and a value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes a property name specified as a string and a UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes a property name specified as a string and a UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes a property name specified as a string and a string text value (as a JSON string) as part of a name/value pair of a JSON object. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes the property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. + The property name of the JSON object to be transcoded and written as UTF-8. + The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. + The parameter is . + + + Writes the pre-encoded property name and value (as a JSON string) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes the pre-encoded property name and value (as a JSON string) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes the pre-encoded property name and value (as a JSON string) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes the pre-encoded property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes the pre-encoded property name and text value (as a JSON string) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes the pre-encoded property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes the pre-encoded property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. + The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. + The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a value (as a JSON string) as an element of a JSON array. + The value to be written as a JSON string as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a value (as a JSON string) as an element of a JSON array. + The value to be written as a JSON string as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a value (as a JSON string) as an element of a JSON array. + The value to be written as a JSON string as an element of a JSON array. + Validation is enabled, and the operation would result in writing invalid JSON. + + + Writes a UTF-8 text value (as a JSON string) as an element of a JSON array. + The UTF-8 encoded value to be written as a JSON string element of a JSON array. + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a UTF-16 text value (as a JSON string) as an element of a JSON array. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array. + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes a string text value (as a JSON string) as an element of a JSON array. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array. + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON. + + + Writes the pre-encoded text value (as a JSON string) as an element of a JSON array. + The JSON encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array. + Validation is enabled, and the write operation would produce invalid JSON. + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/System.Threading.Channels.dll b/app_data/jobs/triggered/utility/System.Threading.Channels.dll new file mode 100644 index 000000000..0cd63c335 Binary files /dev/null and b/app_data/jobs/triggered/utility/System.Threading.Channels.dll differ diff --git a/app_data/jobs/triggered/utility/System.Threading.Channels.xml b/app_data/jobs/triggered/utility/System.Threading.Channels.xml new file mode 100644 index 000000000..1e9482b3b --- /dev/null +++ b/app_data/jobs/triggered/utility/System.Threading.Channels.xml @@ -0,0 +1,217 @@ + + + + System.Threading.Channels + + + + Specifies the behavior to use when writing to a bounded channel that is already full. + + + Removes and ignores the newest item in the channel in order to make room for the item being written. + + + Removes and ignores the oldest item in the channel in order to make room for the item being written. + + + Drops the item being written. + + + Waits for space to be available in order to complete the write operation. + + + Provides options that control the behavior of bounded instances. + + + Initializes the options. + The maximum number of items the bounded channel may store. + + + Gets or sets the maximum number of items the bounded channel may store. + + + Gets or sets the behavior incurred by write operations when the channel is full. + + + Provides static methods for creating channels. + + + Creates a channel with the specified maximum capacity. + The maximum number of items the channel may store. + Specifies the type of data in the channel. + The created channel. + + + Creates a channel with the specified maximum capacity. + Options that guide the behavior of the channel. + Specifies the type of data in the channel. + The created channel. + + + Creates an unbounded channel usable by any number of readers and writers concurrently. + The type of data in the channel. + The created channel. + + + Creates an unbounded channel subject to the provided options. + Options that guide the behavior of the channel. + Specifies the type of data in the channel. + The created channel. + + + Provides a base class for channels that support reading and writing elements of type . + Specifies the type of data readable and writable in the channel. + + + Initializes an instance of the class. + + + Provides a base class for channels that support reading elements of type and writing elements of type . + Specifies the type of data that may be written to the channel. + Specifies the type of data that may be read from the channel. + + + Initializes an instance of the class. + + + Implicit cast from a to its readable half. + The being cast. + The readable half. + + + Implicit cast from a to its writable half. + The being cast. + The writable half. + + + Gets the readable half of this channel. + + + Gets the writable half of this channel. + + + Exception thrown when a channel is used after it's been closed. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class. + The exception that is the cause of this exception. + + + Initializes a new instance of the class with serialized data. + The object that holds the serialized object data. + The contextual information about the source or destination. + + + Initializes a new instance of the class. + The message that describes the error. + + + Initializes a new instance of the class. + The message that describes the error. + The exception that is the cause of this exception. + + + Provides options that control the behavior of channel instances. + + + Initializes an instance of the class. + + + + if operations performed on a channel may synchronously invoke continuations subscribed to +notifications of pending async operations; if all continuations should be invoked asynchronously. + + + + readers from the channel guarantee that there will only ever be at most one read operation at a time; + if no such constraint is guaranteed. + + + + if writers to the channel guarantee that there will only ever be at most one write operation +at a time; if no such constraint is guaranteed. + + + Provides a base class for reading from a channel. + Specifies the type of data that may be read from the channel. + + + Initializes an instance of the class. + + + Gets a that completes when no more data will ever +be available to be read from this channel. + + + Creates an that enables reading all of the data from the channel. + The cancellation token to use to cancel the enumeration. + The created async enumerable. + + + Asynchronously reads an item from the channel. + A used to cancel the read operation. + A that represents the asynchronous read operation. + + + Attempts to read an item from the channel. + The read item, or a default value if no item could be read. + + if an item was read; otherwise, . + + + Returns a that will complete when data is available to read. + A used to cancel the wait operation. + A that will complete with a result when data is available to read + or with a result when no further data will ever be available to be read due to the channel completing successfully. + If the channel completes with an exception, the task will also complete with an exception. +. + + + Provides a base class for writing to a channel. + Specifies the type of data that may be written to the channel. + + + Initializes an instance of the class. + + + Mark the channel as being complete, meaning no more items will be written to it. + Optional Exception indicating a failure that's causing the channel to complete. + The channel has already been marked as complete. + + + Attempts to mark the channel as being completed, meaning no more data will be written to it. + An indicating the failure causing no more data to be written, or null for success. + + if this operation successfully completes the channel; otherwise, if the channel could not be marked for completion, +for example due to having already been marked as such, or due to not supporting completion. +. + + + Attempts to write the specified item to the channel. + The item to write. + + if the item was written; otherwise, . + + + Returns a that will complete when space is available to write an item. + A used to cancel the wait operation. + A that will complete with a result when space is available to write an item +or with a result when no further writing will be permitted. + + + Asynchronously writes an item to the channel. + The value to write to the channel. + A used to cancel the write operation. + A that represents the asynchronous write operation. + + + Provides options that control the behavior of unbounded instances. + + + Initializes a new instance of the class. + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/System.Threading.Tasks.Extensions.dll b/app_data/jobs/triggered/utility/System.Threading.Tasks.Extensions.dll new file mode 100644 index 000000000..e059050bb Binary files /dev/null and b/app_data/jobs/triggered/utility/System.Threading.Tasks.Extensions.dll differ diff --git a/app_data/jobs/triggered/utility/System.Threading.Tasks.Extensions.xml b/app_data/jobs/triggered/utility/System.Threading.Tasks.Extensions.xml new file mode 100644 index 000000000..5e02a99d7 --- /dev/null +++ b/app_data/jobs/triggered/utility/System.Threading.Tasks.Extensions.xml @@ -0,0 +1,166 @@ + + + System.Threading.Tasks.Extensions + + + + + + + + + + + + + + + + + + + Provides a value type that wraps a and a TResult, only one of which is used. + The result. + + + Initializes a new instance of the class using the supplied task that represents the operation. + The task. + The task argument is null. + + + Initializes a new instance of the class using the supplied result of a successful operation. + The result. + + + Retrieves a object that represents this . + The object that is wrapped in this if one exists, or a new object that represents the result. + + + Configures an awaiter for this value. + true to attempt to marshal the continuation back to the captured context; otherwise, false. + The configured awaiter. + + + Creates a method builder for use with an async method. + The created builder. + + + Determines whether the specified object is equal to the current object. + The object to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + Determines whether the specified object is equal to the current object. + The object to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + Creates an awaiter for this value. + The awaiter. + + + Returns the hash code for this instance. + The hash code for the current object. + + + Gets a value that indicates whether this object represents a canceled operation. + true if this object represents a canceled operation; otherwise, false. + + + Gets a value that indicates whether this object represents a completed operation. + true if this object represents a completed operation; otherwise, false. + + + Gets a value that indicates whether this object represents a successfully completed operation. + true if this object represents a successfully completed operation; otherwise, false. + + + Gets a value that indicates whether this object represents a failed operation. + true if this object represents a failed operation; otherwise, false. + + + Compares two values for equality. + The first value to compare. + The second value to compare. + true if the two values are equal; otherwise, false. + + + Determines whether two values are unequal. + The first value to compare. + The seconed value to compare. + true if the two values are not equal; otherwise, false. + + + Gets the result. + The result. + + + Returns a string that represents the current object. + A string that represents the current object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/System.ValueTuple.dll b/app_data/jobs/triggered/utility/System.ValueTuple.dll new file mode 100644 index 000000000..4ce28fdea Binary files /dev/null and b/app_data/jobs/triggered/utility/System.ValueTuple.dll differ diff --git a/app_data/jobs/triggered/utility/System.ValueTuple.xml b/app_data/jobs/triggered/utility/System.ValueTuple.xml new file mode 100644 index 000000000..1151832fc --- /dev/null +++ b/app_data/jobs/triggered/utility/System.ValueTuple.xml @@ -0,0 +1,8 @@ + + + + System.ValueTuple + + + + diff --git a/app_data/jobs/triggered/utility/log4net.dll b/app_data/jobs/triggered/utility/log4net.dll new file mode 100644 index 000000000..e74861d24 Binary files /dev/null and b/app_data/jobs/triggered/utility/log4net.dll differ diff --git a/app_data/jobs/triggered/utility/log4net.xml b/app_data/jobs/triggered/utility/log4net.xml new file mode 100644 index 000000000..ac8ed2c68 --- /dev/null +++ b/app_data/jobs/triggered/utility/log4net.xml @@ -0,0 +1,32444 @@ + + + + log4net + + + + + Appender that logs to a database. + + + + appends logging events to a table within a + database. The appender can be configured to specify the connection + string by setting the property. + The connection type (provider) can be specified by setting the + property. For more information on database connection strings for + your specific database see http://www.connectionstrings.com/. + + + Records are written into the database either using a prepared + statement or a stored procedure. The property + is set to (System.Data.CommandType.Text) to specify a prepared statement + or to (System.Data.CommandType.StoredProcedure) to specify a stored + procedure. + + + The prepared statement text or the name of the stored procedure + must be set in the property. + + + The prepared statement or stored procedure can take a number + of parameters. Parameters are added using the + method. This adds a single to the + ordered list of parameters. The + type may be subclassed if required to provide database specific + functionality. The specifies + the parameter name, database type, size, and how the value should + be generated using a . + + + + An example of a SQL Server table that could be logged to: + + CREATE TABLE [dbo].[Log] ( + [ID] [int] IDENTITY (1, 1) NOT NULL , + [Date] [datetime] NOT NULL , + [Thread] [varchar] (255) NOT NULL , + [Level] [varchar] (20) NOT NULL , + [Logger] [varchar] (255) NOT NULL , + [Message] [varchar] (4000) NOT NULL + ) ON [PRIMARY] + + + + An example configuration to log to the above table: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Julian Biddle + Nicko Cadell + Gert Driesen + Lance Nehring + + + + Initializes a new instance of the class. + + + Public default constructor to initialize a new instance of this class. + + + + + Gets or sets the database connection string that is used to connect to + the database. + + + The database connection string used to connect to the database. + + + + The connections string is specific to the connection type. + See for more information. + + + Connection string for MS Access via ODBC: + "DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb" + + Another connection string for MS Access via ODBC: + "Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;" + + Connection string for MS Access via OLE DB: + "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;" + + + + + The appSettings key from App.Config that contains the connection string. + + + + + The connectionStrings key from App.Config that contains the connection string. + + + This property requires at least .NET 2.0. + + + + + Gets or sets the type name of the connection + that should be created. + + + The type name of the connection. + + + + The type name of the ADO.NET provider to use. + + + The default is to use the OLE DB provider. + + + Use the OLE DB Provider. This is the default value. + System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + Use the MS SQL Server Provider. + System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + Use the ODBC Provider. + Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral + This is an optional package that you can download from + http://msdn.microsoft.com/downloads + search for ODBC .NET Data Provider. + + Use the Oracle Provider. + System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + This is an optional package that you can download from + http://msdn.microsoft.com/downloads + search for .NET Managed Provider for Oracle. + + + + + Gets or sets the command text that is used to insert logging events + into the database. + + + The command text used to insert logging events into the database. + + + + Either the text of the prepared statement or the + name of the stored procedure to execute to write into + the database. + + + The property determines if + this text is a prepared statement or a stored procedure. + + + If this property is not set, the command text is retrieved by invoking + . + + + + + + Gets or sets the command type to execute. + + + The command type to execute. + + + + This value may be either (System.Data.CommandType.Text) to specify + that the is a prepared statement to execute, + or (System.Data.CommandType.StoredProcedure) to specify that the + property is the name of a stored procedure + to execute. + + + The default value is (System.Data.CommandType.Text). + + + + + + Should transactions be used to insert logging events in the database. + + + true if transactions should be used to insert logging events in + the database, otherwise false. The default value is true. + + + + Gets or sets a value that indicates whether transactions should be used + to insert logging events in the database. + + + When set a single transaction will be used to insert the buffered events + into the database. Otherwise each event will be inserted without using + an explicit transaction. + + + + + + Gets or sets the used to call the NetSend method. + + + The used to call the NetSend method. + + + + Unless a specified here for this appender + the is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + + + + + + Should this appender try to reconnect to the database on error. + + + true if the appender should try to reconnect to the database after an + error has occurred, otherwise false. The default value is false, + i.e. not to try to reconnect. + + + + The default behaviour is for the appender not to try to reconnect to the + database if an error occurs. Subsequent logging events are discarded. + + + To force the appender to attempt to reconnect to the database set this + property to true. + + + When the appender attempts to connect to the database there may be a + delay of up to the connection timeout specified in the connection string. + This delay will block the calling application's thread. + Until the connection can be reestablished this potential delay may occur multiple times. + + + + + + Gets or sets the underlying . + + + The underlying . + + + creates a to insert + logging events into a database. Classes deriving from + can use this property to get or set this . Use the + underlying returned from if + you require access beyond that which provides. + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Override the parent method to close the database + + + + Closes the database command and database connection. + + + + + + Inserts the events into the database. + + The events to insert into the database. + + + Insert all the events specified in the + array into the database. + + + + + + Adds a parameter to the command. + + The parameter to add to the command. + + + Adds a parameter to the ordered list of command parameters. + + + + + + Writes the events to the database using the transaction specified. + + The transaction that the events will be executed under. + The array of events to insert into the database. + + + The transaction argument can be null if the appender has been + configured not to use transactions. See + property for more information. + + + + + + Formats the log message into database statement text. + + The event being logged. + + This method can be overridden by subclasses to provide + more control over the format of the database statement. + + + Text that can be passed to a . + + + + + Creates an instance used to connect to the database. + + + This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary). + + The of the object. + The connectionString output from the ResolveConnectionString method. + An instance with a valid connection string. + + + + Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey + property. + + + ConnectiongStringName is only supported on .NET 2.0 and higher. + + Additional information describing the connection string. + A connection string used to connect to the database. + + + + Retrieves the class type of the ADO.NET provider. + + + + Gets the Type of the ADO.NET provider to use to connect to the + database. This method resolves the type specified in the + property. + + + Subclasses can override this method to return a different type + if necessary. + + + The of the ADO.NET provider + + + + Connects to the database. + + + + + Cleanup the existing connection. + + + Calls the IDbConnection's method. + + + + + The list of objects. + + + + The list of objects. + + + + + + The security context to use for privileged calls + + + + + The that will be used + to insert logging events into a database. + + + + + Database connection string. + + + + + The appSettings key from App.Config that contains the connection string. + + + + + The connectionStrings key from App.Config that contains the connection string. + + + + + String type name of the type name. + + + + + The text of the command. + + + + + The command type. + + + + + Indicates whether to use transactions when writing to the database. + + + + + Indicates whether to reconnect when a connection is lost. + + + + + The fully qualified type of the AdoNetAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Parameter type used by the . + + + + This class provides the basic database parameter properties + as defined by the interface. + + This type can be subclassed to provide database specific + functionality. The two methods that are called externally are + and . + + + + + + Initializes a new instance of the class. + + + Default constructor for the AdoNetAppenderParameter class. + + + + + Gets or sets the name of this parameter. + + + The name of this parameter. + + + + The name of this parameter. The parameter name + must match up to a named parameter to the SQL stored procedure + or prepared statement. + + + + + + Gets or sets the database type for this parameter. + + + The database type for this parameter. + + + + The database type for this parameter. This property should + be set to the database type from the + enumeration. See . + + + This property is optional. If not specified the ADO.NET provider + will attempt to infer the type from the value. + + + + + + + Gets or sets the precision for this parameter. + + + The precision for this parameter. + + + + The maximum number of digits used to represent the Value. + + + This property is optional. If not specified the ADO.NET provider + will attempt to infer the precision from the value. + + + + + + + Gets or sets the scale for this parameter. + + + The scale for this parameter. + + + + The number of decimal places to which Value is resolved. + + + This property is optional. If not specified the ADO.NET provider + will attempt to infer the scale from the value. + + + + + + + Gets or sets the size for this parameter. + + + The size for this parameter. + + + + The maximum size, in bytes, of the data within the column. + + + This property is optional. If not specified the ADO.NET provider + will attempt to infer the size from the value. + + + For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case. + + + + + + + Gets or sets the to use to + render the logging event into an object for this + parameter. + + + The used to render the + logging event into an object for this parameter. + + + + The that renders the value for this + parameter. + + + The can be used to adapt + any into a + for use in the property. + + + + + + Prepare the specified database command object. + + The command to prepare. + + + Prepares the database command object by adding + this parameter to its collection of parameters. + + + + + + Renders the logging event and set the parameter value in the command. + + The command containing the parameter. + The event to be rendered. + + + Renders the logging event using this parameters layout + object. Sets the value of the parameter on the command object. + + + + + + The name of this parameter. + + + + + The database type for this parameter. + + + + + Flag to infer type rather than use the DbType + + + + + The precision for this parameter. + + + + + The scale for this parameter. + + + + + The size for this parameter. + + + + + The to use to render the + logging event into an object for this parameter. + + + + + Appends logging events to the terminal using ANSI color escape sequences. + + + + AnsiColorTerminalAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. It also allows the color of a specific level of message to be set. + + + This appender expects the terminal to understand the VT100 control set + in order to interpret the color codes. If the terminal or console does not + understand the control codes the behavior is not defined. + + + By default, all output is written to the console's standard output stream. + The property can be set to direct the output to the + error stream. + + + NOTE: This appender writes each message to the System.Console.Out or + System.Console.Error that is set at the time the event is appended. + Therefore it is possible to programmatically redirect the output of this appender + (for example NUnit does this to capture program output). While this is the desired + behavior of this appender it may have security implications in your application. + + + When configuring the ANSI colored terminal appender, a mapping should be + specified to map a logging level to a color. For example: + + + + + + + + + + + + + + + The Level is the standard log4net logging level and ForeColor and BackColor can be any + of the following values: + + Blue + Green + Red + White + Yellow + Purple + Cyan + + These color values cannot be combined together to make new colors. + + + The attributes can be any combination of the following: + + Brightforeground is brighter + Dimforeground is dimmer + Underscoremessage is underlined + Blinkforeground is blinking (does not work on all terminals) + Reverseforeground and background are reversed + Hiddenoutput is hidden + Strikethroughmessage has a line through it + + While any of these attributes may be combined together not all combinations + work well together, for example setting both Bright and Dim attributes makes + no sense. + + + Patrick Wagstrom + Nicko Cadell + + + + The enum of possible display attributes + + + + The following flags can be combined together to + form the ANSI color attributes. + + + + + + + text is bright + + + + + text is dim + + + + + text is underlined + + + + + text is blinking + + + Not all terminals support this attribute + + + + + text and background colors are reversed + + + + + text is hidden + + + + + text is displayed with a strikethrough + + + + + text color is light + + + + + The enum of possible foreground or background color values for + use with the color mapping method + + + + The output can be in one for the following ANSI colors. + + + + + + + color is black + + + + + color is red + + + + + color is green + + + + + color is yellow + + + + + color is blue + + + + + color is magenta + + + + + color is cyan + + + + + color is white + + + + + Initializes a new instance of the class. + + + The instance of the class is set up to write + to the standard output stream. + + + + + Target is the value of the console output stream. + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + + + Add a mapping of level to color + + The mapping to add + + + Add a mapping to this appender. + Each mapping defines the foreground and background colours + for a level. + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Initialize the options for this appender + + + + Initialize the level to color mappings set on this appender. + + + + + + The to use when writing to the Console + standard output stream. + + + + The to use when writing to the Console + standard output stream. + + + + + + The to use when writing to the Console + standard error output stream. + + + + The to use when writing to the Console + standard error output stream. + + + + + + Flag to write output to the error stream rather than the standard output stream + + + + + Mapping from level object to color value + + + + + Ansi code to reset terminal + + + + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and the color it should be displayed in. + + + + + + The mapped foreground color for the specified level + + + + Required property. + The mapped foreground color for the specified level + + + + + + The mapped background color for the specified level + + + + Required property. + The mapped background color for the specified level + + + + + + The color attributes for the specified level + + + + Required property. + The color attributes for the specified level + + + + + + Initialize the options for the object + + + + Combine the and together + and append the attributes. + + + + + + The combined , and + suitable for setting the ansi terminal color. + + + + + A strongly-typed collection of objects. + + Nicko Cadell + + + + Supports type-safe iteration over a . + + + + + + Gets the current element in the collection. + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + Creates a read-only wrapper for a AppenderCollection instance. + + list to create a readonly wrapper arround + + An AppenderCollection wrapper that is read-only. + + + + + An empty readonly static AppenderCollection + + + + + Initializes a new instance of the AppenderCollection class + that is empty and has the default initial capacity. + + + + + Initializes a new instance of the AppenderCollection class + that has the specified initial capacity. + + + The number of elements that the new AppenderCollection is initially capable of storing. + + + + + Initializes a new instance of the AppenderCollection class + that contains elements copied from the specified AppenderCollection. + + The AppenderCollection whose elements are copied to the new collection. + + + + Initializes a new instance of the AppenderCollection class + that contains elements copied from the specified array. + + The array whose elements are copied to the new list. + + + + Initializes a new instance of the AppenderCollection class + that contains elements copied from the specified collection. + + The collection whose elements are copied to the new list. + + + + Type visible only to our subclasses + Used to access protected constructor + + + + + + A value + + + + + Allow subclasses to avoid our default constructors + + + + + + + Gets the number of elements actually contained in the AppenderCollection. + + + + + Copies the entire AppenderCollection to a one-dimensional + array. + + The one-dimensional array to copy to. + + + + Copies the entire AppenderCollection to a one-dimensional + array, starting at the specified index of the target array. + + The one-dimensional array to copy to. + The zero-based index in at which copying begins. + + + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + false, because the backing type is an array, which is never thread-safe. + + + + Gets an object that can be used to synchronize access to the collection. + + + + + Gets or sets the at the specified index. + + The zero-based index of the element to get or set. + + is less than zero + -or- + is equal to or greater than . + + + + + Adds a to the end of the AppenderCollection. + + The to be added to the end of the AppenderCollection. + The index at which the value has been added. + + + + Removes all elements from the AppenderCollection. + + + + + Creates a shallow copy of the . + + A new with a shallow copy of the collection data. + + + + Determines whether a given is in the AppenderCollection. + + The to check for. + true if is found in the AppenderCollection; otherwise, false. + + + + Returns the zero-based index of the first occurrence of a + in the AppenderCollection. + + The to locate in the AppenderCollection. + + The zero-based index of the first occurrence of + in the entire AppenderCollection, if found; otherwise, -1. + + + + + Inserts an element into the AppenderCollection at the specified index. + + The zero-based index at which should be inserted. + The to insert. + + is less than zero + -or- + is equal to or greater than . + + + + + Removes the first occurrence of a specific from the AppenderCollection. + + The to remove from the AppenderCollection. + + The specified was not found in the AppenderCollection. + + + + + Removes the element at the specified index of the AppenderCollection. + + The zero-based index of the element to remove. + + is less than zero + -or- + is equal to or greater than . + + + + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false + + + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false + + + + Returns an enumerator that can iterate through the AppenderCollection. + + An for the entire AppenderCollection. + + + + Gets or sets the number of elements the AppenderCollection can contain. + + + + + Adds the elements of another AppenderCollection to the current AppenderCollection. + + The AppenderCollection whose elements should be added to the end of the current AppenderCollection. + The new of the AppenderCollection. + + + + Adds the elements of a array to the current AppenderCollection. + + The array whose elements should be added to the end of the AppenderCollection. + The new of the AppenderCollection. + + + + Adds the elements of a collection to the current AppenderCollection. + + The collection whose elements should be added to the end of the AppenderCollection. + The new of the AppenderCollection. + + + + Sets the capacity to the actual number of elements. + + + + + Return the collection elements as an array + + the array + + + + is less than zero + -or- + is equal to or greater than . + + + + + is less than zero + -or- + is equal to or greater than . + + + + + Supports simple iteration over a . + + + + + + Initializes a new instance of the Enumerator class. + + + + + + Gets the current element in the collection. + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + + + + Abstract base class implementation of . + + + + This class provides the code for common functionality, such + as support for threshold filtering and support for general filters. + + + Appenders can also implement the interface. Therefore + they would require that the method + be called after the appenders properties have been configured. + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + Empty default constructor + + + + + Finalizes this appender by calling the implementation's + method. + + + + If this appender has not been closed then the Finalize method + will call . + + + + + + Gets or sets the threshold of this appender. + + + The threshold of the appender. + + + + All log events with lower level than the threshold level are ignored + by the appender. + + + In configuration files this option is specified by setting the + value of the option to a level + string, such as "DEBUG", "INFO" and so on. + + + + + + Gets or sets the for this appender. + + The of the appender + + + The provides a default + implementation for the property. + + + + + + The filter chain. + + The head of the filter chain filter chain. + + + Returns the head Filter. The Filters are organized in a linked list + and so all Filters on this Appender are available through the result. + + + + + + Gets or sets the for this appender. + + The layout of the appender. + + + See for more information. + + + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Gets or sets the name of this appender. + + The name of the appender. + + + The name uniquely identifies the appender. + + + + + + Closes the appender and release resources. + + + + Release any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + + This method cannot be overridden by subclasses. This method + delegates the closing of the appender to the + method which must be overridden in the subclass. + + + + + + Performs threshold checks and invokes filters before + delegating actual logging to the subclasses specific + method. + + The event to log. + + + This method cannot be overridden by derived classes. A + derived class should override the method + which is called by this method. + + + The implementation of this method is as follows: + + + + + + Checks that the severity of the + is greater than or equal to the of this + appender. + + + + Checks that the chain accepts the + . + + + + + Calls and checks that + it returns true. + + + + + If all of the above steps succeed then the + will be passed to the abstract method. + + + + + + Performs threshold checks and invokes filters before + delegating actual logging to the subclasses specific + method. + + The array of events to log. + + + This method cannot be overridden by derived classes. A + derived class should override the method + which is called by this method. + + + The implementation of this method is as follows: + + + + + + Checks that the severity of the + is greater than or equal to the of this + appender. + + + + Checks that the chain accepts the + . + + + + + Calls and checks that + it returns true. + + + + + If all of the above steps succeed then the + will be passed to the method. + + + + + + Test if the logging event should we output by this appender + + the event to test + true if the event should be output, false if the event should be ignored + + + This method checks the logging event against the threshold level set + on this appender and also against the filters specified on this + appender. + + + The implementation of this method is as follows: + + + + + + Checks that the severity of the + is greater than or equal to the of this + appender. + + + + Checks that the chain accepts the + . + + + + + + + + + Adds a filter to the end of the filter chain. + + the filter to add to this appender + + + The Filters are organized in a linked list. + + + Setting this property causes the new filter to be pushed onto the + back of the filter chain. + + + + + + Clears the filter list for this appender. + + + + Clears the filter list for this appender. + + + + + + Checks if the message level is below this appender's threshold. + + to test against. + + + If there is no threshold set, then the return value is always true. + + + + true if the meets the + requirements of this appender. + + + + + Is called when the appender is closed. Derived classes should override + this method if resources need to be released. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + + + + + Subclasses of should implement this method + to perform actual logging. + + The event to append. + + + A subclass must implement this method to perform + logging of the . + + This method will be called by + if all the conditions listed for that method are met. + + + To restrict the logging of events in the appender + override the method. + + + + + + Append a bulk array of logging events. + + the array of logging events + + + This base class implementation calls the + method for each element in the bulk array. + + + A sub class that can better process a bulk array of events should + override this method in addition to . + + + + + + Called before as a precondition. + + + + This method is called by + before the call to the abstract method. + + + This method can be overridden in a subclass to extend the checks + made before the event is passed to the method. + + + A subclass should ensure that they delegate this call to + this base class if it is overridden. + + + true if the call to should proceed. + + + + Renders the to a string. + + The event to render. + The event rendered as a string. + + + Helper method to render a to + a string. This appender must have a + set to render the to + a string. + + If there is exception data in the logging event and + the layout does not process the exception, this method + will append the exception text to the rendered string. + + + Where possible use the alternative version of this method + . + That method streams the rendering onto an existing Writer + which can give better performance if the caller already has + a open and ready for writing. + + + + + + Renders the to a string. + + The event to render. + The TextWriter to write the formatted event to + + + Helper method to render a to + a string. This appender must have a + set to render the to + a string. + + If there is exception data in the logging event and + the layout does not process the exception, this method + will append the exception text to the rendered string. + + + Use this method in preference to + where possible. If, however, the caller needs to render the event + to a string then does + provide an efficient mechanism for doing so. + + + + + + Tests if this appender requires a to be set. + + + + In the rather exceptional case, where the appender + implementation admits a layout but can also work without it, + then the appender should return true. + + + This default implementation always returns false. + + + + true if the appender requires a layout object, otherwise false. + + + + + Flushes any buffered log data. + + + This implementation doesn't flush anything and always returns true + + True if all logging events were flushed successfully, else false. + + + + The layout of this appender. + + + See for more information. + + + + + The name of this appender. + + + See for more information. + + + + + The level threshold of this appender. + + + + There is no level threshold filtering by default. + + + See for more information. + + + + + + It is assumed and enforced that errorHandler is never null. + + + + It is assumed and enforced that errorHandler is never null. + + + See for more information. + + + + + + The first filter in the filter chain. + + + + Set to null initially. + + + See for more information. + + + + + + The last filter in the filter chain. + + + See for more information. + + + + + Flag indicating if this appender is closed. + + + See for more information. + + + + + The guard prevents an appender from repeatedly calling its own DoAppend method + + + + + StringWriter used to render events + + + + + Initial buffer size + + + + + Maximum buffer size before it is recycled + + + + + The fully qualified type of the AppenderSkeleton class. + + + Used by the internal logger to record the Type of the + log message. + + + + + + Appends log events to the ASP.NET system. + + + + + Diagnostic information and tracing messages that you specify are appended to the output + of the page that is sent to the requesting browser. Optionally, you can view this information + from a separate trace viewer (Trace.axd) that displays trace information for every page in a + given application. + + + Trace statements are processed and displayed only when tracing is enabled. You can control + whether tracing is displayed to a page, to the trace viewer, or both. + + + The logging event is passed to the or + method depending on the level of the logging event. + The event's logger name is the default value for the category parameter of the Write/Warn method. + + + Nicko Cadell + Gert Driesen + Ron Grabowski + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Write the logging event to the ASP.NET trace + + the event to log + + + Write the logging event to the ASP.NET trace + HttpContext.Current.Trace + (). + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + The category parameter sent to the Trace method. + + + + Defaults to %logger which will use the logger name of the current + as the category parameter. + + + + + + + + Defaults to %logger + + + + + Abstract base class implementation of that + buffers events in a fixed size buffer. + + + + This base class should be used by appenders that need to buffer a + number of events before logging them. + For example the + buffers events and then submits the entire contents of the buffer to + the underlying database in one go. + + + Subclasses should override the + method to deliver the buffered events. + + The BufferingAppenderSkeleton maintains a fixed size cyclic + buffer of events. The size of the buffer is set using + the property. + + A is used to inspect + each event as it arrives in the appender. If the + triggers, then the current buffer is sent immediately + (see ). Otherwise the event + is stored in the buffer. For example, an evaluator can be used to + deliver the events immediately when an ERROR event arrives. + + + The buffering appender can be configured in a mode. + By default the appender is NOT lossy. When the buffer is full all + the buffered events are sent with . + If the property is set to true then the + buffer will not be sent when it is full, and new events arriving + in the appender will overwrite the oldest event in the buffer. + In lossy mode the buffer will only be sent when the + triggers. This can be useful behavior when you need to know about + ERROR events but not about events with a lower level, configure an + evaluator that will trigger when an ERROR event arrives, the whole + buffer will be sent which gives a history of events leading up to + the ERROR event. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Protected default constructor to allow subclassing. + + + + + + Initializes a new instance of the class. + + the events passed through this appender must be + fixed by the time that they arrive in the derived class' SendBuffer method. + + + Protected constructor to allow subclassing. + + + The should be set if the subclass + expects the events delivered to be fixed even if the + is set to zero, i.e. when no buffering occurs. + + + + + + Gets or sets a value that indicates whether the appender is lossy. + + + true if the appender is lossy, otherwise false. The default is false. + + + + This appender uses a buffer to store logging events before + delivering them. A triggering event causes the whole buffer + to be send to the remote sink. If the buffer overruns before + a triggering event then logging events could be lost. Set + to false to prevent logging events + from being lost. + + If is set to true then an + must be specified. + + + + + Gets or sets the size of the cyclic buffer used to hold the + logging events. + + + The size of the cyclic buffer used to hold the logging events. + + + + The option takes a positive integer + representing the maximum number of logging events to collect in + a cyclic buffer. When the is reached, + oldest events are deleted as new events are added to the + buffer. By default the size of the cyclic buffer is 512 events. + + + If the is set to a value less than + or equal to 1 then no buffering will occur. The logging event + will be delivered synchronously (depending on the + and properties). Otherwise the event will + be buffered. + + + + + + Gets or sets the that causes the + buffer to be sent immediately. + + + The that causes the buffer to be + sent immediately. + + + + The evaluator will be called for each event that is appended to this + appender. If the evaluator triggers then the current buffer will + immediately be sent (see ). + + If is set to true then an + must be specified. + + + + + Gets or sets the value of the to use. + + + The value of the to use. + + + + The evaluator will be called for each event that is discarded from this + appender. If the evaluator triggers then the current buffer will immediately + be sent (see ). + + + + + + Gets or sets a value indicating if only part of the logging event data + should be fixed. + + + true if the appender should only fix part of the logging event + data, otherwise false. The default is false. + + + + Setting this property to true will cause only part of the + event data to be fixed and serialized. This will improve performance. + + + See for more information. + + + + + + Gets or sets a the fields that will be fixed in the event + + + The event fields that will be fixed before the event is buffered + + + + The logging event needs to have certain thread specific values + captured before it can be buffered. See + for details. + + + + + + + Flushes any buffered log data. + + The maximum time to wait for logging events to be flushed. + True if all logging events were flushed successfully, else false. + + + + Flush the currently buffered events + + + + Flushes any events that have been buffered. + + + If the appender is buffering in mode then the contents + of the buffer will NOT be flushed to the appender. + + + + + + Flush the currently buffered events + + set to true to flush the buffer of lossy events + + + Flushes events that have been buffered. If is + false then events will only be flushed if this buffer is non-lossy mode. + + + If the appender is buffering in mode then the contents + of the buffer will only be flushed if is true. + In this case the contents of the buffer will be tested against the + and if triggering will be output. All other buffered + events will be discarded. + + + If is true then the buffer will always + be emptied by calling this method. + + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Close this appender instance. + + + + Close this appender instance. If this appender is marked + as not then the remaining events in + the buffer must be sent when the appender is closed. + + + + + + This method is called by the method. + + the event to log + + + Stores the in the cyclic buffer. + + + The buffer will be sent (i.e. passed to the + method) if one of the following conditions is met: + + + + The cyclic buffer is full and this appender is + marked as not lossy (see ) + + + An is set and + it is triggered for the + specified. + + + + Before the event is stored in the buffer it is fixed + (see ) to ensure that + any data referenced by the event will be valid when the buffer + is processed. + + + + + + Sends the contents of the buffer. + + The first logging event. + The buffer containing the events that need to be send. + + + The subclass must override . + + + + + + Sends the events. + + The events that need to be send. + + + The subclass must override this method to process the buffered events. + + + + + + The default buffer size. + + + The default size of the cyclic buffer used to store events. + This is set to 512 by default. + + + + + The size of the cyclic buffer used to hold the logging events. + + + Set to by default. + + + + + The cyclic buffer used to store the logging events. + + + + + The triggering event evaluator that causes the buffer to be sent immediately. + + + The object that is used to determine if an event causes the entire + buffer to be sent immediately. This field can be null, which + indicates that event triggering is not to be done. The evaluator + can be set using the property. If this appender + has the ( property) set to + true then an must be set. + + + + + Indicates if the appender should overwrite events in the cyclic buffer + when it becomes full, or if the buffer should be flushed when the + buffer is full. + + + If this field is set to true then an must + be set. + + + + + The triggering event evaluator filters discarded events. + + + The object that is used to determine if an event that is discarded should + really be discarded or if it should be sent to the appenders. + This field can be null, which indicates that all discarded events will + be discarded. + + + + + Value indicating which fields in the event should be fixed + + + By default all fields are fixed + + + + + The events delivered to the subclass must be fixed. + + + + + Buffers events and then forwards them to attached appenders. + + + + The events are buffered in this appender until conditions are + met to allow the appender to deliver the events to the attached + appenders. See for the + conditions that cause the buffer to be sent. + + The forwarding appender can be used to specify different + thresholds and filters for the same appender at different locations + within the hierarchy. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + + + + + Send the events. + + The events that need to be send. + + + Forwards the events to the attached appenders. + + + + + + Adds an to the list of appenders of this + instance. + + The to add to this appender. + + + If the specified is already in the list of + appenders, then it won't be added again. + + + + + + Gets the appenders contained in this appender as an + . + + + If no appenders can be found, then an + is returned. + + + A collection of the appenders in this appender. + + + + + Looks for the appender with the specified name. + + The name of the appender to lookup. + + The appender with the specified name, or null. + + + + Get the named appender attached to this buffering appender. + + + + + + Removes all previously added appenders from this appender. + + + + This is useful when re-reading configuration information. + + + + + + Removes the specified appender from the list of appenders. + + The appender to remove. + The appender removed from the list + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + Removes the appender with the specified name from the list of appenders. + + The name of the appender to remove. + The appender removed from the list + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + Implementation of the interface + + + + + Appends logging events to the console. + + + + ColoredConsoleAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. It also allows the color of a specific type of message to be set. + + + By default, all output is written to the console's standard output stream. + The property can be set to direct the output to the + error stream. + + + NOTE: This appender writes directly to the application's attached console + not to the System.Console.Out or System.Console.Error TextWriter. + The System.Console.Out and System.Console.Error streams can be + programmatically redirected (for example NUnit does this to capture program output). + This appender will ignore these redirections because it needs to use Win32 + API calls to colorize the output. To respect these redirections the + must be used. + + + When configuring the colored console appender, mapping should be + specified to map a logging level to a color. For example: + + + + + + + + + + + + + + The Level is the standard log4net logging level and ForeColor and BackColor can be any + combination of the following values: + + Blue + Green + Red + White + Yellow + Purple + Cyan + HighIntensity + + + + Rick Hobbs + Nicko Cadell + + + + The enum of possible color values for use with the color mapping method + + + + The following flags can be combined together to + form the colors. + + + + + + + color is blue + + + + + color is green + + + + + color is red + + + + + color is white + + + + + color is yellow + + + + + color is purple + + + + + color is cyan + + + + + color is intensified + + + + + Initializes a new instance of the class. + + + The instance of the class is set up to write + to the standard output stream. + + + + + Initializes a new instance of the class + with the specified layout. + + the layout to use for this appender + + The instance of the class is set up to write + to the standard output stream. + + + + + Initializes a new instance of the class + with the specified layout. + + the layout to use for this appender + flag set to true to write to the console error stream + + When is set to true, output is written to + the standard error output stream. Otherwise, output is written to the standard + output stream. + + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + + + Add a mapping of level to color - done by the config file + + The mapping to add + + + Add a mapping to this appender. + Each mapping defines the foreground and background colors + for a level. + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Initialize the options for this appender + + + + Initialize the level to color mappings set on this appender. + + + + + + The to use when writing to the Console + standard output stream. + + + + The to use when writing to the Console + standard output stream. + + + + + + The to use when writing to the Console + standard error output stream. + + + + The to use when writing to the Console + standard error output stream. + + + + + + Flag to write output to the error stream rather than the standard output stream + + + + + Mapping from level object to color value + + + + + The console output stream writer to write to + + + + This writer is not thread safe. + + + + + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and the color it should be displayed in. + + + + + + The mapped foreground color for the specified level + + + + Required property. + The mapped foreground color for the specified level. + + + + + + The mapped background color for the specified level + + + + Required property. + The mapped background color for the specified level. + + + + + + Initialize the options for the object + + + + Combine the and together. + + + + + + The combined and suitable for + setting the console color. + + + + + Appends logging events to the console. + + + + ConsoleAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. + + + By default, all output is written to the console's standard output stream. + The property can be set to direct the output to the + error stream. + + + NOTE: This appender writes each message to the System.Console.Out or + System.Console.Error that is set at the time the event is appended. + Therefore it is possible to programmatically redirect the output of this appender + (for example NUnit does this to capture program output). While this is the desired + behavior of this appender it may have security implications in your application. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + The instance of the class is set up to write + to the standard output stream. + + + + + Initializes a new instance of the class + with the specified layout. + + the layout to use for this appender + + The instance of the class is set up to write + to the standard output stream. + + + + + Initializes a new instance of the class + with the specified layout. + + the layout to use for this appender + flag set to true to write to the console error stream + + When is set to true, output is written to + the standard error output stream. Otherwise, output is written to the standard + output stream. + + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + The to use when writing to the Console + standard output stream. + + + + The to use when writing to the Console + standard output stream. + + + + + + The to use when writing to the Console + standard error output stream. + + + + The to use when writing to the Console + standard error output stream. + + + + + + Appends log events to the system. + + + + The application configuration file can be used to control what listeners + are actually used. See the MSDN documentation for the + class for details on configuring the + debug system. + + + Events are written using the + method. The event's logger name is passed as the value for the category name to the Write method. + + + Nicko Cadell + + + + Initializes a new instance of the . + + + + Default constructor. + + + + + + Initializes a new instance of the + with a specified layout. + + The layout to use with this appender. + + + Obsolete constructor. + + + + + + Gets or sets a value that indicates whether the appender will + flush at the end of each write. + + + The default behavior is to flush at the end of each + write. If the option is set tofalse, then the underlying + stream can defer writing to physical medium to a later time. + + + Avoiding the flush operation at the end of each append results + in a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + + + + + + Formats the category parameter sent to the Debug method. + + + + Defaults to a with %logger as the pattern which will use the logger name of the current + as the category parameter. + + + + + + + + Flushes any buffered log data. + + The maximum time to wait for logging events to be flushed. + True if all logging events were flushed successfully, else false. + + + + Writes the logging event to the system. + + The event to log. + + + Writes the logging event to the system. + If is true then the + is called. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Immediate flush means that the underlying writer or output stream + will be flushed at the end of each append operation. + + + + Immediate flush is slower but ensures that each append request is + actually written. If is set to + false, then there is a good chance that the last few + logs events are not actually written to persistent media if and + when the application crashes. + + + The default value is true. + + + + + Defaults to a with %logger as the pattern. + + + + + Writes events to the system event log. + + + + The appender will fail if you try to write using an event source that doesn't exist unless it is running with local administrator privileges. + See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog + + + The EventID of the event log entry can be + set using the EventID property () + on the . + + + The Category of the event log entry can be + set using the Category property () + on the . + + + There is a limit of 32K characters for an event log message + + + When configuring the EventLogAppender a mapping can be + specified to map a logging level to an event log entry type. For example: + + + <mapping> + <level value="ERROR" /> + <eventLogEntryType value="Error" /> + </mapping> + <mapping> + <level value="DEBUG" /> + <eventLogEntryType value="Information" /> + </mapping> + + + The Level is the standard log4net logging level and eventLogEntryType can be any value + from the enum, i.e.: + + Erroran error event + Warninga warning event + Informationan informational event + + + + Aspi Havewala + Douglas de la Torre + Nicko Cadell + Gert Driesen + Thomas Voss + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Initializes a new instance of the class + with the specified . + + The to use with this appender. + + + Obsolete constructor. + + + + + + The name of the log where messages will be stored. + + + The string name of the log where messages will be stored. + + + This is the name of the log as it appears in the Event Viewer + tree. The default value is to log into the Application + log, this is where most applications write their events. However + if you need a separate log for your application (or applications) + then you should set the appropriately. + This should not be used to distinguish your event log messages + from those of other applications, the + property should be used to distinguish events. This property should be + used to group together events into a single log. + + + + + + Property used to set the Application name. This appears in the + event logs when logging. + + + The string used to distinguish events from different sources. + + + Sets the event log source property. + + + + + This property is used to return the name of the computer to use + when accessing the event logs. Currently, this is the current + computer, denoted by a dot "." + + + The string name of the machine holding the event log that + will be logged into. + + + This property cannot be changed. It is currently set to '.' + i.e. the local machine. This may be changed in future. + + + + + Add a mapping of level to - done by the config file + + The mapping to add + + + Add a mapping to this appender. + Each mapping defines the event log entry type for a level. + + + + + + Gets or sets the used to write to the EventLog. + + + The used to write to the EventLog. + + + + The system security context used to write to the EventLog. + + + Unless a specified here for this appender + the is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + + + + + + Gets or sets the EventId to use unless one is explicitly specified via the LoggingEvent's properties. + + + + The EventID of the event log entry will normally be + set using the EventID property () + on the . + This property provides the fallback value which defaults to 0. + + + + + + Gets or sets the Category to use unless one is explicitly specified via the LoggingEvent's properties. + + + + The Category of the event log entry will normally be + set using the Category property () + on the . + This property provides the fallback value which defaults to 0. + + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Create an event log source + + + Uses different API calls under NET_2_0 + + + + + This method is called by the + method. + + the event to log + + Writes the event to the system event log using the + . + + If the event has an EventID property (see ) + set then this integer will be used as the event log event id. + + + There is a limit of 32K characters for an event log message + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Get the equivalent for a + + the Level to convert to an EventLogEntryType + The equivalent for a + + Because there are fewer applicable + values to use in logging levels than there are in the + this is a one way mapping. There is + a loss of information during the conversion. + + + + + The log name is the section in the event logs where the messages + are stored. + + + + + Name of the application to use when logging. This appears in the + application column of the event log named by . + + + + + The name of the machine which holds the event log. This is + currently only allowed to be '.' i.e. the current machine. + + + + + Mapping from level object to EventLogEntryType + + + + + The security context to use for privileged calls + + + + + The event ID to use unless one is explicitly specified via the LoggingEvent's properties. + + + + + The event category to use unless one is explicitly specified via the LoggingEvent's properties. + + + + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and its event log entry type. + + + + + + The for this entry + + + + Required property. + The for this entry + + + + + + The fully qualified type of the EventLogAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + The maximum size supported by default. + + + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx + The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766 + may leave space for a two byte null terminator of #0#0). The 32766 max + length is what the .NET 4.0 source code checks for, but this is WRONG! + Strings with a length > 31839 on Windows Vista or higher can CORRUPT + the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent() + for the use of the 32766 max size. + + + + + The maximum size supported by a windows operating system that is vista + or newer. + + + See ReportEvent API: + http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx + ReportEvent's lpStrings parameter: + "A pointer to a buffer containing an array of + null-terminated strings that are merged into the message before Event Viewer + displays the string to the user. This parameter must be a valid pointer + (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters." + + Going beyond the size of 31839 will (at some point) corrupt the event log on Windows + Vista or higher! It may succeed for a while...but you will eventually run into the + error: "System.ComponentModel.Win32Exception : A device attached to the system is + not functioning", and the event log will then be corrupt (I was able to corrupt + an event log using a length of 31877 on Windows 7). + + The max size for Windows Vista or higher is documented here: + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx. + Going over this size may succeed a few times but the buffer will overrun and + eventually corrupt the log (based on testing). + + The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API. + The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a + terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the + buffer, given enough time). + + + + + The maximum size that the operating system supports for + a event log message. + + + Used to determine the maximum string length that can be written + to the operating system event log and eventually truncate a string + that exceeds the limits. + + + + + This method determines the maximum event log message size allowed for + the current environment. + + + + + + Appends logging events to a file. + + + + Logging events are sent to the file specified by + the property. + + + The file can be opened in either append or overwrite mode + by specifying the property. + If the file path is relative it is taken as relative from + the application base directory. The file encoding can be + specified by setting the property. + + + The layout's and + values will be written each time the file is opened and closed + respectively. If the property is + then the file may contain multiple copies of the header and footer. + + + This appender will first try to open the file for writing when + is called. This will typically be during configuration. + If the file cannot be opened for writing the appender will attempt + to open the file again each time a message is logged to the appender. + If the file cannot be opened for writing when a message is logged then + the message will be discarded by this appender. + + + The supports pluggable file locking models via + the property. + The default behavior, implemented by + is to obtain an exclusive write lock on the file until this appender is closed. + The alternative models only hold a + write lock while the appender is writing a logging event () + or synchronize by using a named system wide Mutex (). + + + All locking strategies have issues and you should seriously consider using a different strategy that + avoids having multiple processes logging to the same file. + + + Nicko Cadell + Gert Driesen + Rodrigo B. de Oliveira + Douglas de la Torre + Niall Daley + + + + Write only that uses the + to manage access to an underlying resource. + + + + + True asynchronous writes are not supported, the implementation forces a synchronous write. + + + + + Locking model base class + + + + Base class for the locking models available to the derived loggers. + + + + + + Open the output file + + The filename to use + Whether to append to the file, or overwrite + The encoding to use + + + Open the file specified and prepare for logging. + No writes will be made until is called. + Must be called before any calls to , + and . + + + + + + Close the file + + + + Close the file. No further writes will be made. + + + + + + Initializes all resources used by this locking model. + + + + + Disposes all resources that were initialized by this locking model. + + + + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Acquire the lock on the file in preparation for writing to it. + Return a stream pointing to the file. + must be called to release the lock on the output file. + + + + + + Release the lock on the file + + + + Release the lock on the file. No further writes will be made to the + stream until is called again. + + + + + + Gets or sets the for this LockingModel + + + The for this LockingModel + + + + The file appender this locking model is attached to and working on + behalf of. + + + The file appender is used to locate the security context and the error handler to use. + + + The value of this property will be set before is + called. + + + + + + Helper method that creates a FileStream under CurrentAppender's SecurityContext. + + + + Typically called during OpenFile or AcquireLock. + + + If the directory portion of the does not exist, it is created + via Directory.CreateDirecctory. + + + + + + + + + + Helper method to close under CurrentAppender's SecurityContext. + + + Does not set to null. + + + + + + Hold an exclusive lock on the output file + + + + Open the file once for writing and hold it open until is called. + Maintains an exclusive lock on the file during this time. + + + + + + Open the file specified and prepare for logging. + + The filename to use + Whether to append to the file, or overwrite + The encoding to use + + + Open the file specified and prepare for logging. + No writes will be made until is called. + Must be called before any calls to , + and . + + + + + + Close the file + + + + Close the file. No further writes will be made. + + + + + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Does nothing. The lock is already taken + + + + + + Release the lock on the file + + + + Does nothing. The lock will be released when the file is closed. + + + + + + Initializes all resources used by this locking model. + + + + + Disposes all resources that were initialized by this locking model. + + + + + Acquires the file lock for each write + + + + Opens the file once for each / cycle, + thus holding the lock for the minimal amount of time. This method of locking + is considerably slower than but allows + other processes to move/delete the log file whilst logging continues. + + + + + + Prepares to open the file when the first message is logged. + + The filename to use + Whether to append to the file, or overwrite + The encoding to use + + + Open the file specified and prepare for logging. + No writes will be made until is called. + Must be called before any calls to , + and . + + + + + + Close the file + + + + Close the file. No further writes will be made. + + + + + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Acquire the lock on the file in preparation for writing to it. + Return a stream pointing to the file. + must be called to release the lock on the output file. + + + + + + Release the lock on the file + + + + Release the lock on the file. No further writes will be made to the + stream until is called again. + + + + + + Initializes all resources used by this locking model. + + + + + Disposes all resources that were initialized by this locking model. + + + + + Provides cross-process file locking. + + Ron Grabowski + Steve Wranovsky + + + + Open the file specified and prepare for logging. + + The filename to use + Whether to append to the file, or overwrite + The encoding to use + + + Open the file specified and prepare for logging. + No writes will be made until is called. + Must be called before any calls to , + - and . + + + + + + Close the file + + + + Close the file. No further writes will be made. + + + + + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Does nothing. The lock is already taken + + + + + + Releases the lock and allows others to acquire a lock. + + + + + Initializes all resources used by this locking model. + + + + + Disposes all resources that were initialized by this locking model. + + + + + Default constructor + + + + Default constructor + + + + + + Construct a new appender using the layout, file and append mode. + + the layout to use with this appender + the full path to the file to write to + flag to indicate if the file should be appended to + + + Obsolete constructor. + + + + + + Construct a new appender using the layout and file specified. + The file will be appended to. + + the layout to use with this appender + the full path to the file to write to + + + Obsolete constructor. + + + + + + Gets or sets the path to the file that logging will be written to. + + + The path to the file that logging will be written to. + + + + If the path is relative it is taken as relative from + the application base directory. + + + + + + Gets or sets a flag that indicates whether the file should be + appended to or overwritten. + + + Indicates whether the file should be appended to or overwritten. + + + + If the value is set to false then the file will be overwritten, if + it is set to true then the file will be appended to. + + The default value is true. + + + + + Gets or sets used to write to the file. + + + The used to write to the file. + + + + The default encoding set is + which is the encoding for the system's current ANSI code page. + + + + + + Gets or sets the used to write to the file. + + + The used to write to the file. + + + + Unless a specified here for this appender + the is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + + + + + + Gets or sets the used to handle locking of the file. + + + The used to lock the file. + + + + Gets or sets the used to handle locking of the file. + + + There are three built in locking models, , and . + The first locks the file from the start of logging to the end, the + second locks only for the minimal amount of time when logging each message + and the last synchronizes processes using a named system wide Mutex. + + + The default locking model is the . + + + + + + Activate the options on the file appender. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + This will cause the file to be opened. + + + + + + Closes any previously opened file and calls the parent's . + + + + Resets the filename and the file stream. + + + + + + Close this appender instance. The underlying stream or writer is also closed. + + + + + Called to initialize the file writer + + + + Will be called for each logged message until the file is + successfully opened. + + + + + + This method is called by the + method. + + The event to log. + + + Writes a log statement to the output stream if the output stream exists + and is writable. + + + The format of the output will depend on the appender's layout. + + + + + + This method is called by the + method. + + The array of events to log. + + + Acquires the output file locks once before writing all the events to + the stream. + + + + + + Writes a footer as produced by the embedded layout's property. + + + + Writes a footer as produced by the embedded layout's property. + + + + + + Writes a header produced by the embedded layout's property. + + + + Writes a header produced by the embedded layout's property. + + + + + + Closes the underlying . + + + + Closes the underlying . + + + + + + Closes the previously opened file. + + + + Writes the to the file and then + closes the file. + + + + + + Sets and opens the file where the log output will go. The specified file must be writable. + + The path to the log file. Must be a fully qualified path. + If true will append to fileName. Otherwise will truncate fileName + + + Calls but guarantees not to throw an exception. + Errors are passed to the . + + + + + + Sets and opens the file where the log output will go. The specified file must be writable. + + The path to the log file. Must be a fully qualified path. + If true will append to fileName. Otherwise will truncate fileName + + + If there was already an opened file, then the previous file + is closed first. + + + This method will ensure that the directory structure + for the specified exists. + + + + + + Sets the quiet writer used for file output + + the file stream that has been opened for writing + + + This implementation of creates a + over the and passes it to the + method. + + + This method can be overridden by sub classes that want to wrap the + in some way, for example to encrypt the output + data using a System.Security.Cryptography.CryptoStream. + + + + + + Sets the quiet writer being used. + + the writer over the file stream that has been opened for writing + + + This method can be overridden by sub classes that want to + wrap the in some way. + + + + + + Convert a path into a fully qualified path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + + + + + Flag to indicate if we should append to the file + or overwrite the file. The default is to append. + + + + + The name of the log file. + + + + + The encoding to use for the file stream. + + + + + The security context to use for privileged calls + + + + + The stream to log to. Has added locking semantics + + + + + The locking model to use + + + + + The fully qualified type of the FileAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + This appender forwards logging events to attached appenders. + + + + The forwarding appender can be used to specify different thresholds + and filters for the same appender at different locations within the hierarchy. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + + + + + Forward the logging event to the attached appenders + + The event to log. + + + Delivers the logging event to all the attached appenders. + + + + + + Forward the logging events to the attached appenders + + The array of events to log. + + + Delivers the logging events to all the attached appenders. + + + + + + Adds an to the list of appenders of this + instance. + + The to add to this appender. + + + If the specified is already in the list of + appenders, then it won't be added again. + + + + + + Gets the appenders contained in this appender as an + . + + + If no appenders can be found, then an + is returned. + + + A collection of the appenders in this appender. + + + + + Looks for the appender with the specified name. + + The name of the appender to lookup. + + The appender with the specified name, or null. + + + + Get the named appender attached to this appender. + + + + + + Removes all previously added appenders from this appender. + + + + This is useful when re-reading configuration information. + + + + + + Removes the specified appender from the list of appenders. + + The appender to remove. + The appender removed from the list + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + Removes the appender with the specified name from the list of appenders. + + The name of the appender to remove. + The appender removed from the list + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + Implementation of the interface + + + + + Implement this interface for your own strategies for printing log statements. + + + + Implementors should consider extending the + class which provides a default implementation of this interface. + + + Appenders can also implement the interface. Therefore + they would require that the method + be called after the appenders properties have been configured. + + + Nicko Cadell + Gert Driesen + + + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + + + + + Log the logging event in Appender specific way. + + The event to log + + + This method is called to log a message into this appender. + + + + + + Gets or sets the name of this appender. + + The name of the appender. + + The name uniquely identifies the appender. + + + + + Interface for appenders that support bulk logging. + + + + This interface extends the interface to + support bulk logging of objects. Appenders + should only implement this interface if they can bulk log efficiently. + + + Nicko Cadell + + + + Log the array of logging events in Appender specific way. + + The events to log + + + This method is called to log an array of events into this appender. + + + + + + Interface that can be implemented by Appenders that buffer logging data and expose a method. + + + + + Flushes any buffered log data. + + + Appenders that implement the method must do so in a thread-safe manner: it can be called concurrently with + the method. + + Typically this is done by locking on the Appender instance, e.g.: + + + + + + The parameter is only relevant for appenders that process logging events asynchronously, + such as . + + + The maximum time to wait for logging events to be flushed. + True if all logging events were flushed successfully, else false. + + + + Logs events to a local syslog service. + + + + This appender uses the POSIX libc library functions openlog, syslog, and closelog. + If these functions are not available on the local system then this appender will not work! + + + The functions openlog, syslog, and closelog are specified in SUSv2 and + POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service. + + + This appender talks to a local syslog service. If you need to log to a remote syslog + daemon and you cannot configure your local syslog service to do this you may be + able to use the to log via UDP. + + + Syslog messages must have a facility and and a severity. The severity + is derived from the Level of the logging event. + The facility must be chosen from the set of defined syslog + values. The facilities list is predefined + and cannot be extended. + + + An identifier is specified with each log message. This can be specified + by setting the property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from ). + + + Rob Lyon + Nicko Cadell + + + + syslog severities + + + + The log4net Level maps to a syslog severity using the + method and the + class. The severity is set on . + + + + + + system is unusable + + + + + action must be taken immediately + + + + + critical conditions + + + + + error conditions + + + + + warning conditions + + + + + normal but significant condition + + + + + informational + + + + + debug-level messages + + + + + syslog facilities + + + + The syslog facility defines which subsystem the logging comes from. + This is set on the property. + + + + + + kernel messages + + + + + random user-level messages + + + + + mail system + + + + + system daemons + + + + + security/authorization messages + + + + + messages generated internally by syslogd + + + + + line printer subsystem + + + + + network news subsystem + + + + + UUCP subsystem + + + + + clock (cron/at) daemon + + + + + security/authorization messages (private) + + + + + ftp daemon + + + + + NTP subsystem + + + + + log audit + + + + + log alert + + + + + clock daemon + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + Initializes a new instance of the class. + + + This instance of the class is set up to write + to a local syslog service. + + + + + Message identity + + + + An identifier is specified with each log message. This can be specified + by setting the property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from ). + + + + + + Syslog facility + + + Set to one of the values. The list of + facilities is predefined and cannot be extended. The default value + is . + + + + + Add a mapping of level to severity + + The mapping to add + + + Adds a to this appender. + + + + + + Initialize the appender based on the options set. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to a remote syslog daemon. + + + The format of the output will depend on the appender's layout. + + + + + + Close the syslog when the appender is closed + + + + Close the syslog when the appender is closed + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Translates a log4net level to a syslog severity. + + A log4net level. + A syslog severity. + + + Translates a log4net level to a syslog severity. + + + + + + Generate a syslog priority. + + The syslog facility. + The syslog severity. + A syslog priority. + + + + The facility. The default facility is . + + + + + The message identity + + + + + Marshaled handle to the identity string. We have to hold on to the + string as the openlog and syslog APIs just hold the + pointer to the ident and dereference it for each log message. + + + + + Mapping from level object to syslog severity + + + + + Open connection to system logger. + + + + + Generate a log message. + + + + The libc syslog method takes a format string and a variable argument list similar + to the classic printf function. As this type of vararg list is not supported + by C# we need to specify the arguments explicitly. Here we have specified the + format string with a single message argument. The caller must set the format + string to "%s". + + + + + + Close descriptor used to write to system logger. + + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + + + The mapped syslog severity for the specified level + + + + Required property. + The mapped syslog severity for the specified level + + + + + + Appends colorful logging events to the console, using the .NET 2 + built-in capabilities. + + + + ManagedColoredConsoleAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. It also allows the color of a specific type of message to be set. + + + By default, all output is written to the console's standard output stream. + The property can be set to direct the output to the + error stream. + + + When configuring the colored console appender, mappings should be + specified to map logging levels to colors. For example: + + + + + + + + + + + + + + + + + + + + + + The Level is the standard log4net logging level while + ForeColor and BackColor are the values of + enumeration. + + + Based on the ColoredConsoleAppender + + + Rick Hobbs + Nicko Cadell + Pavlos Touboulidis + + + + Initializes a new instance of the class. + + + The instance of the class is set up to write + to the standard output stream. + + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + + + Add a mapping of level to color - done by the config file + + The mapping to add + + + Add a mapping to this appender. + Each mapping defines the foreground and background colors + for a level. + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Initialize the options for this appender + + + + Initialize the level to color mappings set on this appender. + + + + + + The to use when writing to the Console + standard output stream. + + + + The to use when writing to the Console + standard output stream. + + + + + + The to use when writing to the Console + standard error output stream. + + + + The to use when writing to the Console + standard error output stream. + + + + + + Flag to write output to the error stream rather than the standard output stream + + + + + Mapping from level object to color value + + + + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and the color it should be displayed in. + + + + + + The mapped foreground color for the specified level + + + + Required property. + The mapped foreground color for the specified level. + + + + + + The mapped background color for the specified level + + + + Required property. + The mapped background color for the specified level. + + + + + + Stores logging events in an array. + + + + The memory appender stores all the logging events + that are appended in an in-memory array. + + + Use the method to get + and clear the current list of events that have been appended. + + + Use the method to get the current + list of events that have been appended. Note there is a + race-condition when calling and + in pairs, you better use in that case. + + + Use the method to clear the + current list of events. Note there is a + race-condition when calling and + in pairs, you better use in that case. + + + Julian Biddle + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Gets the events that have been logged. + + The events that have been logged + + + Gets the events that have been logged. + + + + + + Gets or sets a value indicating whether only part of the logging event + data should be fixed. + + + true if the appender should only fix part of the logging event + data, otherwise false. The default is false. + + + + Setting this property to true will cause only part of the event + data to be fixed and stored in the appender, hereby improving performance. + + + See for more information. + + + + + + Gets or sets the fields that will be fixed in the event + + + + The logging event needs to have certain thread specific values + captured before it can be buffered. See + for details. + + + + + + This method is called by the method. + + the event to log + + Stores the in the events list. + + + + + Clear the list of events + + + Clear the list of events + + + + + Gets the events that have been logged and clears the list of events. + + The events that have been logged + + + Gets the events that have been logged and clears the list of events. + + + + + + The list of events that have been appended. + + + + + Value indicating which fields in the event should be fixed + + + By default all fields are fixed + + + + + Logs entries by sending network messages using the + native function. + + + + You can send messages only to names that are active + on the network. If you send the message to a user name, + that user must be logged on and running the Messenger + service to receive the message. + + + The receiver will get a top most window displaying the + messages one at a time, therefore this appender should + not be used to deliver a high volume of messages. + + + The following table lists some possible uses for this appender : + + + + + Action + Property Value(s) + + + Send a message to a user account on the local machine + + + = <name of the local machine> + + + = <user name> + + + + + Send a message to a user account on a remote machine + + + = <name of the remote machine> + + + = <user name> + + + + + Send a message to a domain user account + + + = <name of a domain controller | uninitialized> + + + = <user name> + + + + + Send a message to all the names in a workgroup or domain + + + = <workgroup name | domain name>* + + + + + Send a message from the local machine to a remote machine + + + = <name of the local machine | uninitialized> + + + = <name of the remote machine> + + + + + + + Note : security restrictions apply for sending + network messages, see + for more information. + + + + + An example configuration section to log information + using this appender from the local machine, named + LOCAL_PC, to machine OPERATOR_PC : + + + + + + + + + + Nicko Cadell + Gert Driesen + + + + The DNS or NetBIOS name of the server on which the function is to execute. + + + + + The sender of the network message. + + + + + The message alias to which the message should be sent. + + + + + The security context to use for privileged calls + + + + + Initializes the appender. + + + The default constructor initializes all fields to their default values. + + + + + Gets or sets the sender of the message. + + + The sender of the message. + + + If this property is not specified, the message is sent from the local computer. + + + + + Gets or sets the message alias to which the message should be sent. + + + The recipient of the message. + + + This property should always be specified in order to send a message. + + + + + Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute. + + + DNS or NetBIOS name of the remote server on which the function is to execute. + + + + For Windows NT 4.0 and earlier, the string should begin with \\. + + + If this property is not specified, the local computer is used. + + + + + + Gets or sets the used to call the NetSend method. + + + The used to call the NetSend method. + + + + Unless a specified here for this appender + the is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + + + + + + Initialize the appender based on the options set. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + The appender will be ignored if no was specified. + + + The required property was not specified. + + + + This method is called by the method. + + The event to log. + + + Sends the event using a network message. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Sends a buffer of information to a registered message alias. + + The DNS or NetBIOS name of the server on which the function is to execute. + The message alias to which the message buffer should be sent + The originator of the message. + The message text. + The length, in bytes, of the message text. + + + The following restrictions apply for sending network messages: + + + + + Platform + Requirements + + + Windows NT + + + No special group membership is required to send a network message. + + + Admin, Accounts, Print, or Server Operator group membership is required to + successfully send a network message on a remote server. + + + + + Windows 2000 or later + + + If you send a message on a domain controller that is running Active Directory, + access is allowed or denied based on the access control list (ACL) for the securable + object. The default ACL permits only Domain Admins and Account Operators to send a network message. + + + On a member server or workstation, only Administrators and Server Operators can send a network message. + + + + + + + For more information see Security Requirements for the Network Management Functions. + + + + + If the function succeeds, the return value is zero. + + + + + + Appends log events to the OutputDebugString system. + + + + OutputDebugStringAppender appends log events to the + OutputDebugString system. + + + The string is passed to the native OutputDebugString + function. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Write the logging event to the output debug string API + + the event to log + + + Write the logging event to the output debug string API + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Stub for OutputDebugString native method + + the string to output + + + Stub for OutputDebugString native method + + + + + + Logs events to a remote syslog daemon. + + + + The BSD syslog protocol is used to remotely log to + a syslog daemon. The syslogd listens for for messages + on UDP port 514. + + + The syslog UDP protocol is not authenticated. Most syslog daemons + do not accept remote log messages because of the security implications. + You may be able to use the LocalSyslogAppender to talk to a local + syslog service. + + + There is an RFC 3164 that claims to document the BSD Syslog Protocol. + This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html. + This appender generates what the RFC calls an "Original Device Message", + i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation + this format of message will be accepted by all current syslog daemon + implementations. The daemon will attach the current time and the source + hostname or IP address to any messages received. + + + Syslog messages must have a facility and and a severity. The severity + is derived from the Level of the logging event. + The facility must be chosen from the set of defined syslog + values. The facilities list is predefined + and cannot be extended. + + + An identifier is specified with each log message. This can be specified + by setting the property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from ). + + + Rob Lyon + Nicko Cadell + + + + Syslog port 514 + + + + + syslog severities + + + + The syslog severities. + + + + + + system is unusable + + + + + action must be taken immediately + + + + + critical conditions + + + + + error conditions + + + + + warning conditions + + + + + normal but significant condition + + + + + informational + + + + + debug-level messages + + + + + syslog facilities + + + + The syslog facilities + + + + + + kernel messages + + + + + random user-level messages + + + + + mail system + + + + + system daemons + + + + + security/authorization messages + + + + + messages generated internally by syslogd + + + + + line printer subsystem + + + + + network news subsystem + + + + + UUCP subsystem + + + + + clock (cron/at) daemon + + + + + security/authorization messages (private) + + + + + ftp daemon + + + + + NTP subsystem + + + + + log audit + + + + + log alert + + + + + clock daemon + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + Initializes a new instance of the class. + + + This instance of the class is set up to write + to a remote syslog daemon. + + + + + Message identity + + + + An identifier is specified with each log message. This can be specified + by setting the property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from ). + + + + + + Syslog facility + + + Set to one of the values. The list of + facilities is predefined and cannot be extended. The default value + is . + + + + + Add a mapping of level to severity + + The mapping to add + + + Add a mapping to this appender. + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to a remote syslog daemon. + + + The format of the output will depend on the appender's layout. + + + + + + Initialize the options for this appender + + + + Initialize the level to syslog severity mappings set on this appender. + + + + + + Translates a log4net level to a syslog severity. + + A log4net level. + A syslog severity. + + + Translates a log4net level to a syslog severity. + + + + + + Generate a syslog priority. + + The syslog facility. + The syslog severity. + A syslog priority. + + + Generate a syslog priority. + + + + + + The facility. The default facility is . + + + + + The message identity + + + + + Mapping from level object to syslog severity + + + + + Initial buffer size + + + + + Maximum buffer size before it is recycled + + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + + + The mapped syslog severity for the specified level + + + + Required property. + The mapped syslog severity for the specified level + + + + + + Delivers logging events to a remote logging sink. + + + + This Appender is designed to deliver events to a remote sink. + That is any object that implements the + interface. It delivers the events using .NET remoting. The + object to deliver events to is specified by setting the + appenders property. + + The RemotingAppender buffers events before sending them. This allows it to + make more efficient use of the remoting infrastructure. + + Once the buffer is full the events are still not sent immediately. + They are scheduled to be sent using a pool thread. The effect is that + the send occurs asynchronously. This is very important for a + number of non obvious reasons. The remoting infrastructure will + flow thread local variables (stored in the ), + if they are marked as , across the + remoting boundary. If the server is not contactable then + the remoting infrastructure will clear the + objects from the . To prevent a logging failure from + having side effects on the calling application the remoting call must be made + from a separate thread to the one used by the application. A + thread is used for this. If no thread is available then + the events will block in the thread pool manager until a thread is available. + + Because the events are sent asynchronously using pool threads it is possible to close + this appender before all the queued events have been sent. + When closing the appender attempts to wait until all the queued events have been sent, but + this will timeout after 30 seconds regardless. + + If this appender is being closed because the + event has fired it may not be possible to send all the queued events. During process + exit the runtime limits the time that a + event handler is allowed to run for. If the runtime terminates the threads before + the queued events have been sent then they will be lost. To ensure that all events + are sent the appender must be closed before the application exits. See + for details on how to shutdown + log4net programmatically. + + + Nicko Cadell + Gert Driesen + Daniel Cazzulino + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Gets or sets the URL of the well-known object that will accept + the logging events. + + + The well-known URL of the remote sink. + + + + The URL of the remoting sink that will accept logging events. + The sink must implement the + interface. + + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Send the contents of the buffer to the remote sink. + + + The events are not sent immediately. They are scheduled to be sent + using a pool thread. The effect is that the send occurs asynchronously. + This is very important for a number of non obvious reasons. The remoting + infrastructure will flow thread local variables (stored in the ), + if they are marked as , across the + remoting boundary. If the server is not contactable then + the remoting infrastructure will clear the + objects from the . To prevent a logging failure from + having side effects on the calling application the remoting call must be made + from a separate thread to the one used by the application. A + thread is used for this. If no thread is available then + the events will block in the thread pool manager until a thread is available. + + The events to send. + + + + Override base class close. + + + + This method waits while there are queued work items. The events are + sent asynchronously using work items. These items + will be sent once a thread pool thread is available to send them, therefore + it is possible to close the appender before all the queued events have been + sent. + + This method attempts to wait until all the queued events have been sent, but this + method will timeout after 30 seconds regardless. + + If the appender is being closed because the + event has fired it may not be possible to send all the queued events. During process + exit the runtime limits the time that a + event handler is allowed to run for. + + + + + Flushes any buffered log data. + + The maximum time to wait for logging events to be flushed. + True if all logging events were flushed successfully, else false. + + + + A work item is being queued into the thread pool + + + + + A work item from the thread pool has completed + + + + + Send the contents of the buffer to the remote sink. + + + This method is designed to be used with the . + This method expects to be passed an array of + objects in the state param. + + the logging events to send + + + + The URL of the remote sink. + + + + + The local proxy (.NET remoting) for the remote logging sink. + + + + + The number of queued callbacks currently waiting or executing + + + + + Event used to signal when there are no queued work items + + + This event is set when there are no queued work items. In this + state it is safe to close the appender. + + + + + Interface used to deliver objects to a remote sink. + + + This interface must be implemented by a remoting sink + if the is to be used + to deliver logging events to the sink. + + + + + Delivers logging events to the remote sink + + Array of events to log. + + + Delivers logging events to the remote sink + + + + + + Appender that rolls log files based on size or date or both. + + + + RollingFileAppender can roll log files based on size or date or both + depending on the setting of the property. + When set to the log file will be rolled + once its size exceeds the . + When set to the log file will be rolled + once the date boundary specified in the property + is crossed. + When set to the log file will be + rolled once the date boundary specified in the property + is crossed, but within a date boundary the file will also be rolled + once its size exceeds the . + When set to the log file will be rolled when + the appender is configured. This effectively means that the log file can be + rolled once per program execution. + + + A of few additional optional features have been added: + + Attach date pattern for current log file + Backup number increments for newer files + Infinite number of backups by file size + + + + + + For large or infinite numbers of backup files a + greater than zero is highly recommended, otherwise all the backup files need + to be renamed each time a new backup is created. + + + When Date/Time based rolling is used setting + to will reduce the number of file renamings to few or none. + + + + + + Changing or without clearing + the log file directory of backup files will cause unexpected and unwanted side effects. + + + + + If Date/Time based rolling is enabled this appender will attempt to roll existing files + in the directory without a Date/Time tag based on the last write date of the base log file. + The appender only rolls the log file when a message is logged. If Date/Time based rolling + is enabled then the appender will not roll the log file at the Date/Time boundary but + at the point when the next message is logged after the boundary has been crossed. + + + + The extends the and + has the same behavior when opening the log file. + The appender will first try to open the file for writing when + is called. This will typically be during configuration. + If the file cannot be opened for writing the appender will attempt + to open the file again each time a message is logged to the appender. + If the file cannot be opened for writing when a message is logged then + the message will be discarded by this appender. + + + When rolling a backup file necessitates deleting an older backup file the + file to be deleted is moved to a temporary name before being deleted. + + + + + A maximum number of backup files when rolling on date/time boundaries is not supported. + + + + Nicko Cadell + Gert Driesen + Aspi Havewala + Douglas de la Torre + Edward Smit + + + + Style of rolling to use + + + + Style of rolling to use + + + + + + Roll files once per program execution + + + + Roll files once per program execution. + Well really once each time this appender is + configured. + + + Setting this option also sets AppendToFile to + false on the RollingFileAppender, otherwise + this appender would just be a normal file appender. + + + + + + Roll files based only on the size of the file + + + + + Roll files based only on the date + + + + + Roll files based on both the size and date of the file + + + + + The code assumes that the following 'time' constants are in a increasing sequence. + + + + The code assumes that the following 'time' constants are in a increasing sequence. + + + + + + Roll the log not based on the date + + + + + Roll the log for each minute + + + + + Roll the log for each hour + + + + + Roll the log twice a day (midday and midnight) + + + + + Roll the log each day (midnight) + + + + + Roll the log each week + + + + + Roll the log each month + + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Cleans up all resources used by this appender. + + + + + Gets or sets the strategy for determining the current date and time. The default + implementation is to use LocalDateTime which internally calls through to DateTime.Now. + DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying + . + + + An implementation of the interface which returns the current date and time. + + + + Gets or sets the used to return the current date and time. + + + There are two built strategies for determining the current date and time, + + and . + + + The default strategy is . + + + + + + Gets or sets the date pattern to be used for generating file names + when rolling over on date. + + + The date pattern to be used for generating file names when rolling + over on date. + + + + Takes a string in the same format as expected by + . + + + This property determines the rollover schedule when rolling over + on date. + + + + + + Gets or sets the maximum number of backup files that are kept before + the oldest is erased. + + + The maximum number of backup files that are kept before the oldest is + erased. + + + + If set to zero, then there will be no backup files and the log file + will be truncated when it reaches . + + + If a negative number is supplied then no deletions will be made. Note + that this could result in very slow performance as a large number of + files are rolled over unless is used. + + + The maximum applies to each time based group of files and + not the total. + + + + + + Gets or sets the maximum size that the output file is allowed to reach + before being rolled over to backup files. + + + The maximum size in bytes that the output file is allowed to reach before being + rolled over to backup files. + + + + This property is equivalent to except + that it is required for differentiating the setter taking a + argument from the setter taking a + argument. + + + The default maximum file size is 10MB (10*1024*1024). + + + + + + Gets or sets the maximum size that the output file is allowed to reach + before being rolled over to backup files. + + + The maximum size that the output file is allowed to reach before being + rolled over to backup files. + + + + This property allows you to specify the maximum size with the + suffixes "KB", "MB" or "GB" so that the size is interpreted being + expressed respectively in kilobytes, megabytes or gigabytes. + + + For example, the value "10KB" will be interpreted as 10240 bytes. + + + The default maximum file size is 10MB. + + + If you have the option to set the maximum file size programmatically + consider using the property instead as this + allows you to set the size in bytes as a . + + + + + + Gets or sets the rolling file count direction. + + + The rolling file count direction. + + + + Indicates if the current file is the lowest numbered file or the + highest numbered file. + + + By default newer files have lower numbers ( < 0), + i.e. log.1 is most recent, log.5 is the 5th backup, etc... + + + >= 0 does the opposite i.e. + log.1 is the first backup made, log.5 is the 5th backup made, etc. + For infinite backups use >= 0 to reduce + rollover costs. + + The default file count direction is -1. + + + + + Gets or sets the rolling style. + + The rolling style. + + + The default rolling style is . + + + When set to this appender's + property is set to false, otherwise + the appender would append to a single file rather than rolling + the file each time it is opened. + + + + + + Gets or sets a value indicating whether to preserve the file name extension when rolling. + + + true if the file name extension should be preserved. + + + + By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup. + However, under Windows the new file name will loose any program associations as the + extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or + file.curSizeRollBackup.log to maintain any program associations. + + + + + + Gets or sets a value indicating whether to always log to + the same file. + + + true if always should be logged to the same file, otherwise false. + + + + By default file.log is always the current file. Optionally + file.log.yyyy-mm-dd for current formatted datePattern can by the currently + logging file (or file.log.curSizeRollBackup or even + file.log.yyyy-mm-dd.curSizeRollBackup). + + + This will make time based rollovers with a large number of backups + much faster as the appender it won't have to rename all the backups! + + + + + + The fully qualified type of the RollingFileAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Sets the quiet writer being used. + + + This method can be overridden by sub classes. + + the writer to set + + + + Write out a logging event. + + the event to write to file. + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + + + + + Write out an array of logging events. + + the events to write to file. + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + + + + + Performs any required rolling before outputting the next event + + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + + + + + Creates and opens the file for logging. If + is false then the fully qualified name is determined and used. + + the name of the file to open + true to append to existing file + + This method will ensure that the directory structure + for the specified exists. + + + + + Get the current output file name + + the base file name + the output file name + + The output file name is based on the base fileName specified. + If is set then the output + file name is the same as the base file passed in. Otherwise + the output file depends on the date pattern, on the count + direction or both. + + + + + Determines curSizeRollBackups (only within the current roll point) + + + + + Generates a wildcard pattern that can be used to find all files + that are similar to the base file name. + + + + + + + Builds a list of filenames for all files matching the base filename plus a file + pattern. + + + + + + + Initiates a roll over if needed for crossing a date boundary since the last run. + + + + + Initializes based on existing conditions at time of . + + + + Initializes based on existing conditions at time of . + The following is done + + determine curSizeRollBackups (only within the current roll point) + initiates a roll over if needed for crossing a date boundary since the last run. + + + + + + + Does the work of bumping the 'current' file counter higher + to the highest count when an incremental file name is seen. + The highest count is either the first file (when count direction + is greater than 0) or the last file (when count direction less than 0). + In either case, we want to know the highest count that is present. + + + + + + + Attempts to extract a number from the end of the file name that indicates + the number of the times the file has been rolled over. + + + Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes. + + + + + + + Takes a list of files and a base file name, and looks for + 'incremented' versions of the base file. Bumps the max + count up to the highest count seen. + + + + + + + Calculates the RollPoint for the datePattern supplied. + + the date pattern to calculate the check period for + The RollPoint that is most accurate for the date pattern supplied + + Essentially the date pattern is examined to determine what the + most suitable roll point is. The roll point chosen is the roll point + with the smallest period that can be detected using the date pattern + supplied. i.e. if the date pattern only outputs the year, month, day + and hour then the smallest roll point that can be detected would be + and hourly roll point as minutes could not be detected. + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + Sets initial conditions including date/time roll over information, first check, + scheduledFilename, and calls to initialize + the current number of backups. + + + + + + + + + .1, .2, .3, etc. + + + + + Rollover the file(s) to date/time tagged file(s). + + set to true if the file to be rolled is currently open + + + Rollover the file(s) to date/time tagged file(s). + Resets curSizeRollBackups. + If fileIsOpen is set then the new file is opened (through SafeOpenFile). + + + + + + Renames file to file . + + Name of existing file to roll. + New name for file. + + + Renames file to file . It + also checks for existence of target file and deletes if it does. + + + + + + Test if a file exists at a specified path + + the path to the file + true if the file exists + + + Test if a file exists at a specified path + + + + + + Deletes the specified file if it exists. + + The file to delete. + + + Delete a file if is exists. + The file is first moved to a new filename then deleted. + This allows the file to be removed even when it cannot + be deleted, but it still can be moved. + + + + + + Implements file roll base on file size. + + + + If the maximum number of size based backups is reached + (curSizeRollBackups == maxSizeRollBackups) then the oldest + file is deleted -- its index determined by the sign of countDirection. + If countDirection < 0, then files + {File.1, ..., File.curSizeRollBackups -1} + are renamed to {File.2, ..., + File.curSizeRollBackups}. Moreover, File is + renamed File.1 and closed. + + + A new file is created to receive further log output. + + + If maxSizeRollBackups is equal to zero, then the + File is truncated with no backup files created. + + + If maxSizeRollBackups < 0, then File is + renamed if needed and no files are deleted. + + + + + + Implements file roll. + + the base name to rename + + + If the maximum number of size based backups is reached + (curSizeRollBackups == maxSizeRollBackups) then the oldest + file is deleted -- its index determined by the sign of countDirection. + If countDirection < 0, then files + {File.1, ..., File.curSizeRollBackups -1} + are renamed to {File.2, ..., + File.curSizeRollBackups}. + + + If maxSizeRollBackups is equal to zero, then the + File is truncated with no backup files created. + + + If maxSizeRollBackups < 0, then File is + renamed if needed and no files are deleted. + + + This is called by to rename the files. + + + + + + Get the start time of the next window for the current rollpoint + + the current date + the type of roll point we are working with + the start time for the next roll point an interval after the currentDateTime date + + + Returns the date of the next roll point after the currentDateTime date passed to the method. + + + The basic strategy is to subtract the time parts that are less significant + than the rollpoint from the current time. This should roll the time back to + the start of the time window for the current rollpoint. Then we add 1 window + worth of time and get the start time of the next window for the rollpoint. + + + + + + This object supplies the current date/time. Allows test code to plug in + a method to control this class when testing date/time based rolling. The default + implementation uses the underlying value of DateTime.Now. + + + + + The date pattern. By default, the pattern is set to ".yyyy-MM-dd" + meaning daily rollover. + + + + + The actual formatted filename that is currently being written to + or will be the file transferred to on roll over + (based on staticLogFileName). + + + + + The timestamp when we shall next recompute the filename. + + + + + Holds date of last roll over + + + + + The type of rolling done + + + + + The default maximum file size is 10MB + + + + + There is zero backup files by default + + + + + How many sized based backups have been made so far + + + + + The rolling file count direction. + + + + + The rolling mode used in this appender. + + + + + Cache flag set if we are rolling by date. + + + + + Cache flag set if we are rolling by size. + + + + + Value indicating whether to always log to the same file. + + + + + Value indicating whether to preserve the file name extension when rolling. + + + + + FileName provided in configuration. Used for rolling properly + + + + + A mutex that is used to lock rolling of files. + + + + + The 1st of January 1970 in UTC + + + + + This interface is used to supply Date/Time information to the . + + + This interface is used to supply Date/Time information to the . + Used primarily to allow test classes to plug themselves in so they can + supply test date/times. + + + + + Gets the current time. + + The current time. + + + Gets the current time. + + + + + + Default implementation of that returns the current time. + + + + + Gets the current time. + + The current time. + + + Gets the current time. + + + + + + Implementation of that returns the current time as the coordinated universal time (UTC). + + + + + Gets the current time. + + The current time. + + + Gets the current time. + + + + + + Send an e-mail when a specific logging event occurs, typically on errors + or fatal errors. + + + + The number of logging events delivered in this e-mail depend on + the value of option. The + keeps only the last + logging events in its + cyclic buffer. This keeps memory requirements at a reasonable level while + still delivering useful application context. + + + Authentication and setting the server Port are only available on the MS .NET 1.1 runtime. + For these features to be enabled you need to ensure that you are using a version of + the log4net assembly that is built against the MS .NET 1.1 framework and that you are + running the your application on the MS .NET 1.1 runtime. On all other platforms only sending + unauthenticated messages to a server listening on port 25 (the default) is supported. + + + Authentication is supported by setting the property to + either or . + If using authentication then the + and properties must also be set. + + + To set the SMTP server port use the property. The default port is 25. + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Default constructor + + + + + + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions). + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses + that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions). + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + + Gets or sets a semicolon-delimited list of recipient e-mail addresses + that will be blind carbon copied. + + + A semicolon-delimited list of e-mail addresses. + + + + A semicolon-delimited list of recipient e-mail addresses. + + + + + + Gets or sets the e-mail address of the sender. + + + The e-mail address of the sender. + + + + The e-mail address of the sender. + + + + + + Gets or sets the subject line of the e-mail message. + + + The subject line of the e-mail message. + + + + The subject line of the e-mail message. + + + + + + Gets or sets the name of the SMTP relay mail server to use to send + the e-mail messages. + + + The name of the e-mail relay server. If SmtpServer is not set, the + name of the local SMTP server is used. + + + + The name of the e-mail relay server. If SmtpServer is not set, the + name of the local SMTP server is used. + + + + + + Obsolete + + + Use the BufferingAppenderSkeleton Fix methods instead + + + + Obsolete property. + + + + + + The mode to use to authentication with the SMTP server + + + Authentication is only available on the MS .NET 1.1 runtime. + + Valid Authentication mode values are: , + , and . + The default value is . When using + you must specify the + and to use to authenticate. + When using the Windows credentials for the current + thread, if impersonating, or the process will be used to authenticate. + + + + + + The username to use to authenticate with the SMTP server + + + Authentication is only available on the MS .NET 1.1 runtime. + + A and must be specified when + is set to , + otherwise the username will be ignored. + + + + + + The password to use to authenticate with the SMTP server + + + Authentication is only available on the MS .NET 1.1 runtime. + + A and must be specified when + is set to , + otherwise the password will be ignored. + + + + + + The port on which the SMTP server is listening + + + Server Port is only available on the MS .NET 1.1 runtime. + + The port on which the SMTP server is listening. The default + port is 25. The Port can only be changed when running on + the MS .NET 1.1 runtime. + + + + + + Gets or sets the priority of the e-mail message + + + One of the values. + + + + Sets the priority of the e-mails generated by this + appender. The default priority is . + + + If you are using this appender to report errors then + you may want to set the priority to . + + + + + + Enable or disable use of SSL when sending e-mail message + + + This is available on MS .NET 2.0 runtime and higher + + + + + Gets or sets the reply-to e-mail address. + + + This is available on MS .NET 2.0 runtime and higher + + + + + Gets or sets the subject encoding to be used. + + + The default encoding is the operating system's current ANSI codepage. + + + + + Gets or sets the body encoding to be used. + + + The default encoding is the operating system's current ANSI codepage. + + + + + Sends the contents of the cyclic buffer as an e-mail message. + + The logging events to send. + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Send the email message + + the body text to include in the mail + + + + Values for the property. + + + + SMTP authentication modes. + + + + + + No authentication + + + + + Basic authentication. + + + Requires a username and password to be supplied + + + + + Integrated authentication + + + Uses the Windows credentials from the current thread or process to authenticate. + + + + + trims leading and trailing commas or semicolons + + + + + Send an email when a specific logging event occurs, typically on errors + or fatal errors. Rather than sending via smtp it writes a file into the + directory specified by . This allows services such + as the IIS SMTP agent to manage sending the messages. + + + + The configuration for this appender is identical to that of the SMTPAppender, + except that instead of specifying the SMTPAppender.SMTPHost you specify + . + + + The number of logging events delivered in this e-mail depend on + the value of option. The + keeps only the last + logging events in its + cyclic buffer. This keeps memory requirements at a reasonable level while + still delivering useful application context. + + + Niall Daley + Nicko Cadell + + + + Default constructor + + + + Default constructor + + + + + + Gets or sets a semicolon-delimited list of recipient e-mail addresses. + + + A semicolon-delimited list of e-mail addresses. + + + + A semicolon-delimited list of e-mail addresses. + + + + + + Gets or sets the e-mail address of the sender. + + + The e-mail address of the sender. + + + + The e-mail address of the sender. + + + + + + Gets or sets the subject line of the e-mail message. + + + The subject line of the e-mail message. + + + + The subject line of the e-mail message. + + + + + + Gets or sets the path to write the messages to. + + + + Gets or sets the path to write the messages to. This should be the same + as that used by the agent sending the messages. + + + + + + Gets or sets the file extension for the generated files + + + The file extension for the generated files + + + + The file extension for the generated files + + + + + + Gets or sets the used to write to the pickup directory. + + + The used to write to the pickup directory. + + + + Unless a specified here for this appender + the is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + + + + + + Sends the contents of the cyclic buffer as an e-mail message. + + The logging events to send. + + + Sends the contents of the cyclic buffer as an e-mail message. + + + + + + Activate the options on this appender. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Convert a path into a fully qualified path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + + + + + The security context to use for privileged calls + + + + + Appender that allows clients to connect via Telnet to receive log messages + + + + The TelnetAppender accepts socket connections and streams logging messages + back to the client. + The output is provided in a telnet-friendly way so that a log can be monitored + over a TCP/IP socket. + This allows simple remote monitoring of application logging. + + + The default is 23 (the telnet port). + + + Keith Long + Nicko Cadell + + + + Default constructor + + + + Default constructor + + + + + + The fully qualified type of the TelnetAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets or sets the TCP port number on which this will listen for connections. + + + An integer value in the range to + indicating the TCP port number on which this will listen for connections. + + + + The default value is 23 (the telnet port). + + + The value specified is less than + or greater than . + + + + Overrides the parent method to close the socket handler + + + + Closes all the outstanding connections. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Initialize the appender based on the options set. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + Create the socket handler and wait for connections + + + + + + Writes the logging event to each connected client. + + The event to log. + + + Writes the logging event to each connected client. + + + + + + Helper class to manage connected clients + + + + The SocketHandler class is used to accept connections from + clients. It is threaded so that clients can connect/disconnect + asynchronously. + + + + + + Class that represents a client connected to this handler + + + + Class that represents a client connected to this handler + + + + + + Create this for the specified + + the client's socket + + + Opens a stream writer on the socket. + + + + + + Write a string to the client + + string to send + + + Write a string to the client + + + + + + Cleanup the clients connection + + + + Close the socket connection. + + + + + + Opens a new server port on + + the local port to listen on for connections + + + Creates a socket handler on the specified local server port. + + + + + + Sends a string message to each of the connected clients + + the text to send + + + Sends a string message to each of the connected clients + + + + + + Add a client to the internal clients list + + client to add + + + + Remove a client from the internal clients list + + client to remove + + + + Test if this handler has active connections + + + true if this handler has active connections + + + + This property will be true while this handler has + active connections, that is at least one connection that + the handler will attempt to send a message to. + + + + + + Callback used to accept a connection on the server socket + + The result of the asynchronous operation + + + On connection adds to the list of connections + if there are two many open connections you will be disconnected + + + + + + Close all network connections + + + + Make sure we close all network connections + + + + + + Sends logging events to a . + + + + An Appender that writes to a . + + + This appender may be used stand alone if initialized with an appropriate + writer, however it is typically used as a base class for an appender that + can open a to write to. + + + Nicko Cadell + Gert Driesen + Douglas de la Torre + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Initializes a new instance of the class and + sets the output destination to a new initialized + with the specified . + + The layout to use with this appender. + The to output to. + + + Obsolete constructor. + + + + + + Initializes a new instance of the class and sets + the output destination to the specified . + + The layout to use with this appender + The to output to + + The must have been previously opened. + + + + Obsolete constructor. + + + + + + Gets or set whether the appender will flush at the end + of each append operation. + + + + The default behavior is to flush at the end of each + append operation. + + + If this option is set to false, then the underlying + stream can defer persisting the logging event to a later + time. + + + + Avoiding the flush operation at the end of each append results in + a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + + + + + Sets the where the log output will go. + + + + The specified must be open and writable. + + + The will be closed when the appender + instance is closed. + + + Note: Logging to an unopened will fail. + + + + + + This method determines if there is a sense in attempting to append. + + + + This method checks if an output target has been set and if a + layout has been set. + + + false if any of the preconditions fail. + + + + This method is called by the + method. + + The event to log. + + + Writes a log statement to the output stream if the output stream exists + and is writable. + + + The format of the output will depend on the appender's layout. + + + + + + This method is called by the + method. + + The array of events to log. + + + This method writes all the bulk logged events to the output writer + before flushing the stream. + + + + + + Close this appender instance. The underlying stream or writer is also closed. + + + Closed appenders cannot be reused. + + + + + Gets or set the and the underlying + , if any, for this appender. + + + The for this appender. + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Writes the footer and closes the underlying . + + + + Writes the footer and closes the underlying . + + + + + + Closes the underlying . + + + + Closes the underlying . + + + + + + Clears internal references to the underlying + and other variables. + + + + Subclasses can override this method for an alternate closing behavior. + + + + + + Writes a footer as produced by the embedded layout's property. + + + + Writes a footer as produced by the embedded layout's property. + + + + + + Writes a header produced by the embedded layout's property. + + + + Writes a header produced by the embedded layout's property. + + + + + + Called to allow a subclass to lazily initialize the writer + + + + This method is called when an event is logged and the or + have not been set. This allows a subclass to + attempt to initialize the writer multiple times. + + + + + + Gets or sets the where logging events + will be written to. + + + The where logging events are written. + + + + This is the where logging events + will be written to. + + + + + + This is the where logging events + will be written to. + + + + + Immediate flush means that the underlying + or output stream will be flushed at the end of each append operation. + + + + Immediate flush is slower but ensures that each append request is + actually written. If is set to + false, then there is a good chance that the last few + logging events are not actually persisted if and when the application + crashes. + + + The default value is true. + + + + + + The fully qualified type of the TextWriterAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Flushes any buffered log data. + + The maximum time to wait for logging events to be flushed. + True if all logging events were flushed successfully, else false. + + + + Appends log events to the system. + + + + The application configuration file can be used to control what listeners + are actually used. See the MSDN documentation for the + class for details on configuring the + trace system. + + + Events are written using the System.Diagnostics.Trace.Write(string,string) + method. The event's logger name is the default value for the category parameter + of the Write method. + + + Compact Framework
+ The Compact Framework does not support the + class for any operation except Assert. When using the Compact Framework this + appender will write to the system rather than + the Trace system. This appender will therefore behave like the . +
+
+ Douglas de la Torre + Nicko Cadell + Gert Driesen + Ron Grabowski +
+ + + Initializes a new instance of the . + + + + Default constructor. + + + + + + Initializes a new instance of the + with a specified layout. + + The layout to use with this appender. + + + Obsolete constructor. + + + + + + Gets or sets a value that indicates whether the appender will + flush at the end of each write. + + + The default behavior is to flush at the end of each + write. If the option is set tofalse, then the underlying + stream can defer writing to physical medium to a later time. + + + Avoiding the flush operation at the end of each append results + in a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + + + + + + The category parameter sent to the Trace method. + + + + Defaults to %logger which will use the logger name of the current + as the category parameter. + + + + + + + + Writes the logging event to the system. + + The event to log. + + + Writes the logging event to the system. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Immediate flush means that the underlying writer or output stream + will be flushed at the end of each append operation. + + + + Immediate flush is slower but ensures that each append request is + actually written. If is set to + false, then there is a good chance that the last few + logs events are not actually written to persistent media if and + when the application crashes. + + + The default value is true. + + + + + Defaults to %logger + + + + + Flushes any buffered log data. + + The maximum time to wait for logging events to be flushed. + True if all logging events were flushed successfully, else false. + + + + Sends logging events as connectionless UDP datagrams to a remote host or a + multicast group using an . + + + + UDP guarantees neither that messages arrive, nor that they arrive in the correct order. + + + To view the logging results, a custom application can be developed that listens for logging + events. + + + When decoding events send via this appender remember to use the same encoding + to decode the events as was used to send the events. See the + property to specify the encoding to use. + + + + This example shows how to log receive logging events that are sent + on IP address 244.0.0.1 and port 8080 to the console. The event is + encoded in the packet as a unicode string and it is decoded as such. + + IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0); + UdpClient udpClient; + byte[] buffer; + string loggingEvent; + + try + { + udpClient = new UdpClient(8080); + + while(true) + { + buffer = udpClient.Receive(ref remoteEndPoint); + loggingEvent = System.Text.Encoding.Unicode.GetString(buffer); + Console.WriteLine(loggingEvent); + } + } + catch(Exception e) + { + Console.WriteLine(e.ToString()); + } + + + Dim remoteEndPoint as IPEndPoint + Dim udpClient as UdpClient + Dim buffer as Byte() + Dim loggingEvent as String + + Try + remoteEndPoint = new IPEndPoint(IPAddress.Any, 0) + udpClient = new UdpClient(8080) + + While True + buffer = udpClient.Receive(ByRef remoteEndPoint) + loggingEvent = System.Text.Encoding.Unicode.GetString(buffer) + Console.WriteLine(loggingEvent) + Wend + Catch e As Exception + Console.WriteLine(e.ToString()) + End Try + + + An example configuration section to log information using this appender to the + IP 224.0.0.1 on port 8080: + + + + + + + + + + Gert Driesen + Nicko Cadell + + + + Initializes a new instance of the class. + + + The default constructor initializes all fields to their default values. + + + + + Gets or sets the IP address of the remote host or multicast group to which + the underlying should sent the logging event. + + + The IP address of the remote host or multicast group to which the logging event + will be sent. + + + + Multicast addresses are identified by IP class D addresses (in the range 224.0.0.0 to + 239.255.255.255). Multicast packets can pass across different networks through routers, so + it is possible to use multicasts in an Internet scenario as long as your network provider + supports multicasting. + + + Hosts that want to receive particular multicast messages must register their interest by joining + the multicast group. Multicast messages are not sent to networks where no host has joined + the multicast group. Class D IP addresses are used for multicast groups, to differentiate + them from normal host addresses, allowing nodes to easily detect if a message is of interest. + + + Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below: + + + + + IP Address + Description + + + 224.0.0.1 + + + Sends a message to all system on the subnet. + + + + + 224.0.0.2 + + + Sends a message to all routers on the subnet. + + + + + 224.0.0.12 + + + The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet. + + + + + + + A complete list of actually reserved multicast addresses and their owners in the ranges + defined by RFC 3171 can be found at the IANA web site. + + + The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative + addresses. These addresses can be reused with other local groups. Routers are typically + configured with filters to prevent multicast traffic in this range from flowing outside + of the local network. + + + + + + Gets or sets the TCP port number of the remote host or multicast group to which + the underlying should sent the logging event. + + + An integer value in the range to + indicating the TCP port number of the remote host or multicast group to which the logging event + will be sent. + + + The underlying will send messages to this TCP port number + on the remote host or multicast group. + + The value specified is less than or greater than . + + + + Gets or sets the TCP port number from which the underlying will communicate. + + + An integer value in the range to + indicating the TCP port number from which the underlying will communicate. + + + + The underlying will bind to this port for sending messages. + + + Setting the value to 0 (the default) will cause the udp client not to bind to + a local port. + + + The value specified is less than or greater than . + + + + Gets or sets used to write the packets. + + + The used to write the packets. + + + + The used to write the packets. + + + + + + Gets or sets the underlying . + + + The underlying . + + + creates a to send logging events + over a network. Classes deriving from can use this + property to get or set this . Use the underlying + returned from if you require access beyond that which + provides. + + + + + Gets or sets the cached remote endpoint to which the logging events should be sent. + + + The cached remote endpoint to which the logging events will be sent. + + + The method will initialize the remote endpoint + with the values of the and + properties. + + + + + Initialize the appender based on the options set. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + The appender will be ignored if no was specified or + an invalid remote or local TCP port number was specified. + + + The required property was not specified. + The TCP port number assigned to or is less than or greater than . + + + + This method is called by the method. + + The event to log. + + + Sends the event using an UDP datagram. + + + Exceptions are passed to the . + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Closes the UDP connection and releases all resources associated with + this instance. + + + + Disables the underlying and releases all managed + and unmanaged resources associated with the . + + + + + + Initializes the underlying connection. + + + + The underlying is initialized and binds to the + port number from which you intend to communicate. + + + Exceptions are passed to the . + + + + + + The IP address of the remote host or multicast group to which + the logging event will be sent. + + + + + The TCP port number of the remote host or multicast group to + which the logging event will be sent. + + + + + The cached remote endpoint to which the logging events will be sent. + + + + + The TCP port number from which the will communicate. + + + + + The instance that will be used for sending the + logging events. + + + + + The encoding to use for the packet. + + + + + Assembly level attribute that specifies a domain to alias to this assembly's repository. + + + + AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute. + + + An assembly's logger repository is defined by its , + however this can be overridden by an assembly loaded before the target assembly. + + + An assembly can alias another assembly's domain to its repository by + specifying this attribute with the name of the target domain. + + + This attribute can only be specified on the assembly and may be used + as many times as necessary to alias all the required domains. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class with + the specified domain to alias to this assembly's repository. + + The domain to alias to this assemby's repository. + + + Obsolete. Use instead of . + + + + + + Assembly level attribute that specifies a repository to alias to this assembly's repository. + + + + An assembly's logger repository is defined by its , + however this can be overridden by an assembly loaded before the target assembly. + + + An assembly can alias another assembly's repository to its repository by + specifying this attribute with the name of the target repository. + + + This attribute can only be specified on the assembly and may be used + as many times as necessary to alias all the required repositories. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class with + the specified repository to alias to this assembly's repository. + + The repository to alias to this assemby's repository. + + + Initializes a new instance of the class with + the specified repository to alias to this assembly's repository. + + + + + + Gets or sets the repository to alias to this assemby's repository. + + + The repository to alias to this assemby's repository. + + + + The name of the repository to alias to this assemby's repository. + + + + + + Use this class to quickly configure a . + + + + Allows very simple programmatic configuration of log4net. + + + Only one appender can be configured using this configurator. + The appender is set at the root of the hierarchy and all logging + events will be delivered to that appender. + + + Appenders can also implement the interface. Therefore + they would require that the method + be called after the appenders properties have been configured. + + + Nicko Cadell + Gert Driesen + + + + The fully qualified type of the BasicConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to prevent instantiation of this class. + + + + + + Initializes the log4net system with a default configuration. + + + + Initializes the log4net logging system using a + that will write to Console.Out. The log messages are + formatted using the layout object + with the + layout style. + + + + + + Initializes the log4net system using the specified appenders. + + The appenders to use to log all logging events. + + + Initializes the log4net system using the specified appenders. + + + + + + Initializes the log4net system using the specified appender. + + The appender to use to log all logging events. + + + Initializes the log4net system using the specified appender. + + + + + + Initializes the with a default configuration. + + The repository to configure. + + + Initializes the specified repository using a + that will write to Console.Out. The log messages are + formatted using the layout object + with the + layout style. + + + + + + Initializes the using the specified appender. + + The repository to configure. + The appender to use to log all logging events. + + + Initializes the using the specified appender. + + + + + + Initializes the using the specified appenders. + + The repository to configure. + The appenders to use to log all logging events. + + + Initializes the using the specified appender. + + + + + + Base class for all log4net configuration attributes. + + + This is an abstract class that must be extended by + specific configurators. This attribute allows the + configurator to be parameterized by an assembly level + attribute. + + Nicko Cadell + Gert Driesen + + + + Constructor used by subclasses. + + the ordering priority for this configurator + + + The is used to order the configurator + attributes before they are invoked. Higher priority configurators are executed + before lower priority ones. + + + + + + Configures the for the specified assembly. + + The assembly that this attribute was defined on. + The repository to configure. + + + Abstract method implemented by a subclass. When this method is called + the subclass should configure the . + + + + + + Compare this instance to another ConfiguratorAttribute + + the object to compare to + see + + + Compares the priorities of the two instances. + Sorts by priority in descending order. Objects with the same priority are + randomly ordered. + + + + + + Assembly level attribute that specifies the logging domain for the assembly. + + + + DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute. + + + Assemblies are mapped to logging domains. Each domain has its own + logging repository. This attribute specified on the assembly controls + the configuration of the domain. The property specifies the name + of the domain that this assembly is a part of. The + specifies the type of the repository objects to create for the domain. If + this attribute is not specified and a is not specified + then the assembly will be part of the default shared logging domain. + + + This attribute can only be specified on the assembly and may only be used + once per assembly. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Obsolete. Use RepositoryAttribute instead of DomainAttribute. + + + + + + Initialize a new instance of the class + with the name of the domain. + + The name of the domain. + + + Obsolete. Use RepositoryAttribute instead of DomainAttribute. + + + + + + Use this class to initialize the log4net environment using an Xml tree. + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + Configures a using an Xml tree. + + + Nicko Cadell + Gert Driesen + + + + Private constructor + + + + + Automatically configures the log4net system based on the + application's configuration settings. + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + log4net that contains the configuration data. + + + + + Automatically configures the using settings + stored in the application's configuration file. + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + log4net that contains the configuration data. + + The repository to configure. + + + + Configures log4net using a log4net element + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Loads the log4net configuration from the XML element + supplied as . + + The element to parse. + + + + Configures the using the specified XML + element. + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Loads the log4net configuration from the XML element + supplied as . + + The repository to configure. + The element to parse. + + + + Configures log4net using the specified configuration file. + + The XML file to load the configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + The log4net configuration file can possible be specified in the application's + configuration file (either MyAppName.exe.config for a + normal application on Web.config for an ASP.NET application). + + + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + + + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + + + In the .config file, the path to the log4net can be specified like this : + + + + + + + + + + + + + Configures log4net using the specified configuration file. + + A stream to load the XML configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + Note that this method will NOT close the stream parameter. + + + + + + Configures the using the specified configuration + file. + + The repository to configure. + The XML file to load the configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The log4net configuration file can possible be specified in the application's + configuration file (either MyAppName.exe.config for a + normal application on Web.config for an ASP.NET application). + + + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + + + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + + + In the .config file, the path to the log4net can be specified like this : + + + + + + + + + + + + + Configures the using the specified configuration + file. + + The repository to configure. + The stream to load the XML configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + Note that this method will NOT close the stream parameter. + + + + + + Configures log4net using the file specified, monitors the file for changes + and reloads the configuration if a change is detected. + + The XML file to load the configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The configuration file will be monitored using a + and depends on the behavior of that class. + + + For more information on how to configure log4net using + a separate configuration file, see . + + + + + + + Configures the using the file specified, + monitors the file for changes and reloads the configuration if a change + is detected. + + The repository to configure. + The XML file to load the configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The configuration file will be monitored using a + and depends on the behavior of that class. + + + For more information on how to configure log4net using + a separate configuration file, see . + + + + + + + Assembly level attribute to configure the . + + + + AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute. + + + This attribute may only be used at the assembly scope and can only + be used once per assembly. + + + Use this attribute to configure the + without calling one of the + methods. + + + Nicko Cadell + Gert Driesen + + + + Class to register for the log4net section of the configuration file + + + The log4net section of the configuration file needs to have a section + handler registered. This is the section handler used. It simply returns + the XML element that is the root of the section. + + + Example of registering the log4net section handler : + + + +
+ + + log4net configuration XML goes here + + + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Parses the configuration section. + + The configuration settings in a corresponding parent configuration section. + The configuration context when called from the ASP.NET configuration system. Otherwise, this parameter is reserved and is a null reference. + The for the log4net section. + The for the log4net section. + + + Returns the containing the configuration data, + + + + + + Assembly level attribute that specifies a plugin to attach to + the repository. + + + + Specifies the type of a plugin to create and attach to the + assembly's repository. The plugin type must implement the + interface. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class + with the specified type. + + The type name of plugin to create. + + + Create the attribute with the plugin type specified. + + + Where possible use the constructor that takes a . + + + + + + Initializes a new instance of the class + with the specified type. + + The type of plugin to create. + + + Create the attribute with the plugin type specified. + + + + + + Gets or sets the type for the plugin. + + + The type for the plugin. + + + + The type for the plugin. + + + + + + Gets or sets the type name for the plugin. + + + The type name for the plugin. + + + + The type name for the plugin. + + + Where possible use the property instead. + + + + + + Creates the plugin object defined by this attribute. + + + + Creates the instance of the object as + specified by this attribute. + + + The plugin object. + + + + Returns a representation of the properties of this object. + + + + Overrides base class method to + return a representation of the properties of this object. + + + A representation of the properties of this object + + + + Assembly level attribute that specifies the logging repository for the assembly. + + + + Assemblies are mapped to logging repository. This attribute specified + on the assembly controls + the configuration of the repository. The property specifies the name + of the repository that this assembly is a part of. The + specifies the type of the object + to create for the assembly. If this attribute is not specified or a + is not specified then the assembly will be part of the default shared logging repository. + + + This attribute can only be specified on the assembly and may only be used + once per assembly. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Initialize a new instance of the class + with the name of the repository. + + The name of the repository. + + + Initialize the attribute with the name for the assembly's repository. + + + + + + Gets or sets the name of the logging repository. + + + The string name to use as the name of the repository associated with this + assembly. + + + + This value does not have to be unique. Several assemblies can share the + same repository. They will share the logging configuration of the repository. + + + + + + Gets or sets the type of repository to create for this assembly. + + + The type of repository to create for this assembly. + + + + The type of the repository to create for the assembly. + The type must implement the + interface. + + + This will be the type of repository created when + the repository is created. If multiple assemblies reference the + same repository then the repository is only created once using the + of the first assembly to call into the + repository. + + + + + + Assembly level attribute to configure the . + + + + This attribute may only be used at the assembly scope and can only + be used once per assembly. + + + Use this attribute to configure the + without calling one of the + methods. + + + Nicko Cadell + + + + Construct provider attribute with type specified + + the type of the provider to use + + + The provider specified must subclass the + class. + + + + + + Gets or sets the type of the provider to use. + + + the type of the provider to use. + + + + The provider specified must subclass the + class. + + + + + + Configures the SecurityContextProvider + + The assembly that this attribute was defined on. + The repository to configure. + + + Creates a provider instance from the specified. + Sets this as the default security context provider . + + + + + + The fully qualified type of the SecurityContextProviderAttribute class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Use this class to initialize the log4net environment using an Xml tree. + + + + Configures a using an Xml tree. + + + Nicko Cadell + Gert Driesen + + + + Private constructor + + + + + Automatically configures the using settings + stored in the application's configuration file. + + + + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + log4net that contains the configuration data. + + + To use this method to configure log4net you must specify + the section + handler for the log4net configuration section. See the + for an example. + + + The repository to configure. + + + + Automatically configures the log4net system based on the + application's configuration settings. + + + + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + log4net that contains the configuration data. + + + To use this method to configure log4net you must specify + the section + handler for the log4net configuration section. See the + for an example. + + + + + + + Configures log4net using a log4net element + + + + Loads the log4net configuration from the XML element + supplied as . + + + The element to parse. + + + + Configures log4net using the specified configuration file. + + The XML file to load the configuration from. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + The log4net configuration file can possible be specified in the application's + configuration file (either MyAppName.exe.config for a + normal application on Web.config for an ASP.NET application). + + + The first element matching <configuration> will be read as the + configuration. If this file is also a .NET .config file then you must specify + a configuration section for the log4net element otherwise .NET will + complain. Set the type for the section handler to , for example: + + +
+ + + + + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + + + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + + + In the .config file, the path to the log4net can be specified like this : + + + + + + + + + + + + + Configures log4net using the specified configuration URI. + + A URI to load the XML configuration from. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + The must support the URI scheme specified. + + + + + + Configures log4net using the specified configuration data stream. + + A stream to load the XML configuration from. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + Note that this method will NOT close the stream parameter. + + + + + + Configures the using the specified XML + element. + + + Loads the log4net configuration from the XML element + supplied as . + + The repository to configure. + The element to parse. + + + + Configures the using the specified configuration + file. + + The repository to configure. + The XML file to load the configuration from. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The log4net configuration file can possible be specified in the application's + configuration file (either MyAppName.exe.config for a + normal application on Web.config for an ASP.NET application). + + + The first element matching <configuration> will be read as the + configuration. If this file is also a .NET .config file then you must specify + a configuration section for the log4net element otherwise .NET will + complain. Set the type for the section handler to , for example: + + +
+ + + + + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + + + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + + + In the .config file, the path to the log4net can be specified like this : + + + + + + + + + + + + + Configures the using the specified configuration + URI. + + The repository to configure. + A URI to load the XML configuration from. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The must support the URI scheme specified. + + + + + + Configures the using the specified configuration + file. + + The repository to configure. + The stream to load the XML configuration from. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + Note that this method will NOT close the stream parameter. + + + + + + Configures log4net using the file specified, monitors the file for changes + and reloads the configuration if a change is detected. + + The XML file to load the configuration from. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The configuration file will be monitored using a + and depends on the behavior of that class. + + + For more information on how to configure log4net using + a separate configuration file, see . + + + + + + + Configures the using the file specified, + monitors the file for changes and reloads the configuration if a change + is detected. + + The repository to configure. + The XML file to load the configuration from. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The configuration file will be monitored using a + and depends on the behavior of that class. + + + For more information on how to configure log4net using + a separate configuration file, see . + + + + + + + Class used to watch config files. + + + + Uses the to monitor + changes to a specified file. Because multiple change notifications + may be raised when the file is modified, a timer is used to + compress the notifications into a single event. The timer + waits for time before delivering + the event notification. If any further + change notifications arrive while the timer is waiting it + is reset and waits again for to + elapse. + + + + + + Holds the FileInfo used to configure the XmlConfigurator + + + + + Holds the repository being configured. + + + + + The timer used to compress the notification events. + + + + + The default amount of time to wait after receiving notification + before reloading the config file. + + + + + Watches file for changes. This object should be disposed when no longer + needed to free system handles on the watched resources. + + + + + Initializes a new instance of the class to + watch a specified config file used to configure a repository. + + The repository to configure. + The configuration file to watch. + + + Initializes a new instance of the class. + + + + + + Event handler used by . + + The firing the event. + The argument indicates the file that caused the event to be fired. + + + This handler reloads the configuration from the file when the event is fired. + + + + + + Event handler used by . + + The firing the event. + The argument indicates the file that caused the event to be fired. + + + This handler reloads the configuration from the file when the event is fired. + + + + + + Called by the timer when the configuration has been updated. + + null + + + + Release the handles held by the watcher and timer. + + + + + Configures the specified repository using a log4net element. + + The hierarchy to configure. + The element to parse. + + + Loads the log4net configuration from the XML element + supplied as . + + + This method is ultimately called by one of the Configure methods + to load the configuration from an . + + + + + + Maps repository names to ConfigAndWatchHandler instances to allow a particular + ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is + reconfigured. + + + + + The fully qualified type of the XmlConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Assembly level attribute to configure the . + + + + This attribute may only be used at the assembly scope and can only + be used once per assembly. + + + Use this attribute to configure the + without calling one of the + methods. + + + If neither of the or + properties are set the configuration is loaded from the application's .config file. + If set the property takes priority over the + property. The property + specifies a path to a file to load the config from. The path is relative to the + application's base directory; . + The property is used as a postfix to the assembly file name. + The config file must be located in the application's base directory; . + For example in a console application setting the to + config has the same effect as not specifying the or + properties. + + + The property can be set to cause the + to watch the configuration file for changes. + + + + Log4net will only look for assembly level configuration attributes once. + When using the log4net assembly level attributes to control the configuration + of log4net you must ensure that the first call to any of the + methods is made from the assembly with the configuration + attributes. + + + If you cannot guarantee the order in which log4net calls will be made from + different assemblies you must use programmatic configuration instead, i.e. + call the method directly. + + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Default constructor + + + + + + Gets or sets the filename of the configuration file. + + + The filename of the configuration file. + + + + If specified, this is the name of the configuration file to use with + the . This file path is relative to the + application base directory (). + + + The takes priority over the . + + + + + + Gets or sets the extension of the configuration file. + + + The extension of the configuration file. + + + + If specified this is the extension for the configuration file. + The path to the config file is built by using the application + base directory (), + the assembly file name and the config file extension. + + + If the is set to MyExt then + possible config file names would be: MyConsoleApp.exe.MyExt or + MyClassLibrary.dll.MyExt. + + + The takes priority over the . + + + + + + Gets or sets a value indicating whether to watch the configuration file. + + + true if the configuration should be watched, false otherwise. + + + + If this flag is specified and set to true then the framework + will watch the configuration file and will reload the config each time + the file is modified. + + + The config file can only be watched if it is loaded from local disk. + In a No-Touch (Smart Client) deployment where the application is downloaded + from a web server the config file may not reside on the local disk + and therefore it may not be able to watch it. + + + Watching configuration is not supported on the SSCLI. + + + + + + Configures the for the specified assembly. + + The assembly that this attribute was defined on. + The repository to configure. + + + Configure the repository using the . + The specified must extend the + class otherwise the will not be able to + configure it. + + + The does not extend . + + + + Attempt to load configuration from the local file system + + The assembly that this attribute was defined on. + The repository to configure. + + + + Configure the specified repository using a + + The repository to configure. + the FileInfo pointing to the config file + + + + Attempt to load configuration from a URI + + The assembly that this attribute was defined on. + The repository to configure. + + + + The fully qualified type of the XmlConfiguratorAttribute class. + + + Used by the internal logger to record the Type of the + log message. + + + + + The implementation of the interface suitable + for use with the compact framework + + + + This implementation is a simple + mapping between repository name and + object. + + + The .NET Compact Framework 1.0 does not support retrieving assembly + level attributes therefore unlike the DefaultRepositorySelector + this selector does not examine the calling assembly for attributes. + + + Nicko Cadell + + + + Create a new repository selector + + the type of the repositories to create, must implement + + + Create an new compact repository selector. + The default type for repositories must be specified, + an appropriate value would be . + + + throw if is null + throw if does not implement + + + + Get the for the specified assembly + + not used + The default + + + The argument is not used. This selector does not create a + separate repository for each assembly. + + + As a named repository is not specified the default repository is + returned. The default repository is named log4net-default-repository. + + + + + + Get the named + + the name of the repository to lookup + The named + + + Get the named . The default + repository is log4net-default-repository. Other repositories + must be created using the . + If the named repository does not exist an exception is thrown. + + + throw if is null + throw if the does not exist + + + + Create a new repository for the assembly specified + + not used + the type of repository to create, must implement + the repository created + + + The argument is not used. This selector does not create a + separate repository for each assembly. + + + If the is null then the + default repository type specified to the constructor is used. + + + As a named repository is not specified the default repository is + returned. The default repository is named log4net-default-repository. + + + + + + Create a new repository for the repository specified + + the repository to associate with the + the type of repository to create, must implement . + If this param is null then the default repository type is used. + the repository created + + + The created will be associated with the repository + specified such that a call to with the + same repository specified will return the same repository instance. + + + If the named repository already exists an exception will be thrown. + + + If is null then the default + repository type specified to the constructor is used. + + + throw if is null + throw if the already exists + + + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + + + + + Gets a list of objects + + an array of all known objects + + + Gets an array of all of the repositories created by this selector. + + + + + + The fully qualified type of the CompactRepositorySelector class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Event to notify that a logger repository has been created. + + + Event to notify that a logger repository has been created. + + + + Event raised when a new repository is created. + The event source will be this selector. The event args will + be a which + holds the newly created . + + + + + + Notify the registered listeners that the repository has been created + + The repository that has been created + + + Raises the LoggerRepositoryCreatedEvent + event. + + + + + + The default implementation of the interface. + + + + Uses attributes defined on the calling assembly to determine how to + configure the hierarchy for the repository. + + + Nicko Cadell + Gert Driesen + + + + Event to notify that a logger repository has been created. + + + Event to notify that a logger repository has been created. + + + + Event raised when a new repository is created. + The event source will be this selector. The event args will + be a which + holds the newly created . + + + + + + Creates a new repository selector. + + The type of the repositories to create, must implement + + + Create an new repository selector. + The default type for repositories must be specified, + an appropriate value would be . + + + is . + does not implement . + + + + Gets the for the specified assembly. + + The assembly use to lookup the . + + + The type of the created and the repository + to create can be overridden by specifying the + attribute on the . + + + The default values are to use the + implementation of the interface and to use the + as the name of the repository. + + + The created will be automatically configured using + any attributes defined on + the . + + + The for the assembly + is . + + + + Gets the for the specified repository. + + The repository to use to lookup the . + The for the specified repository. + + + Returns the named repository. If is null + a is thrown. If the repository + does not exist a is thrown. + + + Use to create a repository. + + + is . + does not exist. + + + + Create a new repository for the assembly specified + + the assembly to use to create the repository to associate with the . + The type of repository to create, must implement . + The repository created. + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + The type of the created and + the repository to create can be overridden by specifying the + attribute on the + . The default values are to use the + implementation of the + interface and to use the + as the name of the repository. + + + The created will be automatically + configured using any + attributes defined on the . + + + If a repository for the already exists + that repository will be returned. An error will not be raised and that + repository may be of a different type to that specified in . + Also the attribute on the + assembly may be used to override the repository type specified in + . + + + is . + + + + Creates a new repository for the assembly specified. + + the assembly to use to create the repository to associate with the . + The type of repository to create, must implement . + The name to assign to the created repository + Set to true to read and apply the assembly attributes + The repository created. + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + The type of the created and + the repository to create can be overridden by specifying the + attribute on the + . The default values are to use the + implementation of the + interface and to use the + as the name of the repository. + + + The created will be automatically + configured using any + attributes defined on the . + + + If a repository for the already exists + that repository will be returned. An error will not be raised and that + repository may be of a different type to that specified in . + Also the attribute on the + assembly may be used to override the repository type specified in + . + + + is . + + + + Creates a new repository for the specified repository. + + The repository to associate with the . + The type of repository to create, must implement . + If this param is then the default repository type is used. + The new repository. + + + The created will be associated with the repository + specified such that a call to with the + same repository specified will return the same repository instance. + + + is . + already exists. + + + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + + + + + Gets a list of objects + + an array of all known objects + + + Gets an array of all of the repositories created by this selector. + + + + + + Aliases a repository to an existing repository. + + The repository to alias. + The repository that the repository is aliased to. + + + The repository specified will be aliased to the repository when created. + The repository must not already exist. + + + When the repository is created it must utilize the same repository type as + the repository it is aliased to, otherwise the aliasing will fail. + + + + is . + -or- + is . + + + + + Notifies the registered listeners that the repository has been created. + + The repository that has been created. + + + Raises the event. + + + + + + Gets the repository name and repository type for the specified assembly. + + The assembly that has a . + in/out param to hold the repository name to use for the assembly, caller should set this to the default value before calling. + in/out param to hold the type of the repository to create for the assembly, caller should set this to the default value before calling. + is . + + + + Configures the repository using information from the assembly. + + The assembly containing + attributes which define the configuration for the repository. + The repository to configure. + + is . + -or- + is . + + + + + Loads the attribute defined plugins on the assembly. + + The assembly that contains the attributes. + The repository to add the plugins to. + + is . + -or- + is . + + + + + Loads the attribute defined aliases on the assembly. + + The assembly that contains the attributes. + The repository to alias to. + + is . + -or- + is . + + + + + The fully qualified type of the DefaultRepositorySelector class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Defined error codes that can be passed to the method. + + + + Values passed to the method. + + + Nicko Cadell + + + + A general error + + + + + Error while writing output + + + + + Failed to flush file + + + + + Failed to close file + + + + + Unable to open output file + + + + + No layout specified + + + + + Failed to parse address + + + + + An evaluator that triggers on an Exception type + + + + This evaluator will trigger if the type of the Exception + passed to + is equal to a Type in . /// + + + Drew Schaeffer + + + + The type that causes the trigger to fire. + + + + + Causes subclasses of to cause the trigger to fire. + + + + + Default ctor to allow dynamic creation through a configurator. + + + + + Constructs an evaluator and initializes to trigger on + + the type that triggers this evaluator. + If true, this evaluator will trigger on subclasses of . + + + + The type that triggers this evaluator. + + + + + If true, this evaluator will trigger on subclasses of . + + + + + Is this the triggering event? + + The event to check + This method returns true, if the logging event Exception + Type is . + Otherwise it returns false + + + This evaluator will trigger if the Exception Type of the event + passed to + is . + + + + + + Interface for attaching appenders to objects. + + + + Interface for attaching, removing and retrieving appenders. + + + Nicko Cadell + Gert Driesen + + + + Attaches an appender. + + The appender to add. + + + Add the specified appender. The implementation may + choose to allow or deny duplicate appenders. + + + + + + Gets all attached appenders. + + + A collection of attached appenders. + + + + Gets a collection of attached appenders. + If there are no attached appenders the + implementation should return an empty + collection rather than null. + + + + + + Gets an attached appender with the specified name. + + The name of the appender to get. + + The appender with the name specified, or null if no appender with the + specified name is found. + + + + Returns an attached appender with the specified. + If no appender with the specified name is found null will be + returned. + + + + + + Removes all attached appenders. + + + + Removes and closes all attached appenders + + + + + + Removes the specified appender from the list of attached appenders. + + The appender to remove. + The appender removed from the list + + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + Removes the appender with the specified name from the list of appenders. + + The name of the appender to remove. + The appender removed from the list + + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + Appenders may delegate their error handling to an . + + + + Error handling is a particularly tedious to get right because by + definition errors are hard to predict and to reproduce. + + + Nicko Cadell + Gert Driesen + + + + Handles the error and information about the error condition is passed as + a parameter. + + The message associated with the error. + The that was thrown when the error occurred. + The error code associated with the error. + + + Handles the error and information about the error condition is passed as + a parameter. + + + + + + Prints the error message passed as a parameter. + + The message associated with the error. + The that was thrown when the error occurred. + + + See . + + + + + + Prints the error message passed as a parameter. + + The message associated with the error. + + + See . + + + + + + Interface for objects that require fixing. + + + + Interface that indicates that the object requires fixing before it + can be taken outside the context of the appender's + method. + + + When objects that implement this interface are stored + in the context properties maps + and + are fixed + (see ) the + method will be called. + + + Nicko Cadell + + + + Get a portable version of this object + + the portable instance of this object + + + Get a portable instance object that represents the current + state of this object. The portable object can be stored + and logged from any thread with identical results. + + + + + + Interface that all loggers implement + + + + This interface supports logging events and testing if a level + is enabled for logging. + + + These methods will not throw exceptions. Note to implementor, ensure + that the implementation of these methods cannot allow an exception + to be thrown to the caller. + + + Nicko Cadell + Gert Driesen + + + + Gets the name of the logger. + + + The name of the logger. + + + + The name of this logger + + + + + + This generic form is intended to be used by wrappers. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + the exception to log, including its stack trace. Pass null to not log an exception. + + + Generates a logging event for the specified using + the and . + + + + + + This is the most generic printing method that is intended to be used + by wrappers. + + The event being logged. + + + Logs the specified logging event through this logger. + + + + + + Checks if this logger is enabled for a given passed as parameter. + + The level to check. + + true if this logger is enabled for level, otherwise false. + + + + Test if this logger is going to log events of the specified . + + + + + + Gets the where this + Logger instance is attached to. + + + The that this logger belongs to. + + + + Gets the where this + Logger instance is attached to. + + + + + + Base interface for all wrappers + + + + Base interface for all wrappers. + + + All wrappers must implement this interface. + + + Nicko Cadell + + + + Get the implementation behind this wrapper object. + + + The object that in implementing this object. + + + + The object that in implementing this + object. The Logger object may not + be the same object as this object because of logger decorators. + This gets the actual underlying objects that is used to process + the log events. + + + + + + Interface used to delay activate a configured object. + + + + This allows an object to defer activation of its options until all + options have been set. This is required for components which have + related options that remain ambiguous until all are set. + + + If a component implements this interface then the method + must be called by the container after its all the configured properties have been set + and before the component can be used. + + + Nicko Cadell + + + + Activate the options that were previously set with calls to properties. + + + + This allows an object to defer activation of its options until all + options have been set. This is required for components which have + related options that remain ambiguous until all are set. + + + If a component implements this interface then this method must be called + after its properties have been set before the component can be used. + + + + + + Delegate used to handle logger repository creation event notifications + + The which created the repository. + The event args + that holds the instance that has been created. + + + Delegate used to handle logger repository creation event notifications. + + + + + + Provides data for the event. + + + + A + event is raised every time a is created. + + + + + + The created + + + + + Construct instance using specified + + the that has been created + + + Construct instance using specified + + + + + + The that has been created + + + The that has been created + + + + The that has been created + + + + + + Interface used by the to select the . + + + + The uses a + to specify the policy for selecting the correct + to return to the caller. + + + Nicko Cadell + Gert Driesen + + + + Gets the for the specified assembly. + + The assembly to use to lookup to the + The for the assembly. + + + Gets the for the specified assembly. + + + How the association between and + is made is not defined. The implementation may choose any method for + this association. The results of this method must be repeatable, i.e. + when called again with the same arguments the result must be the + save value. + + + + + + Gets the named . + + The name to use to lookup to the . + The named + + Lookup a named . This is the repository created by + calling . + + + + + Creates a new repository for the assembly specified. + + The assembly to use to create the domain to associate with the . + The type of repository to create, must implement . + The repository created. + + + The created will be associated with the domain + specified such that a call to with the + same assembly specified will return the same repository instance. + + + How the association between and + is made is not defined. The implementation may choose any method for + this association. + + + + + + Creates a new repository with the name specified. + + The name to associate with the . + The type of repository to create, must implement . + The repository created. + + + The created will be associated with the name + specified such that a call to with the + same name will return the same repository instance. + + + + + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + + + + + Gets an array of all currently defined repositories. + + + An array of the instances created by + this . + + + Gets an array of all of the repositories created by this selector. + + + + + + Event to notify that a logger repository has been created. + + + Event to notify that a logger repository has been created. + + + + Event raised when a new repository is created. + The event source will be this selector. The event args will + be a which + holds the newly created . + + + + + + Test if an triggers an action + + + + Implementations of this interface allow certain appenders to decide + when to perform an appender specific action. + + + The action or behavior triggered is defined by the implementation. + + + Nicko Cadell + + + + Test if this event triggers the action + + The event to check + true if this event triggers the action, otherwise false + + + Return true if this event triggers the action + + + + + + Defines the default set of levels recognized by the system. + + + + Each has an associated . + + + Levels have a numeric that defines the relative + ordering between levels. Two Levels with the same + are deemed to be equivalent. + + + The levels that are recognized by log4net are set for each + and each repository can have different levels defined. The levels are stored + in the on the repository. Levels are + looked up by name from the . + + + When logging at level INFO the actual level used is not but + the value of LoggerRepository.LevelMap["INFO"]. The default value for this is + , but this can be changed by reconfiguring the level map. + + + Each level has a in addition to its . The + is the string that is written into the output log. By default + the display name is the same as the level name, but this can be used to alias levels + or to localize the log output. + + + Some of the predefined levels recognized by the system are: + + + + . + + + . + + + . + + + . + + + . + + + . + + + . + + + + Nicko Cadell + Gert Driesen + + + + Constructor + + Integer value for this level, higher values represent more severe levels. + The string name of this level. + The display name for this level. This may be localized or otherwise different from the name + + + Initializes a new instance of the class with + the specified level name and value. + + + + + + Constructor + + Integer value for this level, higher values represent more severe levels. + The string name of this level. + + + Initializes a new instance of the class with + the specified level name and value. + + + + + + Gets the name of this level. + + + The name of this level. + + + + Gets the name of this level. + + + + + + Gets the value of this level. + + + The value of this level. + + + + Gets the value of this level. + + + + + + Gets the display name of this level. + + + The display name of this level. + + + + Gets the display name of this level. + + + + + + Returns the representation of the current + . + + + A representation of the current . + + + + Returns the level . + + + + + + Compares levels. + + The object to compare against. + true if the objects are equal. + + + Compares the levels of instances, and + defers to base class if the target object is not a + instance. + + + + + + Returns a hash code + + A hash code for the current . + + + Returns a hash code suitable for use in hashing algorithms and data + structures like a hash table. + + + Returns the hash code of the level . + + + + + + Compares this instance to a specified object and returns an + indication of their relative values. + + A instance or to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the + values compared. The return value has these meanings: + + + Value + Meaning + + + Less than zero + This instance is less than . + + + Zero + This instance is equal to . + + + Greater than zero + + This instance is greater than . + -or- + is . + + + + + + + must be an instance of + or ; otherwise, an exception is thrown. + + + is not a . + + + + Returns a value indicating whether a specified + is greater than another specified . + + A + A + + true if is greater than + ; otherwise, false. + + + + Compares two levels. + + + + + + Returns a value indicating whether a specified + is less than another specified . + + A + A + + true if is less than + ; otherwise, false. + + + + Compares two levels. + + + + + + Returns a value indicating whether a specified + is greater than or equal to another specified . + + A + A + + true if is greater than or equal to + ; otherwise, false. + + + + Compares two levels. + + + + + + Returns a value indicating whether a specified + is less than or equal to another specified . + + A + A + + true if is less than or equal to + ; otherwise, false. + + + + Compares two levels. + + + + + + Returns a value indicating whether two specified + objects have the same value. + + A or . + A or . + + true if the value of is the same as the + value of ; otherwise, false. + + + + Compares two levels. + + + + + + Returns a value indicating whether two specified + objects have different values. + + A or . + A or . + + true if the value of is different from + the value of ; otherwise, false. + + + + Compares two levels. + + + + + + Compares two specified instances. + + The first to compare. + The second to compare. + + A 32-bit signed integer that indicates the relative order of the + two values compared. The return value has these meanings: + + + Value + Meaning + + + Less than zero + is less than . + + + Zero + is equal to . + + + Greater than zero + is greater than . + + + + + + Compares two levels. + + + + + + The level designates a higher level than all the rest. + + + + + The level designates very severe error events. + System unusable, emergencies. + + + + + The level designates very severe error events. + System unusable, emergencies. + + + + + The level designates very severe error events + that will presumably lead the application to abort. + + + + + The level designates very severe error events. + Take immediate action, alerts. + + + + + The level designates very severe error events. + Critical condition, critical. + + + + + The level designates very severe error events. + + + + + The level designates error events that might + still allow the application to continue running. + + + + + The level designates potentially harmful + situations. + + + + + The level designates informational messages + that highlight the progress of the application at the highest level. + + + + + The level designates informational messages that + highlight the progress of the application at coarse-grained level. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates the lowest level possible. + + + + + A strongly-typed collection of objects. + + Nicko Cadell + + + + Supports type-safe iteration over a . + + + + + Gets the current element in the collection. + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + Creates a read-only wrapper for a LevelCollection instance. + + list to create a readonly wrapper arround + + A LevelCollection wrapper that is read-only. + + + + + Initializes a new instance of the LevelCollection class + that is empty and has the default initial capacity. + + + + + Initializes a new instance of the LevelCollection class + that has the specified initial capacity. + + + The number of elements that the new LevelCollection is initially capable of storing. + + + + + Initializes a new instance of the LevelCollection class + that contains elements copied from the specified LevelCollection. + + The LevelCollection whose elements are copied to the new collection. + + + + Initializes a new instance of the LevelCollection class + that contains elements copied from the specified array. + + The array whose elements are copied to the new list. + + + + Initializes a new instance of the LevelCollection class + that contains elements copied from the specified collection. + + The collection whose elements are copied to the new list. + + + + Type visible only to our subclasses + Used to access protected constructor + + + + + A value + + + + + Allow subclasses to avoid our default constructors + + + + + + Gets the number of elements actually contained in the LevelCollection. + + + + + Copies the entire LevelCollection to a one-dimensional + array. + + The one-dimensional array to copy to. + + + + Copies the entire LevelCollection to a one-dimensional + array, starting at the specified index of the target array. + + The one-dimensional array to copy to. + The zero-based index in at which copying begins. + + + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + false, because the backing type is an array, which is never thread-safe. + + + + Gets an object that can be used to synchronize access to the collection. + + + + + Gets or sets the at the specified index. + + The zero-based index of the element to get or set. + + is less than zero + -or- + is equal to or greater than . + + + + + Adds a to the end of the LevelCollection. + + The to be added to the end of the LevelCollection. + The index at which the value has been added. + + + + Removes all elements from the LevelCollection. + + + + + Creates a shallow copy of the . + + A new with a shallow copy of the collection data. + + + + Determines whether a given is in the LevelCollection. + + The to check for. + true if is found in the LevelCollection; otherwise, false. + + + + Returns the zero-based index of the first occurrence of a + in the LevelCollection. + + The to locate in the LevelCollection. + + The zero-based index of the first occurrence of + in the entire LevelCollection, if found; otherwise, -1. + + + + + Inserts an element into the LevelCollection at the specified index. + + The zero-based index at which should be inserted. + The to insert. + + is less than zero + -or- + is equal to or greater than . + + + + + Removes the first occurrence of a specific from the LevelCollection. + + The to remove from the LevelCollection. + + The specified was not found in the LevelCollection. + + + + + Removes the element at the specified index of the LevelCollection. + + The zero-based index of the element to remove. + + is less than zero + -or- + is equal to or greater than . + + + + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false + + + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false + + + + Returns an enumerator that can iterate through the LevelCollection. + + An for the entire LevelCollection. + + + + Gets or sets the number of elements the LevelCollection can contain. + + + + + Adds the elements of another LevelCollection to the current LevelCollection. + + The LevelCollection whose elements should be added to the end of the current LevelCollection. + The new of the LevelCollection. + + + + Adds the elements of a array to the current LevelCollection. + + The array whose elements should be added to the end of the LevelCollection. + The new of the LevelCollection. + + + + Adds the elements of a collection to the current LevelCollection. + + The collection whose elements should be added to the end of the LevelCollection. + The new of the LevelCollection. + + + + Sets the capacity to the actual number of elements. + + + + + is less than zero + -or- + is equal to or greater than . + + + + + is less than zero + -or- + is equal to or greater than . + + + + + Supports simple iteration over a . + + + + + Initializes a new instance of the Enumerator class. + + + + + + Gets the current element in the collection. + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + An evaluator that triggers at a threshold level + + + + This evaluator will trigger if the level of the event + passed to + is equal to or greater than the + level. + + + Nicko Cadell + + + + The threshold for triggering + + + + + Create a new evaluator using the threshold. + + + + Create a new evaluator using the threshold. + + + This evaluator will trigger if the level of the event + passed to + is equal to or greater than the + level. + + + + + + Create a new evaluator using the specified threshold. + + the threshold to trigger at + + + Create a new evaluator using the specified threshold. + + + This evaluator will trigger if the level of the event + passed to + is equal to or greater than the + level. + + + + + + the threshold to trigger at + + + The that will cause this evaluator to trigger + + + + This evaluator will trigger if the level of the event + passed to + is equal to or greater than the + level. + + + + + + Is this the triggering event? + + The event to check + This method returns true, if the event level + is equal or higher than the . + Otherwise it returns false + + + This evaluator will trigger if the level of the event + passed to + is equal to or greater than the + level. + + + + + + Mapping between string name and Level object + + + + Mapping between string name and object. + This mapping is held separately for each . + The level name is case insensitive. + + + Nicko Cadell + + + + Mapping from level name to Level object. The + level name is case insensitive + + + + + Construct the level map + + + + Construct the level map. + + + + + + Clear the internal maps of all levels + + + + Clear the internal maps of all levels + + + + + + Lookup a by name + + The name of the Level to lookup + a Level from the map with the name specified + + + Returns the from the + map with the name specified. If the no level is + found then null is returned. + + + + + + Create a new Level and add it to the map + + the string to display for the Level + the level value to give to the Level + + + Create a new Level and add it to the map + + + + + + + Create a new Level and add it to the map + + the string to display for the Level + the level value to give to the Level + the display name to give to the Level + + + Create a new Level and add it to the map + + + + + + Add a Level to the map + + the Level to add + + + Add a Level to the map + + + + + + Return all possible levels as a list of Level objects. + + all possible levels as a list of Level objects + + + Return all possible levels as a list of Level objects. + + + + + + Lookup a named level from the map + + the name of the level to lookup is taken from this level. + If the level is not set on the map then this level is added + the level in the map with the name specified + + + Lookup a named level from the map. The name of the level to lookup is taken + from the property of the + argument. + + + If no level with the specified name is found then the + argument is added to the level map + and returned. + + + + + + The internal representation of caller location information. + + + + This class uses the System.Diagnostics.StackTrace class to generate + a call stack. The caller's information is then extracted from this stack. + + + The System.Diagnostics.StackTrace class is not supported on the + .NET Compact Framework 1.0 therefore caller location information is not + available on that framework. + + + The System.Diagnostics.StackTrace class has this to say about Release builds: + + + "StackTrace information will be most informative with Debug build configurations. + By default, Debug builds include debug symbols, while Release builds do not. The + debug symbols contain most of the file, method name, line number, and column + information used in constructing StackFrame and StackTrace objects. StackTrace + might not report as many method calls as expected, due to code transformations + that occur during optimization." + + + This means that in a Release build the caller information may be incomplete or may + not exist at all! Therefore caller location information cannot be relied upon in a Release build. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + The declaring type of the method that is + the stack boundary into the logging system for this call. + + + Initializes a new instance of the + class based on the current thread. + + + + + + Constructor + + The fully qualified class name. + The method name. + The file name. + The line number of the method within the file. + + + Initializes a new instance of the + class with the specified data. + + + + + + Gets the fully qualified class name of the caller making the logging + request. + + + The fully qualified class name of the caller making the logging + request. + + + + Gets the fully qualified class name of the caller making the logging + request. + + + + + + Gets the file name of the caller. + + + The file name of the caller. + + + + Gets the file name of the caller. + + + + + + Gets the line number of the caller. + + + The line number of the caller. + + + + Gets the line number of the caller. + + + + + + Gets the method name of the caller. + + + The method name of the caller. + + + + Gets the method name of the caller. + + + + + + Gets all available caller information + + + All available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + Gets all available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + + + Gets the stack frames from the stack trace of the caller making the log request + + + + + The fully qualified type of the LocationInfo class. + + + Used by the internal logger to record the Type of the + log message. + + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + Exception base type for log4net. + + + + This type extends . It + does not add any new functionality but does differentiate the + type of exception being thrown. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Constructor + + A message to include with the exception. + + + Initializes a new instance of the class with + the specified message. + + + + + + Constructor + + A message to include with the exception. + A nested exception to include. + + + Initializes a new instance of the class + with the specified message and inner exception. + + + + + + Serialization constructor + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + + + Initializes a new instance of the class + with serialized data. + + + + + + Static manager that controls the creation of repositories + + + + Static manager that controls the creation of repositories + + + This class is used by the wrapper managers (e.g. ) + to provide access to the objects. + + + This manager also holds the that is used to + lookup and create repositories. The selector can be set either programmatically using + the property, or by setting the log4net.RepositorySelector + AppSetting in the applications config file to the fully qualified type name of the + selector to use. + + + Nicko Cadell + Gert Driesen + + + + Private constructor to prevent instances. Only static methods should be used. + + + + Private constructor to prevent instances. Only static methods should be used. + + + + + + Hook the shutdown event + + + + On the full .NET runtime, the static constructor hooks up the + AppDomain.ProcessExit and AppDomain.DomainUnload> events. + These are used to shutdown the log4net system as the application exits. + + + + + + Register for ProcessExit and DomainUnload events on the AppDomain + + + + This needs to be in a separate method because the events make + a LinkDemand for the ControlAppDomain SecurityPermission. Because + this is a LinkDemand it is demanded at JIT time. Therefore we cannot + catch the exception in the method itself, we have to catch it in the + caller. + + + + + + Return the default instance. + + the repository to lookup in + Return the default instance + + + Gets the for the repository specified + by the argument. + + + + + + Returns the default instance. + + The assembly to use to lookup the repository. + The default instance. + + + + Return the default instance. + + the repository to lookup in + Return the default instance + + + Gets the for the repository specified + by the argument. + + + + + + Returns the default instance. + + The assembly to use to lookup the repository. + The default instance. + + + Returns the default instance. + + + + + + Returns the named logger if it exists. + + The repository to lookup in. + The fully qualified logger name to look for. + + The logger found, or null if the named logger does not exist in the + specified repository. + + + + If the named logger exists (in the specified repository) then it + returns a reference to the logger, otherwise it returns + null. + + + + + + Returns the named logger if it exists. + + The assembly to use to lookup the repository. + The fully qualified logger name to look for. + + The logger found, or null if the named logger does not exist in the + specified assembly's repository. + + + + If the named logger exists (in the specified assembly's repository) then it + returns a reference to the logger, otherwise it returns + null. + + + + + + Returns all the currently defined loggers in the specified repository. + + The repository to lookup in. + All the defined loggers. + + + The root logger is not included in the returned array. + + + + + + Returns all the currently defined loggers in the specified assembly's repository. + + The assembly to use to lookup the repository. + All the defined loggers. + + + The root logger is not included in the returned array. + + + + + + Retrieves or creates a named logger. + + The repository to lookup in. + The name of the logger to retrieve. + The logger with the name specified. + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + + + + Retrieves or creates a named logger. + + The assembly to use to lookup the repository. + The name of the logger to retrieve. + The logger with the name specified. + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + + + + Shorthand for . + + The repository to lookup in. + The of which the fullname will be used as the name of the logger to retrieve. + The logger with the name specified. + + + Gets the logger for the fully qualified name of the type specified. + + + + + + Shorthand for . + + the assembly to use to lookup the repository + The of which the fullname will be used as the name of the logger to retrieve. + The logger with the name specified. + + + Gets the logger for the fully qualified name of the type specified. + + + + + + Shuts down the log4net system. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in all the + default repositories. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Shuts down the repository for the repository specified. + + The repository to shutdown. + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository for the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Shuts down the repository for the repository specified. + + The assembly to use to lookup the repository. + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository for the repository. The repository is looked up using + the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Resets all values contained in this repository instance to their defaults. + + The repository to reset. + + + Resets all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set its default "off" value. + + + + + + Resets all values contained in this repository instance to their defaults. + + The assembly to use to lookup the repository to reset. + + + Resets all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set its default "off" value. + + + + + + Creates a repository with the specified name. + + The name of the repository, this must be unique amongst repositories. + The created for the repository. + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + Creates the default type of which is a + object. + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The specified repository already exists. + + + + Creates a repository with the specified name. + + The name of the repository, this must be unique amongst repositories. + The created for the repository. + + + Creates the default type of which is a + object. + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The specified repository already exists. + + + + Creates a repository with the specified name and repository type. + + The name of the repository, this must be unique to the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + The name must be unique. Repositories cannot be redefined. + An Exception will be thrown if the repository already exists. + + + The specified repository already exists. + + + + Creates a repository with the specified name and repository type. + + The name of the repository, this must be unique to the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + The name must be unique. Repositories cannot be redefined. + An Exception will be thrown if the repository already exists. + + + The specified repository already exists. + + + + Creates a repository for the specified assembly and repository type. + + The assembly to use to get the name of the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + + + + Creates a repository for the specified assembly and repository type. + + The assembly to use to get the name of the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + + + + Gets an array of all currently defined repositories. + + An array of all the known objects. + + + Gets an array of all currently defined repositories. + + + + + + Gets or sets the repository selector used by the . + + + The repository selector used by the . + + + + The repository selector () is used by + the to create and select repositories + (). + + + The caller to supplies either a string name + or an assembly (if not supplied the assembly is inferred using + ). + + + This context is used by the selector to lookup a specific repository. + + + For the full .NET Framework, the default repository is DefaultRepositorySelector; + for the .NET Compact Framework CompactRepositorySelector is the default + repository. + + + + + + Internal method to get pertinent version info. + + A string of version info. + + + + Called when the event fires + + the that is exiting + null + + + Called when the event fires. + + + When the event is triggered the log4net system is . + + + + + + Called when the event fires + + the that is exiting + null + + + Called when the event fires. + + + When the event is triggered the log4net system is . + + + + + + The fully qualified type of the LoggerManager class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Initialize the default repository selector + + + + + Implementation of the interface. + + + + This class should be used as the base for all wrapper implementations. + + + Nicko Cadell + Gert Driesen + + + + Constructs a new wrapper for the specified logger. + + The logger to wrap. + + + Constructs a new wrapper for the specified logger. + + + + + + Gets the implementation behind this wrapper object. + + + The object that this object is implementing. + + + + The Logger object may not be the same object as this object + because of logger decorators. + + + This gets the actual underlying objects that is used to process + the log events. + + + + + + The logger that this object is wrapping + + + + + Portable data structure used by + + + + Portable data structure used by + + + Nicko Cadell + + + + The logger name. + + + + The logger name. + + + + + + Level of logging event. + + + + Level of logging event. Level cannot be Serializable + because it is a flyweight. Due to its special serialization it + cannot be declared final either. + + + + + + The application supplied message. + + + + The application supplied message of logging event. + + + + + + The name of thread + + + + The name of thread in which this logging event was generated + + + + + + Gets or sets the local time the event was logged + + + + Prefer using the setter, since local time can be ambiguous. + + + + + + Gets or sets the UTC time the event was logged + + + + The TimeStamp is stored in the UTC time zone. + + + + + + Location information for the caller. + + + + Location information for the caller. + + + + + + String representation of the user + + + + String representation of the user's windows name, + like DOMAIN\username + + + + + + String representation of the identity. + + + + String representation of the current thread's principal identity. + + + + + + The string representation of the exception + + + + The string representation of the exception + + + + + + String representation of the AppDomain. + + + + String representation of the AppDomain. + + + + + + Additional event specific properties + + + + A logger or an appender may attach additional + properties to specific events. These properties + have a string key and an object value. + + + + + + Flags passed to the property + + + + Flags passed to the property + + + Nicko Cadell + + + + Fix the MDC + + + + + Fix the NDC + + + + + Fix the rendered message + + + + + Fix the thread name + + + + + Fix the callers location information + + + CAUTION: Very slow to generate + + + + + Fix the callers windows user name + + + CAUTION: Slow to generate + + + + + Fix the domain friendly name + + + + + Fix the callers principal name + + + CAUTION: May be slow to generate + + + + + Fix the exception text + + + + + Fix the event properties. Active properties must implement in order to be eligible for fixing. + + + + + No fields fixed + + + + + All fields fixed + + + + + Partial fields fixed + + + + This set of partial fields gives good performance. The following fields are fixed: + + + + + + + + + + + + + The internal representation of logging events. + + + + When an affirmative decision is made to log then a + instance is created. This instance + is passed around to the different log4net components. + + + This class is of concern to those wishing to extend log4net. + + + Some of the values in instances of + are considered volatile, that is the values are correct at the + time the event is delivered to appenders, but will not be consistent + at any time afterwards. If an event is to be stored and then processed + at a later time these volatile values must be fixed by calling + . There is a performance penalty + for incurred by calling but it + is essential to maintaining data consistency. + + + Nicko Cadell + Gert Driesen + Douglas de la Torre + Daniel Cazzulino + + + + Initializes a new instance of the class + from the supplied parameters. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The repository this event is logged in. + The name of the logger of this event. + The level of this event. + The message of this event. + The exception for this event. + + + Except , and , + all fields of LoggingEvent are filled when actually needed. Call + to cache all data locally + to prevent inconsistencies. + + This method is called by the log4net framework + to create a logging event. + + + + + + Initializes a new instance of the class + using specific data. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The repository this event is logged in. + Data used to initialize the logging event. + The fields in the struct that have already been fixed. + + + This constructor is provided to allow a + to be created independently of the log4net framework. This can + be useful if you require a custom serialization scheme. + + + Use the method to obtain an + instance of the class. + + + The parameter should be used to specify which fields in the + struct have been preset. Fields not specified in the + will be captured from the environment if requested or fixed. + + + + + + Initializes a new instance of the class + using specific data. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The repository this event is logged in. + Data used to initialize the logging event. + + + This constructor is provided to allow a + to be created independently of the log4net framework. This can + be useful if you require a custom serialization scheme. + + + Use the method to obtain an + instance of the class. + + + This constructor sets this objects flags to , + this assumes that all the data relating to this event is passed in via the + parameter and no other data should be captured from the environment. + + + + + + Initializes a new instance of the class + using specific data. + + Data used to initialize the logging event. + + + This constructor is provided to allow a + to be created independently of the log4net framework. This can + be useful if you require a custom serialization scheme. + + + Use the method to obtain an + instance of the class. + + + This constructor sets this objects flags to , + this assumes that all the data relating to this event is passed in via the + parameter and no other data should be captured from the environment. + + + + + + Serialization constructor + + The that holds the serialized object data. + The that contains contextual information about the source or destination. + + + Initializes a new instance of the class + with serialized data. + + + + + + Gets the time when the current process started. + + + This is the time when this process started. + + + + The TimeStamp is stored internally in UTC and converted to the local time zone for this computer. + + + Tries to get the start time for the current process. + Failing that it returns the time of the first call to + this property. + + + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating and therefore + without the process start time being reset. + + + + + + Gets the UTC time when the current process started. + + + This is the UTC time when this process started. + + + + Tries to get the start time for the current process. + Failing that it returns the time of the first call to + this property. + + + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating and therefore + without the process start time being reset. + + + + + + Gets the of the logging event. + + + The of the logging event. + + + + Gets the of the logging event. + + + + + + Gets the time of the logging event. + + + The time of the logging event. + + + + The TimeStamp is stored in UTC and converted to the local time zone for this computer. + + + + + + Gets UTC the time of the logging event. + + + The UTC time of the logging event. + + + + + Gets the name of the logger that logged the event. + + + The name of the logger that logged the event. + + + + Gets the name of the logger that logged the event. + + + + + + Gets the location information for this logging event. + + + The location information for this logging event. + + + + The collected information is cached for future use. + + + See the class for more information on + supported frameworks and the different behavior in Debug and + Release builds. + + + + + + Gets the message object used to initialize this event. + + + The message object used to initialize this event. + + + + Gets the message object used to initialize this event. + Note that this event may not have a valid message object. + If the event is serialized the message object will not + be transferred. To get the text of the message the + property must be used + not this property. + + + If there is no defined message object for this event then + null will be returned. + + + + + + Gets the exception object used to initialize this event. + + + The exception object used to initialize this event. + + + + Gets the exception object used to initialize this event. + Note that this event may not have a valid exception object. + If the event is serialized the exception object will not + be transferred. To get the text of the exception the + method must be used + not this property. + + + If there is no defined exception object for this event then + null will be returned. + + + + + + The that this event was created in. + + + + The that this event was created in. + + + + + + Ensure that the repository is set. + + the value for the repository + + + + Gets the message, rendered through the . + + + The message rendered through the . + + + + The collected information is cached for future use. + + + + + + Write the rendered message to a TextWriter + + the writer to write the message to + + + Unlike the property this method + does store the message data in the internal cache. Therefore + if called only once this method should be faster than the + property, however if the message is + to be accessed multiple times then the property will be more efficient. + + + + + + Gets the name of the current thread. + + + The name of the current thread, or the thread ID when + the name is not available. + + + + The collected information is cached for future use. + + + + + + Gets the name of the current user. + + + The name of the current user, or NOT AVAILABLE when the + underlying runtime has no support for retrieving the name of the + current user. + + + + Calls WindowsIdentity.GetCurrent().Name to get the name of + the current windows user. + + + To improve performance, we could cache the string representation of + the name, and reuse that as long as the identity stayed constant. + Once the identity changed, we would need to re-assign and re-render + the string. + + + However, the WindowsIdentity.GetCurrent() call seems to + return different objects every time, so the current implementation + doesn't do this type of caching. + + + Timing for these operations: + + + + Method + Results + + + WindowsIdentity.GetCurrent() + 10000 loops, 00:00:00.2031250 seconds + + + WindowsIdentity.GetCurrent().Name + 10000 loops, 00:00:08.0468750 seconds + + + + This means we could speed things up almost 40 times by caching the + value of the WindowsIdentity.GetCurrent().Name property, since + this takes (8.04-0.20) = 7.84375 seconds. + + + + + + Gets the identity of the current thread principal. + + + The string name of the identity of the current thread principal. + + + + Calls System.Threading.Thread.CurrentPrincipal.Identity.Name to get + the name of the current thread principal. + + + + + + Gets the AppDomain friendly name. + + + The AppDomain friendly name. + + + + Gets the AppDomain friendly name. + + + + + + Additional event specific properties. + + + Additional event specific properties. + + + + A logger or an appender may attach additional + properties to specific events. These properties + have a string key and an object value. + + + This property is for events that have been added directly to + this event. The aggregate properties (which include these + event properties) can be retrieved using + and . + + + Once the properties have been fixed this property + returns the combined cached properties. This ensures that updates to + this property are always reflected in the underlying storage. When + returning the combined properties there may be more keys in the + Dictionary than expected. + + + + + + The fixed fields in this event + + + The set of fields that are fixed in this event + + + + Fields will not be fixed if they have previously been fixed. + It is not possible to 'unfix' a field. + + + + + + Serializes this object into the provided. + + The to populate with data. + The destination for this serialization. + + + The data in this event must be fixed before it can be serialized. + + + The method must be called during the + method call if this event + is to be used outside that method. + + + + + + Gets the portable data for this . + + The for this event. + + + A new can be constructed using a + instance. + + + Does a fix of the data + in the logging event before returning the event data. + + + + + + Gets the portable data for this . + + The set of data to ensure is fixed in the LoggingEventData + The for this event. + + + A new can be constructed using a + instance. + + + + + + Returns this event's exception's rendered using the + . + + + This event's exception's rendered using the . + + + + Obsolete. Use instead. + + + + + + Returns this event's exception's rendered using the + . + + + This event's exception's rendered using the . + + + + Returns this event's exception's rendered using the + . + + + + + + Fix instance fields that hold volatile data. + + + + Some of the values in instances of + are considered volatile, that is the values are correct at the + time the event is delivered to appenders, but will not be consistent + at any time afterwards. If an event is to be stored and then processed + at a later time these volatile values must be fixed by calling + . There is a performance penalty + incurred by calling but it + is essential to maintaining data consistency. + + + Calling is equivalent to + calling passing the parameter + false. + + + See for more + information. + + + + + + Fixes instance fields that hold volatile data. + + Set to true to not fix data that takes a long time to fix. + + + Some of the values in instances of + are considered volatile, that is the values are correct at the + time the event is delivered to appenders, but will not be consistent + at any time afterwards. If an event is to be stored and then processed + at a later time these volatile values must be fixed by calling + . There is a performance penalty + for incurred by calling but it + is essential to maintaining data consistency. + + + The param controls the data that + is fixed. Some of the data that can be fixed takes a long time to + generate, therefore if you do not require those settings to be fixed + they can be ignored by setting the param + to true. This setting will ignore the + and settings. + + + Set to false to ensure that all + settings are fixed. + + + + + + Fix the fields specified by the parameter + + the fields to fix + + + Only fields specified in the will be fixed. + Fields will not be fixed if they have previously been fixed. + It is not possible to 'unfix' a field. + + + + + + Lookup a composite property in this event + + the key for the property to lookup + the value for the property + + + This event has composite properties that combine together properties from + several different contexts in the following order: + + + this events properties + + This event has that can be set. These + properties are specific to this event only. + + + + the thread properties + + The that are set on the current + thread. These properties are shared by all events logged on this thread. + + + + the global properties + + The that are set globally. These + properties are shared by all the threads in the AppDomain. + + + + + + + + + Get all the composite properties in this event + + the containing all the properties + + + See for details of the composite properties + stored by the event. + + + This method returns a single containing all the + properties defined for this event. + + + + + + The internal logging event data. + + + + + The internal logging event data. + + + + + The internal logging event data. + + + + + The fully qualified Type of the calling + logger class in the stack frame (i.e. the declaring type of the method). + + + + + The application supplied message of logging event. + + + + + The exception that was thrown. + + + This is not serialized. The string representation + is serialized instead. + + + + + The repository that generated the logging event + + + This is not serialized. + + + + + The fix state for this event + + + These flags indicate which fields have been fixed. + Not serialized. + + + + + Indicated that the internal cache is updateable (ie not fixed) + + + This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler + changes in the caching strategy. + + + + + The key into the Properties map for the host name value. + + + + + The key into the Properties map for the thread identity value. + + + + + The key into the Properties map for the user name value. + + + + + Implementation of wrapper interface. + + + + This implementation of the interface + forwards to the held by the base class. + + + This logger has methods to allow the caller to log at the following + levels: + + + + DEBUG + + The and methods log messages + at the DEBUG level. That is the level with that name defined in the + repositories . The default value + for this level is . The + property tests if this level is enabled for logging. + + + + INFO + + The and methods log messages + at the INFO level. That is the level with that name defined in the + repositories . The default value + for this level is . The + property tests if this level is enabled for logging. + + + + WARN + + The and methods log messages + at the WARN level. That is the level with that name defined in the + repositories . The default value + for this level is . The + property tests if this level is enabled for logging. + + + + ERROR + + The and methods log messages + at the ERROR level. That is the level with that name defined in the + repositories . The default value + for this level is . The + property tests if this level is enabled for logging. + + + + FATAL + + The and methods log messages + at the FATAL level. That is the level with that name defined in the + repositories . The default value + for this level is . The + property tests if this level is enabled for logging. + + + + + The values for these levels and their semantic meanings can be changed by + configuring the for the repository. + + + Nicko Cadell + Gert Driesen + + + + Construct a new wrapper for the specified logger. + + The logger to wrap. + + + Construct a new wrapper for the specified logger. + + + + + + Virtual method called when the configuration of the repository changes + + the repository holding the levels + + + Virtual method called when the configuration of the repository changes + + + + + + Logs a message object with the DEBUG level. + + The message object to log. + + + This method first checks if this logger is DEBUG + enabled by comparing the level of this logger with the + DEBUG level. If this logger is + DEBUG enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + Logs a message object with the DEBUG level + + The message object to log. + The exception to log, including its stack trace. + + + Logs a message object with the DEBUG level including + the stack trace of the passed + as a parameter. + + + See the form for more detailed information. + + + + + + + Logs a formatted message string with the DEBUG level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the DEBUG level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the DEBUG level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the DEBUG level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the DEBUG level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a message object with the INFO level. + + The message object to log. + + + This method first checks if this logger is INFO + enabled by comparing the level of this logger with the + INFO level. If this logger is + INFO enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + Logs a message object with the INFO level. + + The message object to log. + The exception to log, including its stack trace. + + + Logs a message object with the INFO level including + the stack trace of the + passed as a parameter. + + + See the form for more detailed information. + + + + + + + Logs a formatted message string with the INFO level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the INFO level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the INFO level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the INFO level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the INFO level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a message object with the WARN level. + + the message object to log + + + This method first checks if this logger is WARN + enabled by comparing the level of this logger with the + WARN level. If this logger is + WARN enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger and + also higher in the hierarchy depending on the value of the + additivity flag. + + + WARNING Note that passing an to this + method will print the name of the but no + stack trace. To print a stack trace use the + form instead. + + + + + + Logs a message object with the WARN level + + The message object to log. + The exception to log, including its stack trace. + + + Logs a message object with the WARN level including + the stack trace of the + passed as a parameter. + + + See the form for more detailed information. + + + + + + + Logs a formatted message string with the WARN level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the WARN level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the WARN level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the WARN level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the WARN level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a message object with the ERROR level. + + The message object to log. + + + This method first checks if this logger is ERROR + enabled by comparing the level of this logger with the + ERROR level. If this logger is + ERROR enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger and + also higher in the hierarchy depending on the value of the + additivity flag. + + + WARNING Note that passing an to this + method will print the name of the but no + stack trace. To print a stack trace use the + form instead. + + + + + + Logs a message object with the ERROR level + + The message object to log. + The exception to log, including its stack trace. + + + Logs a message object with the ERROR level including + the stack trace of the + passed as a parameter. + + + See the form for more detailed information. + + + + + + + Logs a formatted message string with the ERROR level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the ERROR level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the ERROR level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the ERROR level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the ERROR level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a message object with the FATAL level. + + The message object to log. + + + This method first checks if this logger is FATAL + enabled by comparing the level of this logger with the + FATAL level. If this logger is + FATAL enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger and + also higher in the hierarchy depending on the value of the + additivity flag. + + + WARNING Note that passing an to this + method will print the name of the but no + stack trace. To print a stack trace use the + form instead. + + + + + + Logs a message object with the FATAL level + + The message object to log. + The exception to log, including its stack trace. + + + Logs a message object with the FATAL level including + the stack trace of the + passed as a parameter. + + + See the form for more detailed information. + + + + + + + Logs a formatted message string with the FATAL level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the FATAL level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the FATAL level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the FATAL level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the FATAL level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Checks if this logger is enabled for the DEBUG + level. + + + true if this logger is enabled for DEBUG events, + false otherwise. + + + + This function is intended to lessen the computational cost of + disabled log debug statements. + + + For some log Logger object, when you write: + + + log.Debug("This is entry number: " + i ); + + + You incur the cost constructing the message, concatenation in + this case, regardless of whether the message is logged or not. + + + If you are worried about speed, then you should write: + + + if (log.IsDebugEnabled()) + { + log.Debug("This is entry number: " + i ); + } + + + This way you will not incur the cost of parameter + construction if debugging is disabled for log. On + the other hand, if the log is debug enabled, you + will incur the cost of evaluating whether the logger is debug + enabled twice. Once in IsDebugEnabled and once in + the Debug. This is an insignificant overhead + since evaluating a logger takes about 1% of the time it + takes to actually log. + + + + + + Checks if this logger is enabled for the INFO level. + + + true if this logger is enabled for INFO events, + false otherwise. + + + + See for more information and examples + of using this method. + + + + + + + Checks if this logger is enabled for the WARN level. + + + true if this logger is enabled for WARN events, + false otherwise. + + + + See for more information and examples + of using this method. + + + + + + + Checks if this logger is enabled for the ERROR level. + + + true if this logger is enabled for ERROR events, + false otherwise. + + + + See for more information and examples of using this method. + + + + + + + Checks if this logger is enabled for the FATAL level. + + + true if this logger is enabled for FATAL events, + false otherwise. + + + + See for more information and examples of using this method. + + + + + + + Event handler for the event + + the repository + Empty + + + + The fully qualified name of this declaring type not the type of any subclass. + + + + + provides method information without actually referencing a System.Reflection.MethodBase + as that would require that the containing assembly is loaded. + + + + + + constructs a method item for an unknown method. + + + + + constructs a method item from the name of the method. + + + + + + constructs a method item from the name of the method and its parameters. + + + + + + + constructs a method item from a method base by determining the method name and its parameters. + + + + + + Gets the method name of the caller making the logging + request. + + + The method name of the caller making the logging + request. + + + + Gets the method name of the caller making the logging + request. + + + + + + Gets the method parameters of the caller making + the logging request. + + + The method parameters of the caller making + the logging request + + + + Gets the method parameters of the caller making + the logging request. + + + + + + The fully qualified type of the StackFrameItem class. + + + Used by the internal logger to record the Type of the + log message. + + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + A SecurityContext used by log4net when interacting with protected resources + + + + A SecurityContext used by log4net when interacting with protected resources + for example with operating system services. This can be used to impersonate + a principal that has been granted privileges on the system resources. + + + Nicko Cadell + + + + Impersonate this SecurityContext + + State supplied by the caller + An instance that will + revoke the impersonation of this SecurityContext, or null + + + Impersonate this security context. Further calls on the current + thread should now be made in the security context provided + by this object. When the result + method is called the security + context of the thread should be reverted to the state it was in + before was called. + + + + + + The providers default instances. + + + + A configured component that interacts with potentially protected system + resources uses a to provide the elevated + privileges required. If the object has + been not been explicitly provided to the component then the component + will request one from this . + + + By default the is + an instance of which returns only + objects. This is a reasonable default + where the privileges required are not know by the system. + + + This default behavior can be overridden by subclassing the + and overriding the method to return + the desired objects. The default provider + can be replaced by programmatically setting the value of the + property. + + + An alternative is to use the log4net.Config.SecurityContextProviderAttribute + This attribute can be applied to an assembly in the same way as the + log4net.Config.XmlConfiguratorAttribute". The attribute takes + the type to use as the as an argument. + + + Nicko Cadell + + + + The default provider + + + + + Gets or sets the default SecurityContextProvider + + + The default SecurityContextProvider + + + + The default provider is used by configured components that + require a and have not had one + given to them. + + + By default this is an instance of + that returns objects. + + + The default provider can be set programmatically by setting + the value of this property to a sub class of + that has the desired behavior. + + + + + + Protected default constructor to allow subclassing + + + + Protected default constructor to allow subclassing + + + + + + Create a SecurityContext for a consumer + + The consumer requesting the SecurityContext + An impersonation context + + + The default implementation is to return a . + + + Subclasses should override this method to provide their own + behavior. + + + + + + provides stack frame information without actually referencing a System.Diagnostics.StackFrame + as that would require that the containing assembly is loaded. + + + + + + returns a stack frame item from a stack frame. This + + + + + + + Gets the fully qualified class name of the caller making the logging + request. + + + The fully qualified class name of the caller making the logging + request. + + + + Gets the fully qualified class name of the caller making the logging + request. + + + + + + Gets the file name of the caller. + + + The file name of the caller. + + + + Gets the file name of the caller. + + + + + + Gets the line number of the caller. + + + The line number of the caller. + + + + Gets the line number of the caller. + + + + + + Gets the method name of the caller. + + + The method name of the caller. + + + + Gets the method name of the caller. + + + + + + Gets all available caller information + + + All available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + Gets all available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + + + The fully qualified type of the StackFrameItem class. + + + Used by the internal logger to record the Type of the + log message. + + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + An evaluator that triggers after specified number of seconds. + + + + This evaluator will trigger if the specified time period + has passed since last check. + + + Robert Sevcik + + + + The time threshold for triggering in seconds. Zero means it won't trigger at all. + + + + + The UTC time of last check. This gets updated when the object is created and when the evaluator triggers. + + + + + The default time threshold for triggering in seconds. Zero means it won't trigger at all. + + + + + Create a new evaluator using the time threshold in seconds. + + + + Create a new evaluator using the time threshold in seconds. + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Create a new evaluator using the specified time threshold in seconds. + + + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + + + + Create a new evaluator using the specified time threshold in seconds. + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + The time threshold in seconds to trigger after + + + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Is this the triggering event? + + The event to check + This method returns true, if the specified time period + has passed since last check.. + Otherwise it returns false + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Delegate used to handle creation of new wrappers. + + The logger to wrap in a wrapper. + + + Delegate used to handle creation of new wrappers. This delegate + is called from the + method to construct the wrapper for the specified logger. + + + The delegate to use is supplied to the + constructor. + + + + + + Maps between logger objects and wrapper objects. + + + + This class maintains a mapping between objects and + objects. Use the method to + lookup the for the specified . + + + New wrapper instances are created by the + method. The default behavior is for this method to delegate construction + of the wrapper to the delegate supplied + to the constructor. This allows specialization of the behavior without + requiring subclassing of this type. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the + + The handler to use to create the wrapper objects. + + + Initializes a new instance of the class with + the specified handler to create the wrapper objects. + + + + + + Gets the wrapper object for the specified logger. + + The wrapper object for the specified logger + + + If the logger is null then the corresponding wrapper is null. + + + Looks up the wrapper it it has previously been requested and + returns it. If the wrapper has never been requested before then + the virtual method is + called. + + + + + + Gets the map of logger repositories. + + + Map of logger repositories. + + + + Gets the hashtable that is keyed on . The + values are hashtables keyed on with the + value being the corresponding . + + + + + + Creates the wrapper object for the specified logger. + + The logger to wrap in a wrapper. + The wrapper object for the logger. + + + This implementation uses the + passed to the constructor to create the wrapper. This method + can be overridden in a subclass. + + + + + + Called when a monitored repository shutdown event is received. + + The that is shutting down + + + This method is called when a that this + is holding loggers for has signaled its shutdown + event . The default + behavior of this method is to release the references to the loggers + and their wrappers generated for this repository. + + + + + + Event handler for repository shutdown event. + + The sender of the event. + The event args. + + + + Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings + + + + + The handler to use to create the extension wrapper objects. + + + + + Internal reference to the delegate used to register for repository shutdown events. + + + + + Formats a as "HH:mm:ss,fff". + + + + Formats a in the format "HH:mm:ss,fff" for example, "15:49:37,459". + + + Nicko Cadell + Gert Driesen + + + + Renders the date into a string. Format is "HH:mm:ss". + + The date to render into a string. + The string builder to write to. + + + Subclasses should override this method to render the date + into a string using a precision up to the second. This method + will be called at most once per second and the result will be + reused if it is needed again during the same second. + + + + + + Renders the date into a string. Format is "HH:mm:ss,fff". + + The date to render into a string. + The writer to write to. + + + Uses the method to generate the + time string up to the seconds and then appends the current + milliseconds. The results from are + cached and is called at most once + per second. + + + Sub classes should override + rather than . + + + + + + String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is ABSOLUTE. + + + + + String constant used to specify DateTimeDateFormat in layouts. Current value is DATE. + + + + + String constant used to specify ISO8601DateFormat in layouts. Current value is ISO8601. + + + + + Last stored time with precision up to the second. + + + + + Last stored time with precision up to the second, formatted + as a string. + + + + + Last stored time with precision up to the second, formatted + as a string. + + + + + Formats a as "dd MMM yyyy HH:mm:ss,fff" + + + + Formats a in the format + "dd MMM yyyy HH:mm:ss,fff" for example, + "06 Nov 1994 15:49:37,459". + + + Nicko Cadell + Gert Driesen + Angelika Schnagl + + + + Default constructor. + + + + Initializes a new instance of the class. + + + + + + Formats the date without the milliseconds part + + The date to format. + The string builder to write to. + + + Formats a DateTime in the format "dd MMM yyyy HH:mm:ss" + for example, "06 Nov 1994 15:49:37". + + + The base class will append the ",fff" milliseconds section. + This method will only be called at most once per second. + + + + + + The format info for the invariant culture. + + + + + Render a as a string. + + + + Interface to abstract the rendering of a + instance into a string. + + + The method is used to render the + date to a text writer. + + + Nicko Cadell + Gert Driesen + + + + Formats the specified date as a string. + + The date to format. + The writer to write to. + + + Format the as a string and write it + to the provided. + + + + + + Formats the as "yyyy-MM-dd HH:mm:ss,fff". + + + + Formats the specified as a string: "yyyy-MM-dd HH:mm:ss,fff". + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Initializes a new instance of the class. + + + + + + Formats the date without the milliseconds part + + The date to format. + The string builder to write to. + + + Formats the date specified as a string: "yyyy-MM-dd HH:mm:ss". + + + The base class will append the ",fff" milliseconds section. + This method will only be called at most once per second. + + + + + + Formats the using the method. + + + + Formats the using the method. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + The format string. + + + Initializes a new instance of the class + with the specified format string. + + + The format string must be compatible with the options + that can be supplied to . + + + + + + Formats the date using . + + The date to convert to a string. + The writer to write to. + + + Uses the date format string supplied to the constructor to call + the method to format the date. + + + + + + The format string used to format the . + + + + The format string must be compatible with the options + that can be supplied to . + + + + + + This filter drops all . + + + + You can add this filter to the end of a filter chain to + switch from the default "accept all unless instructed otherwise" + filtering behavior to a "deny all unless instructed otherwise" + behavior. + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + + Always returns the integer constant + + the LoggingEvent to filter + Always returns + + + Ignores the event being logged and just returns + . This can be used to change the default filter + chain behavior from to . This filter + should only be used as the last filter in the chain + as any further filters will be ignored! + + + + + + The return result from + + + + The return result from + + + + + + The log event must be dropped immediately without + consulting with the remaining filters, if any, in the chain. + + + + + This filter is neutral with respect to the log event. + The remaining filters, if any, should be consulted for a final decision. + + + + + The log event must be logged immediately without + consulting with the remaining filters, if any, in the chain. + + + + + Subclass this type to implement customized logging event filtering + + + + Users should extend this class to implement customized logging + event filtering. Note that and + , the parent class of all standard + appenders, have built-in filtering rules. It is suggested that you + first use and understand the built-in rules before rushing to write + your own custom filters. + + + This abstract class assumes and also imposes that filters be + organized in a linear chain. The + method of each filter is called sequentially, in the order of their + addition to the chain. + + + The method must return one + of the integer constants , + or . + + + If the value is returned, then the log event is dropped + immediately without consulting with the remaining filters. + + + If the value is returned, then the next filter + in the chain is consulted. If there are no more filters in the + chain, then the log event is logged. Thus, in the presence of no + filters, the default behavior is to log all logging events. + + + If the value is returned, then the log + event is logged without consulting the remaining filters. + + + The philosophy of log4net filters is largely inspired from the + Linux ipchains. + + + Nicko Cadell + Gert Driesen + + + + Points to the next filter in the filter chain. + + + + See for more information. + + + + + + Initialize the filter with the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + Typically filter's options become active immediately on set, + however this method must still be called. + + + + + + Decide if the should be logged through an appender. + + The to decide upon + The decision of the filter + + + If the decision is , then the event will be + dropped. If the decision is , then the next + filter, if any, will be invoked. If the decision is then + the event will be logged without consulting with other filters in + the chain. + + + This method is marked abstract and must be implemented + in a subclass. + + + + + + Property to get and set the next filter + + + The next filter in the chain + + + + Filters are typically composed into chains. This property allows the next filter in + the chain to be accessed. + + + + + + Implement this interface to provide customized logging event filtering + + + + Users should implement this interface to implement customized logging + event filtering. Note that and + , the parent class of all standard + appenders, have built-in filtering rules. It is suggested that you + first use and understand the built-in rules before rushing to write + your own custom filters. + + + This abstract class assumes and also imposes that filters be + organized in a linear chain. The + method of each filter is called sequentially, in the order of their + addition to the chain. + + + The method must return one + of the integer constants , + or . + + + If the value is returned, then the log event is dropped + immediately without consulting with the remaining filters. + + + If the value is returned, then the next filter + in the chain is consulted. If there are no more filters in the + chain, then the log event is logged. Thus, in the presence of no + filters, the default behavior is to log all logging events. + + + If the value is returned, then the log + event is logged without consulting the remaining filters. + + + The philosophy of log4net filters is largely inspired from the + Linux ipchains. + + + Nicko Cadell + Gert Driesen + + + + Decide if the logging event should be logged through an appender. + + The LoggingEvent to decide upon + The decision of the filter + + + If the decision is , then the event will be + dropped. If the decision is , then the next + filter, if any, will be invoked. If the decision is then + the event will be logged without consulting with other filters in + the chain. + + + + + + Property to get and set the next filter + + + The next filter in the chain + + + + Filters are typically composed into chains. This property allows the next filter in + the chain to be accessed. + + + + + + This is a very simple filter based on matching. + + + + The filter admits two options and + . If there is an exact match between the value + of the option and the of the + , then the method returns in + case the option value is set + to true, if it is false then + is returned. If the does not match then + the result will be . + + + Nicko Cadell + Gert Driesen + + + + flag to indicate if the filter should on a match + + + + + the to match against + + + + + Default constructor + + + + + when matching + + + + The property is a flag that determines + the behavior when a matching is found. If the + flag is set to true then the filter will the + logging event, otherwise it will the event. + + + The default is true i.e. to the event. + + + + + + The that the filter will match + + + + The level that this filter will attempt to match against the + level. If a match is found then + the result depends on the value of . + + + + + + Tests if the of the logging event matches that of the filter + + the event to filter + see remarks + + + If the of the event matches the level of the + filter then the result of the function depends on the + value of . If it is true then + the function will return , it it is false then it + will return . If the does not match then + the result will be . + + + + + + This is a simple filter based on matching. + + + + The filter admits three options and + that determine the range of priorities that are matched, and + . If there is a match between the range + of priorities and the of the , then the + method returns in case the + option value is set to true, if it is false + then is returned. If there is no match, is returned. + + + Nicko Cadell + Gert Driesen + + + + Flag to indicate the behavior when matching a + + + + + the minimum value to match + + + + + the maximum value to match + + + + + Default constructor + + + + + when matching and + + + + The property is a flag that determines + the behavior when a matching is found. If the + flag is set to true then the filter will the + logging event, otherwise it will the event. + + + The default is true i.e. to the event. + + + + + + Set the minimum matched + + + + The minimum level that this filter will attempt to match against the + level. If a match is found then + the result depends on the value of . + + + + + + Sets the maximum matched + + + + The maximum level that this filter will attempt to match against the + level. If a match is found then + the result depends on the value of . + + + + + + Check if the event should be logged. + + the logging event to check + see remarks + + + If the of the logging event is outside the range + matched by this filter then + is returned. If the is matched then the value of + is checked. If it is true then + is returned, otherwise + is returned. + + + + + + Simple filter to match a string in the event's logger name. + + + + The works very similar to the . It admits two + options and . If the + of the starts + with the value of the option, then the + method returns in + case the option value is set to true, + if it is false then is returned. + + + Daniel Cazzulino + + + + Flag to indicate the behavior when we have a match + + + + + The logger name string to substring match against the event + + + + + Default constructor + + + + + when matching + + + + The property is a flag that determines + the behavior when a matching is found. If the + flag is set to true then the filter will the + logging event, otherwise it will the event. + + + The default is true i.e. to the event. + + + + + + The that the filter will match + + + + This filter will attempt to match this value against logger name in + the following way. The match will be done against the beginning of the + logger name (using ). The match is + case sensitive. If a match is found then + the result depends on the value of . + + + + + + Check if this filter should allow the event to be logged + + the event being logged + see remarks + + + The rendered message is matched against the . + If the equals the beginning of + the incoming () + then a match will have occurred. If no match occurs + this function will return + allowing other filters to check the event. If a match occurs then + the value of is checked. If it is + true then is returned otherwise + is returned. + + + + + + Simple filter to match a keyed string in the + + + + Simple filter to match a keyed string in the + + + As the MDC has been replaced with layered properties the + should be used instead. + + + Nicko Cadell + Gert Driesen + + + + Simple filter to match a string in the + + + + Simple filter to match a string in the + + + As the MDC has been replaced with named stacks stored in the + properties collections the should + be used instead. + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Sets the to "NDC". + + + + + + Simple filter to match a string an event property + + + + Simple filter to match a string in the value for a + specific event property + + + Nicko Cadell + + + + The key to use to lookup the string from the event properties + + + + + Default constructor + + + + + The key to lookup in the event properties and then match against. + + + + The key name to use to lookup in the properties map of the + . The match will be performed against + the value of this property if it exists. + + + + + + Check if this filter should allow the event to be logged + + the event being logged + see remarks + + + The event property for the is matched against + the . + If the occurs as a substring within + the property value then a match will have occurred. If no match occurs + this function will return + allowing other filters to check the event. If a match occurs then + the value of is checked. If it is + true then is returned otherwise + is returned. + + + + + + Simple filter to match a string in the rendered message + + + + Simple filter to match a string in the rendered message + + + Nicko Cadell + Gert Driesen + + + + Flag to indicate the behavior when we have a match + + + + + The string to substring match against the message + + + + + A string regex to match + + + + + A regex object to match (generated from m_stringRegexToMatch) + + + + + Default constructor + + + + + Initialize and precompile the Regex if required + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + when matching or + + + + The property is a flag that determines + the behavior when a matching is found. If the + flag is set to true then the filter will the + logging event, otherwise it will the event. + + + The default is true i.e. to the event. + + + + + + Sets the static string to match + + + + The string that will be substring matched against + the rendered message. If the message contains this + string then the filter will match. If a match is found then + the result depends on the value of . + + + One of or + must be specified. + + + + + + Sets the regular expression to match + + + + The regular expression pattern that will be matched against + the rendered message. If the message matches this + pattern then the filter will match. If a match is found then + the result depends on the value of . + + + One of or + must be specified. + + + + + + Check if this filter should allow the event to be logged + + the event being logged + see remarks + + + The rendered message is matched against the . + If the occurs as a substring within + the message then a match will have occurred. If no match occurs + this function will return + allowing other filters to check the event. If a match occurs then + the value of is checked. If it is + true then is returned otherwise + is returned. + + + + + + The log4net Global Context. + + + + The GlobalContext provides a location for global debugging + information to be stored. + + + The global context has a properties map and these properties can + be included in the output of log messages. The + supports selecting and outputing these properties. + + + By default the log4net:HostName property is set to the name of + the current machine. + + + + + GlobalContext.Properties["hostname"] = Environment.MachineName; + + + + Nicko Cadell + + + + Private Constructor. + + + Uses a private access modifier to prevent instantiation of this class. + + + + + The global properties map. + + + The global properties map. + + + + The global properties map. + + + + + + The global context properties instance + + + + + The ILog interface is use by application to log messages into + the log4net framework. + + + + Use the to obtain logger instances + that implement this interface. The + static method is used to get logger instances. + + + This class contains methods for logging at different levels and also + has properties for determining if those logging levels are + enabled in the current configuration. + + + This interface can be implemented in different ways. This documentation + specifies reasonable behavior that a caller can expect from the actual + implementation, however different implementations reserve the right to + do things differently. + + + Simple example of logging messages + + ILog log = LogManager.GetLogger("application-log"); + + log.Info("Application Start"); + log.Debug("This is a debug message"); + + if (log.IsDebugEnabled) + { + log.Debug("This is another debug message"); + } + + + + + Nicko Cadell + Gert Driesen + + + Log a message object with the level. + + Log a message object with the level. + + The message object to log. + + + This method first checks if this logger is DEBUG + enabled by comparing the level of this logger with the + level. If this logger is + DEBUG enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a formatted string with the level. + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + Log a message object with the level. + + Logs a message object with the level. + + + + This method first checks if this logger is INFO + enabled by comparing the level of this logger with the + level. If this logger is + INFO enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + The message object to log. + + + + + + Logs a message object with the INFO level including + the stack trace of the passed + as a parameter. + + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a formatted message string with the level. + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + Log a message object with the level. + + Log a message object with the level. + + + + This method first checks if this logger is WARN + enabled by comparing the level of this logger with the + level. If this logger is + WARN enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + The message object to log. + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a formatted message string with the level. + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + Log a message object with the level. + + Logs a message object with the level. + + The message object to log. + + + This method first checks if this logger is ERROR + enabled by comparing the level of this logger with the + level. If this logger is + ERROR enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a formatted message string with the level. + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + Log a message object with the level. + + Log a message object with the level. + + + + This method first checks if this logger is FATAL + enabled by comparing the level of this logger with the + level. If this logger is + FATAL enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + The message object to log. + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a formatted message string with the level. + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Checks if this logger is enabled for the level. + + + true if this logger is enabled for events, false otherwise. + + + + This function is intended to lessen the computational cost of + disabled log debug statements. + + For some ILog interface log, when you write: + + log.Debug("This is entry number: " + i ); + + + You incur the cost constructing the message, string construction and concatenation in + this case, regardless of whether the message is logged or not. + + + If you are worried about speed (who isn't), then you should write: + + + if (log.IsDebugEnabled) + { + log.Debug("This is entry number: " + i ); + } + + + This way you will not incur the cost of parameter + construction if debugging is disabled for log. On + the other hand, if the log is debug enabled, you + will incur the cost of evaluating whether the logger is debug + enabled twice. Once in and once in + the . This is an insignificant overhead + since evaluating a logger takes about 1% of the time it + takes to actually log. This is the preferred style of logging. + + Alternatively if your logger is available statically then the is debug + enabled state can be stored in a static variable like this: + + + private static readonly bool isDebugEnabled = log.IsDebugEnabled; + + + Then when you come to log you can write: + + + if (isDebugEnabled) + { + log.Debug("This is entry number: " + i ); + } + + + This way the debug enabled state is only queried once + when the class is loaded. Using a private static readonly + variable is the most efficient because it is a run time constant + and can be heavily optimized by the JIT compiler. + + + Of course if you use a static readonly variable to + hold the enabled state of the logger then you cannot + change the enabled state at runtime to vary the logging + that is produced. You have to decide if you need absolute + speed or runtime flexibility. + + + + + + + + Checks if this logger is enabled for the level. + + + true if this logger is enabled for events, false otherwise. + + + For more information see . + + + + + + + + Checks if this logger is enabled for the level. + + + true if this logger is enabled for events, false otherwise. + + + For more information see . + + + + + + + + Checks if this logger is enabled for the level. + + + true if this logger is enabled for events, false otherwise. + + + For more information see . + + + + + + + + Checks if this logger is enabled for the level. + + + true if this logger is enabled for events, false otherwise. + + + For more information see . + + + + + + + + A flexible layout configurable with pattern string that re-evaluates on each call. + + + This class is built on and provides all the + features and capabilities of PatternLayout. PatternLayout is a 'static' class + in that its layout is done once at configuration time. This class will recreate + the layout on each reference. + One important difference between PatternLayout and DynamicPatternLayout is the + treatment of the Header and Footer parameters in the configuration. The Header and Footer + parameters for DynamicPatternLayout must be syntactically in the form of a PatternString, + but should not be marked as type log4net.Util.PatternString. Doing so causes the + pattern to be statically converted at configuration time and causes DynamicPatternLayout + to perform the same as PatternLayout. + Please see for complete documentation. + + <layout type="log4net.Layout.DynamicPatternLayout"> + <param name="Header" value="%newline**** Trace Opened Local: %date{yyyy-MM-dd HH:mm:ss.fff} UTC: %utcdate{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + <param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + </layout> + + + + + + The header PatternString + + + + + The footer PatternString + + + + + Constructs a DynamicPatternLayout using the DefaultConversionPattern + + + + The default pattern just produces the application supplied message. + + + + + + Constructs a DynamicPatternLayout using the supplied conversion pattern + + the pattern to use + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + The pattern will be formatted on each get operation. + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + The pattern will be formatted on each get operation. + + + + + A Layout that renders only the Exception text from the logging event + + + + A Layout that renders only the Exception text from the logging event. + + + This Layout should only be used with appenders that utilize multiple + layouts (e.g. ). + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Constructs a ExceptionLayout + + + + + + Activate component options + + + + Part of the component activation + framework. + + + This method does nothing as options become effective immediately. + + + + + + Gets the exception text from the logging event + + The TextWriter to write the formatted event to + the event being logged + + + Write the exception string to the . + The exception string is retrieved from . + + + + + + Interface implemented by layout objects + + + + An object is used to format a + as text. The method is called by an + appender to transform the into a string. + + + The layout can also supply and + text that is appender before any events and after all the events respectively. + + + Nicko Cadell + Gert Driesen + + + + Implement this method to create your own layout format. + + The TextWriter to write the formatted event to + The event to format + + + This method is called by an appender to format + the as text and output to a writer. + + + If the caller does not have a and prefers the + event to be formatted as a then the following + code can be used to format the event into a . + + + StringWriter writer = new StringWriter(); + Layout.Format(writer, loggingEvent); + string formattedEvent = writer.ToString(); + + + + + + The content type output by this layout. + + The content type + + + The content type output by this layout. + + + This is a MIME type e.g. "text/plain". + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + + + + + Flag indicating if this layout handle exceptions + + false if this layout handles exceptions + + + If this layout handles the exception object contained within + , then the layout should return + false. Otherwise, if the layout ignores the exception + object, then the layout should return true. + + + + + + Interface for raw layout objects + + + + Interface used to format a + to an object. + + + This interface should not be confused with the + interface. This interface is used in + only certain specialized situations where a raw object is + required rather than a formatted string. The + is not generally useful than this interface. + + + Nicko Cadell + Gert Driesen + + + + Implement this method to create your own layout format. + + The event to format + returns the formatted event + + + Implement this method to create your own layout format. + + + + + + Adapts any to a + + + + Where an is required this adapter + allows a to be specified. + + + Nicko Cadell + Gert Driesen + + + + The layout to adapt + + + + + Construct a new adapter + + the layout to adapt + + + Create the adapter for the specified . + + + + + + Format the logging event as an object. + + The event to format + returns the formatted event + + + Format the logging event as an object. + + + Uses the object supplied to + the constructor to perform the formatting. + + + + + + Extend this abstract class to create your own log layout format. + + + + This is the base implementation of the + interface. Most layout objects should extend this class. + + + + + + Subclasses must implement the + method. + + + Subclasses should set the in their default + constructor. + + + + Nicko Cadell + Gert Driesen + + + + The header text + + + + See for more information. + + + + + + The footer text + + + + See for more information. + + + + + + Flag indicating if this layout handles exceptions + + + + false if this layout handles exceptions + + + + + + Empty default constructor + + + + Empty default constructor + + + + + + Activate component options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + This method must be implemented by the subclass. + + + + + + Implement this method to create your own layout format. + + The TextWriter to write the formatted event to + The event to format + + + This method is called by an appender to format + the as text. + + + + + + Convenience method for easily formatting the logging event into a string variable. + + + + Creates a new StringWriter instance to store the formatted logging event. + + + + + The content type output by this layout. + + The content type is "text/plain" + + + The content type output by this layout. + + + This base class uses the value "text/plain". + To change this value a subclass must override this + property. + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + + + + + Flag indicating if this layout handles exceptions + + false if this layout handles exceptions + + + If this layout handles the exception object contained within + , then the layout should return + false. Otherwise, if the layout ignores the exception + object, then the layout should return true. + + + Set this value to override a this default setting. The default + value is true, this layout does not handle the exception. + + + + + + A flexible layout configurable with pattern string. + + + + The goal of this class is to a + as a string. The results + depend on the conversion pattern. + + + The conversion pattern is closely related to the conversion + pattern of the printf function in C. A conversion pattern is + composed of literal text and format control expressions called + conversion specifiers. + + + You are free to insert any literal text within the conversion + pattern. + + + Each conversion specifier starts with a percent sign (%) and is + followed by optional format modifiers and a conversion + pattern name. The conversion pattern name specifies the type of + data, e.g. logger, level, date, thread name. The format + modifiers control such things as field width, padding, left and + right justification. The following is a simple example. + + + Let the conversion pattern be "%-5level [%thread]: %message%newline" and assume + that the log4net environment was set to use a PatternLayout. Then the + statements + + + ILog log = LogManager.GetLogger(typeof(TestApp)); + log.Debug("Message 1"); + log.Warn("Message 2"); + + would yield the output + + DEBUG [main]: Message 1 + WARN [main]: Message 2 + + + Note that there is no explicit separator between text and + conversion specifiers. The pattern parser knows when it has reached + the end of a conversion specifier when it reads a conversion + character. In the example above the conversion specifier + %-5level means the level of the logging event should be left + justified to a width of five characters. + + + The recognized conversion pattern names are: + + + + Conversion Pattern Name + Effect + + + a + Equivalent to appdomain + + + appdomain + + Used to output the friendly name of the AppDomain where the + logging event was generated. + + + + aspnet-cache + + + Used to output all cache items in the case of %aspnet-cache or just one named item if used as %aspnet-cache{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-context + + + Used to output all context items in the case of %aspnet-context or just one named item if used as %aspnet-context{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-request + + + Used to output all request parameters in the case of %aspnet-request or just one named param if used as %aspnet-request{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-session + + + Used to output all session items in the case of %aspnet-session or just one named item if used as %aspnet-session{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + c + Equivalent to logger + + + C + Equivalent to type + + + class + Equivalent to type + + + d + Equivalent to date + + + date + + + Used to output the date of the logging event in the local time zone. + To output the date in universal time use the %utcdate pattern. + The date conversion + specifier may be followed by a date format specifier enclosed + between braces. For example, %date{HH:mm:ss,fff} or + %date{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is + given then ISO8601 format is + assumed (). + + + The date format specifier admits the same syntax as the + time pattern string of the . + + + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + , + and respectively + . For example, + %date{ISO8601} or %date{ABSOLUTE}. + + + These dedicated date formatters perform significantly + better than . + + + + + exception + + + Used to output the exception passed in with the log message. + + + If an exception object is stored in the logging event + it will be rendered into the pattern output with a + trailing newline. + If there is no exception then nothing will be output + and no trailing newline will be appended. + It is typical to put a newline before the exception + and to have the exception as the last data in the pattern. + + + + + F + Equivalent to file + + + file + + + Used to output the file name where the logging request was + issued. + + + WARNING Generating caller location information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + + + See the note below on the availability of caller location information. + + + + + identity + + + Used to output the user name for the currently active user + (Principal.Identity.Name). + + + WARNING Generating caller information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + + + + + l + Equivalent to location + + + L + Equivalent to line + + + location + + + Used to output location information of the caller which generated + the logging event. + + + The location information depends on the CLI implementation but + usually consists of the fully qualified name of the calling + method followed by the callers source the file name and line + number between parentheses. + + + The location information can be very useful. However, its + generation is extremely slow. Its use should be avoided + unless execution speed is not an issue. + + + See the note below on the availability of caller location information. + + + + + level + + + Used to output the level of the logging event. + + + + + line + + + Used to output the line number from where the logging request + was issued. + + + WARNING Generating caller location information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + + + See the note below on the availability of caller location information. + + + + + logger + + + Used to output the logger of the logging event. The + logger conversion specifier can be optionally followed by + precision specifier, that is a decimal constant in + brackets. + + + If a precision specifier is given, then only the corresponding + number of right most components of the logger name will be + printed. By default the logger name is printed in full. + + + For example, for the logger name "a.b.c" the pattern + %logger{2} will output "b.c". + + + + + m + Equivalent to message + + + M + Equivalent to method + + + message + + + Used to output the application supplied message associated with + the logging event. + + + + + mdc + + + The MDC (old name for the ThreadContext.Properties) is now part of the + combined event properties. This pattern is supported for compatibility + but is equivalent to property. + + + + + method + + + Used to output the method name where the logging request was + issued. + + + WARNING Generating caller location information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + + + See the note below on the availability of caller location information. + + + + + n + Equivalent to newline + + + newline + + + Outputs the platform dependent line separator character or + characters. + + + This conversion pattern offers the same performance as using + non-portable line separator strings such as "\n", or "\r\n". + Thus, it is the preferred way of specifying a line separator. + + + + + ndc + + + Used to output the NDC (nested diagnostic context) associated + with the thread that generated the logging event. + + + + + p + Equivalent to level + + + P + Equivalent to property + + + properties + Equivalent to property + + + property + + + Used to output the an event specific property. The key to + lookup must be specified within braces and directly following the + pattern specifier, e.g. %property{user} would include the value + from the property that is keyed by the string 'user'. Each property value + that is to be included in the log must be specified separately. + Properties are added to events by loggers or appenders. By default + the log4net:HostName property is set to the name of machine on + which the event was originally logged. + + + If no key is specified, e.g. %property then all the keys and their + values are printed in a comma separated list. + + + The properties of an event are combined from a number of different + contexts. These are listed below in the order in which they are searched. + + + + the event properties + + The event has that can be set. These + properties are specific to this event only. + + + + the thread properties + + The that are set on the current + thread. These properties are shared by all events logged on this thread. + + + + the global properties + + The that are set globally. These + properties are shared by all the threads in the AppDomain. + + + + + + + + r + Equivalent to timestamp + + + stacktrace + + + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, %stacktrace{level}. + If no stack trace level specifier is given then 1 is assumed + + + Output uses the format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + + + This pattern is not available for Compact Framework assemblies. + + + + + stacktracedetail + + + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, %stacktracedetail{level}. + If no stack trace level specifier is given then 1 is assumed + + + Output uses the format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) + + + This pattern is not available for Compact Framework assemblies. + + + + + t + Equivalent to thread + + + timestamp + + + Used to output the number of milliseconds elapsed since the start + of the application until the creation of the logging event. + + + + + thread + + + Used to output the name of the thread that generated the + logging event. Uses the thread number if no name is available. + + + + + type + + + Used to output the fully qualified type name of the caller + issuing the logging request. This conversion specifier + can be optionally followed by precision specifier, that + is a decimal constant in brackets. + + + If a precision specifier is given, then only the corresponding + number of right most components of the class name will be + printed. By default the class name is output in fully qualified form. + + + For example, for the class name "log4net.Layout.PatternLayout", the + pattern %type{1} will output "PatternLayout". + + + WARNING Generating the caller class information is + slow. Thus, its use should be avoided unless execution speed is + not an issue. + + + See the note below on the availability of caller location information. + + + + + u + Equivalent to identity + + + username + + + Used to output the WindowsIdentity for the currently + active user. + + + WARNING Generating caller WindowsIdentity information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + + + + + utcdate + + + Used to output the date of the logging event in universal time. + The date conversion + specifier may be followed by a date format specifier enclosed + between braces. For example, %utcdate{HH:mm:ss,fff} or + %utcdate{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is + given then ISO8601 format is + assumed (). + + + The date format specifier admits the same syntax as the + time pattern string of the . + + + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + , + and respectively + . For example, + %utcdate{ISO8601} or %utcdate{ABSOLUTE}. + + + These dedicated date formatters perform significantly + better than . + + + + + w + Equivalent to username + + + x + Equivalent to ndc + + + X + Equivalent to mdc + + + % + + + The sequence %% outputs a single percent sign. + + + + + + The single letter patterns are deprecated in favor of the + longer more descriptive pattern names. + + + By default the relevant information is output as is. However, + with the aid of format modifiers it is possible to change the + minimum field width, the maximum field width and justification. + + + The optional format modifier is placed between the percent sign + and the conversion pattern name. + + + The first optional format modifier is the left justification + flag which is just the minus (-) character. Then comes the + optional minimum field width modifier. This is a decimal + constant that represents the minimum number of characters to + output. If the data item requires fewer characters, it is padded on + either the left or the right until the minimum width is + reached. The default is to pad on the left (right justify) but you + can specify right padding with the left justification flag. The + padding character is space. If the data item is larger than the + minimum field width, the field is expanded to accommodate the + data. The value is never truncated. + + + This behavior can be changed using the maximum field + width modifier which is designated by a period followed by a + decimal constant. If the data item is longer than the maximum + field, then the extra characters are removed from the + beginning of the data item and not from the end. For + example, it the maximum field width is eight and the data item is + ten characters long, then the first two characters of the data item + are dropped. This behavior deviates from the printf function in C + where truncation is done from the end. + + + Below are various format modifier examples for the logger + conversion specifier. + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Format modifierleft justifyminimum widthmaximum widthcomment
%20loggerfalse20none + + Left pad with spaces if the logger name is less than 20 + characters long. + +
%-20loggertrue20none + + Right pad with spaces if the logger + name is less than 20 characters long. + +
%.30loggerNAnone30 + + Truncate from the beginning if the logger + name is longer than 30 characters. + +
%20.30loggerfalse2030 + + Left pad with spaces if the logger name is shorter than 20 + characters. However, if logger name is longer than 30 characters, + then truncate from the beginning. + +
%-20.30loggertrue2030 + + Right pad with spaces if the logger name is shorter than 20 + characters. However, if logger name is longer than 30 characters, + then truncate from the beginning. + +
+
+ + Note about caller location information.
+ The following patterns %type %file %line %method %location %class %C %F %L %l %M + all generate caller location information. + Location information uses the System.Diagnostics.StackTrace class to generate + a call stack. The caller's information is then extracted from this stack. +
+ + + The System.Diagnostics.StackTrace class is not supported on the + .NET Compact Framework 1.0 therefore caller location information is not + available on that framework. + + + + + The System.Diagnostics.StackTrace class has this to say about Release builds: + + + "StackTrace information will be most informative with Debug build configurations. + By default, Debug builds include debug symbols, while Release builds do not. The + debug symbols contain most of the file, method name, line number, and column + information used in constructing StackFrame and StackTrace objects. StackTrace + might not report as many method calls as expected, due to code transformations + that occur during optimization." + + + This means that in a Release build the caller information may be incomplete or may + not exist at all! Therefore caller location information cannot be relied upon in a Release build. + + + + Additional pattern converters may be registered with a specific + instance using the method. + +
+ + This is a more detailed pattern. + %timestamp [%thread] %level %logger %ndc - %message%newline + + + A similar pattern except that the relative time is + right padded if less than 6 digits, thread name is right padded if + less than 15 characters and truncated if longer and the logger + name is left padded if shorter than 30 characters and truncated if + longer. + %-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline + + Nicko Cadell + Gert Driesen + Douglas de la Torre + Daniel Cazzulino +
+ + + Default pattern string for log output. + + + + Default pattern string for log output. + Currently set to the string "%message%newline" + which just prints the application supplied message. + + + + + + A detailed conversion pattern + + + + A conversion pattern which includes Time, Thread, Logger, and Nested Context. + Current value is %timestamp [%thread] %level %logger %ndc - %message%newline. + + + + + + Internal map of converter identifiers to converter types. + + + + This static map is overridden by the m_converterRegistry instance map + + + + + + the pattern + + + + + the head of the pattern converter chain + + + + + patterns defined on this PatternLayout only + + + + + Initialize the global registry + + + + Defines the builtin global rules. + + + + + + Constructs a PatternLayout using the DefaultConversionPattern + + + + The default pattern just produces the application supplied message. + + + Note to Inheritors: This constructor calls the virtual method + . If you override this method be + aware that it will be called before your is called constructor. + + + As per the contract the + method must be called after the properties on this object have been + configured. + + + + + + Constructs a PatternLayout using the supplied conversion pattern + + the pattern to use + + + Note to Inheritors: This constructor calls the virtual method + . If you override this method be + aware that it will be called before your is called constructor. + + + When using this constructor the method + need not be called. This may not be the case when using a subclass. + + + + + + The pattern formatting string + + + + The ConversionPattern option. This is the string which + controls formatting and consists of a mix of literal content and + conversion specifiers. + + + + + + Create the pattern parser instance + + the pattern to parse + The that will format the event + + + Creates the used to parse the conversion string. Sets the + global and instance rules on the . + + + + + + Initialize layout options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Produces a formatted string as specified by the conversion pattern. + + the event being logged + The TextWriter to write the formatted event to + + + Parse the using the patter format + specified in the property. + + + + + + Add a converter to this PatternLayout + + the converter info + + + This version of the method is used by the configurator. + Programmatic users should use the alternative method. + + + + + + Add a converter to this PatternLayout + + the name of the conversion pattern for this converter + the type of the converter + + + Add a named pattern converter to this instance. This + converter will be used in the formatting of the event. + This method must be called before . + + + The specified must extend the + type. + + + + + + Write the event appdomain name to the output + + + + Writes the to the output writer. + + + Daniel Cazzulino + Nicko Cadell + + + + Write the event appdomain name to the output + + that will receive the formatted result. + the event being logged + + + Writes the to the output . + + + + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. If no property has been set, all key value pairs from the Cache will + be written to the output. + + + + + + Converter for items in the . + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net HttpContext item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. + + + + + + Abstract class that provides access to the current HttpContext () that + derived classes need. + + + This class handles the case when HttpContext.Current is null by writing + to the writer. + + Ron Grabowski + + + + Derived pattern converters must override this method in order to + convert conversion specifiers in the correct way. + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. + + + + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. If no property has been set, all key value pairs from the Session will + be written to the output. + + + + + + Date pattern converter, uses a to format + the date of a . + + + + Render the to the writer as a string. + + + The value of the determines + the formatting of the date. The following values are allowed: + + + Option value + Output + + + ISO8601 + + Uses the formatter. + Formats using the "yyyy-MM-dd HH:mm:ss,fff" pattern. + + + + DATE + + Uses the formatter. + Formats using the "dd MMM yyyy HH:mm:ss,fff" for example, "06 Nov 1994 15:49:37,459". + + + + ABSOLUTE + + Uses the formatter. + Formats using the "HH:mm:ss,yyyy" for example, "15:49:37,459". + + + + other + + Any other pattern string uses the formatter. + This formatter passes the pattern string to the + method. + For details on valid patterns see + DateTimeFormatInfo Class. + + + + + + The is in the local time zone and is rendered in that zone. + To output the time in Universal time see . + + + Nicko Cadell + + + + The used to render the date to a string + + + + The used to render the date to a string + + + + + + Initialize the converter pattern based on the property. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Convert the pattern into the rendered message + + that will receive the formatted result. + the event being logged + + + Pass the to the + for it to render it to the writer. + + + The passed is in the local time zone. + + + + + + The fully qualified type of the DatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the exception text to the output + + + + If an exception object is stored in the logging event + it will be rendered into the pattern output with a + trailing newline. + + + If there is no exception then nothing will be output + and no trailing newline will be appended. + It is typical to put a newline before the exception + and to have the exception as the last data in the pattern. + + + Nicko Cadell + + + + Default constructor + + + + + Write the exception text to the output + + that will receive the formatted result. + the event being logged + + + If an exception object is stored in the logging event + it will be rendered into the pattern output with a + trailing newline. + + + If there is no exception or the exception property specified + by the Option value does not exist then nothing will be output + and no trailing newline will be appended. + It is typical to put a newline before the exception + and to have the exception as the last data in the pattern. + + + Recognized values for the Option parameter are: + + + + Message + + + Source + + + StackTrace + + + TargetSite + + + HelpLink + + + + + + + Writes the caller location file name to the output + + + + Writes the value of the for + the event to the output writer. + + + Nicko Cadell + + + + Write the caller location file name to the output + + that will receive the formatted result. + the event being logged + + + Writes the value of the for + the to the output . + + + + + + Write the caller location info to the output + + + + Writes the to the output writer. + + + Nicko Cadell + + + + Write the caller location info to the output + + that will receive the formatted result. + the event being logged + + + Writes the to the output writer. + + + + + + Writes the event identity to the output + + + + Writes the value of the to + the output writer. + + + Daniel Cazzulino + Nicko Cadell + + + + Writes the event identity to the output + + that will receive the formatted result. + the event being logged + + + Writes the value of the + to + the output . + + + + + + Write the event level to the output + + + + Writes the display name of the event + to the writer. + + + Nicko Cadell + + + + Write the event level to the output + + that will receive the formatted result. + the event being logged + + + Writes the of the + to the . + + + + + + Write the caller location line number to the output + + + + Writes the value of the for + the event to the output writer. + + + Nicko Cadell + + + + Write the caller location line number to the output + + that will receive the formatted result. + the event being logged + + + Writes the value of the for + the to the output . + + + + + + Converter for logger name + + + + Outputs the of the event. + + + Nicko Cadell + + + + Gets the fully qualified name of the logger + + the event being logged + The fully qualified logger name + + + Returns the of the . + + + + + + Writes the event message to the output + + + + Uses the method + to write out the event message. + + + Nicko Cadell + + + + Writes the event message to the output + + that will receive the formatted result. + the event being logged + + + Uses the method + to write out the event message. + + + + + + Write the method name to the output + + + + Writes the caller location to + the output. + + + Nicko Cadell + + + + Write the method name to the output + + that will receive the formatted result. + the event being logged + + + Writes the caller location to + the output. + + + + + + Converter to output and truncate '.' separated strings + + + + This abstract class supports truncating a '.' separated string + to show a specified number of elements from the right hand side. + This is used to truncate class names that are fully qualified. + + + Subclasses should override the method to + return the fully qualified string. + + + Nicko Cadell + + + + Initialize the converter + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Get the fully qualified string data + + the event being logged + the fully qualified name + + + Overridden by subclasses to get the fully qualified name before the + precision is applied to it. + + + Return the fully qualified '.' (dot/period) separated string. + + + + + + Convert the pattern to the rendered message + + that will receive the formatted result. + the event being logged + + Render the to the precision + specified by the property. + + + + + The fully qualified type of the NamedPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Converter to include event NDC + + + + Outputs the value of the event property named NDC. + + + The should be used instead. + + + Nicko Cadell + + + + Write the event NDC to the output + + that will receive the formatted result. + the event being logged + + + As the thread context stacks are now stored in named event properties + this converter simply looks up the value of the NDC property. + + + The should be used instead. + + + + + + Abstract class that provides the formatting functionality that + derived classes need. + + + Conversion specifiers in a conversion patterns are parsed to + individual PatternConverters. Each of which is responsible for + converting a logging event in a converter specific manner. + + Nicko Cadell + + + + Initializes a new instance of the class. + + + + + Flag indicating if this converter handles the logging event exception + + false if this converter handles the logging event exception + + + If this converter handles the exception object contained within + , then this property should be set to + false. Otherwise, if the layout ignores the exception + object, then the property should be set to true. + + + Set this value to override a this default setting. The default + value is true, this converter does not handle the exception. + + + + + + Derived pattern converters must override this method in order to + convert conversion specifiers in the correct way. + + that will receive the formatted result. + The on which the pattern converter should be executed. + + + + Derived pattern converters must override this method in order to + convert conversion specifiers in the correct way. + + that will receive the formatted result. + The state object on which the pattern converter should be executed. + + + + Flag indicating if this converter handles exceptions + + + false if this converter handles exceptions + + + + + Property pattern converter + + + + Writes out the value of a named property. The property name + should be set in the + property. + + + If the is set to null + then all the properties are written as key value pairs. + + + Nicko Cadell + + + + Write the property value to the output + + that will receive the formatted result. + the event being logged + + + Writes out the value of a named property. The property name + should be set in the + property. + + + If the is set to null + then all the properties are written as key value pairs. + + + + + + Converter to output the relative time of the event + + + + Converter to output the time of the event relative to the start of the program. + + + Nicko Cadell + + + + Write the relative time to the output + + that will receive the formatted result. + the event being logged + + + Writes out the relative time of the event in milliseconds. + That is the number of milliseconds between the event + and the . + + + + + + Helper method to get the time difference between two DateTime objects + + start time (in the current local time zone) + end time (in the current local time zone) + the time difference in milliseconds + + + + Write the caller stack frames to the output + + + + Writes the to the output writer, using format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) + + + Adam Davies + + + + The fully qualified type of the StackTraceDetailPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the caller stack frames to the output + + + + Writes the to the output writer, using format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + + + Michael Cromwell + + + + Initialize the converter + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Write the strack frames to the output + + that will receive the formatted result. + the event being logged + + + Writes the to the output writer. + + + + + + Returns the Name of the method + + + This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter + string + + + + The fully qualified type of the StackTracePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Converter to include event thread name + + + + Writes the to the output. + + + Nicko Cadell + + + + Write the ThreadName to the output + + that will receive the formatted result. + the event being logged + + + Writes the to the . + + + + + + Pattern converter for the class name + + + + Outputs the of the event. + + + Nicko Cadell + + + + Gets the fully qualified name of the class + + the event being logged + The fully qualified type name for the caller location + + + Returns the of the . + + + + + + Converter to include event user name + + Douglas de la Torre + Nicko Cadell + + + + Convert the pattern to the rendered message + + that will receive the formatted result. + the event being logged + + + + Write the TimeStamp to the output + + + + Date pattern converter, uses a to format + the date of a . + + + Uses a to format the + in Universal time. + + + See the for details on the date pattern syntax. + + + + Nicko Cadell + + + + Write the TimeStamp to the output + + that will receive the formatted result. + the event being logged + + + Pass the to the + for it to render it to the writer. + + + The passed is in the local time zone, this is converted + to Universal time before it is rendered. + + + + + + + The fully qualified type of the UtcDatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Type converter for the interface + + + + Used to convert objects to the interface. + Supports converting from the interface to + the interface using the . + + + Nicko Cadell + Gert Driesen + + + + Can the sourceType be converted to an + + the source to be to be converted + true if the source type can be converted to + + + Test if the can be converted to a + . Only is supported + as the . + + + + + + Convert the value to a object + + the value to convert + the object + + + Convert the object to a + object. If the object + is a then the + is used to adapt between the two interfaces, otherwise an + exception is thrown. + + + + + + Extract the value of a property from the + + + + Extract the value of a property from the + + + Nicko Cadell + + + + Constructs a RawPropertyLayout + + + + + The name of the value to lookup in the LoggingEvent Properties collection. + + + Value to lookup in the LoggingEvent Properties collection + + + + String name of the property to lookup in the . + + + + + + Lookup the property for + + The event to format + returns property value + + + Looks up and returns the object value of the property + named . If there is no property defined + with than name then null will be returned. + + + + + + Extract the date from the + + + + Extract the date from the + + + Nicko Cadell + Gert Driesen + + + + Constructs a RawTimeStampLayout + + + + + Gets the as a . + + The event to format + returns the time stamp + + + Gets the as a . + + + The time stamp is in local time. To format the time stamp + in universal time use . + + + + + + Extract the date from the + + + + Extract the date from the + + + Nicko Cadell + Gert Driesen + + + + Constructs a RawUtcTimeStampLayout + + + + + Gets the as a . + + The event to format + returns the time stamp + + + Gets the as a . + + + The time stamp is in universal time. To format the time stamp + in local time use . + + + + + + A very simple layout + + + + SimpleLayout consists of the level of the log statement, + followed by " - " and then the log message itself. For example, + + DEBUG - Hello world + + + + Nicko Cadell + Gert Driesen + + + + Constructs a SimpleLayout + + + + + Initialize layout options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Produces a simple formatted output. + + the event being logged + The TextWriter to write the formatted event to + + + Formats the event as the level of the even, + followed by " - " and then the log message itself. The + output is terminated by a newline. + + + + + + Layout that formats the log events as XML elements. + + + + The output of the consists of a series of + log4net:event elements. It does not output a complete well-formed XML + file. The output is designed to be included as an external entity + in a separate file to form a correct XML file. + + + For example, if abc is the name of the file where + the output goes, then a well-formed XML file would + be: + + + <?xml version="1.0" ?> + + <!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [<!ENTITY data SYSTEM "abc">]> + + <log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2> + &data; + </log4net:events> + + + This approach enforces the independence of the + and the appender where it is embedded. + + + The version attribute helps components to correctly + interpret output generated by . The value of + this attribute should be "1.2" for release 1.2 and later. + + + Alternatively the Header and Footer properties can be + configured to output the correct XML header, open tag and close tag. + When setting the Header and Footer properties it is essential + that the underlying data store not be appendable otherwise the data + will become invalid XML. + + + Nicko Cadell + Gert Driesen + + + + Constructs an XmlLayout + + + + + Constructs an XmlLayout. + + + + The LocationInfo option takes a boolean value. By + default, it is set to false which means there will be no location + information output by this layout. If the the option is set to + true, then the file name and line number of the statement + at the origin of the log statement will be output. + + + If you are embedding this layout within an SmtpAppender + then make sure to set the LocationInfo option of that + appender as well. + + + + + + The prefix to use for all element names + + + + The default prefix is log4net. Set this property + to change the prefix. If the prefix is set to an empty string + then no prefix will be written. + + + + + + Set whether or not to base64 encode the message. + + + + By default the log message will be written as text to the xml + output. This can cause problems when the message contains binary + data. By setting this to true the contents of the message will be + base64 encoded. If this is set then invalid character replacement + (see ) will not be performed + on the log message. + + + + + + Set whether or not to base64 encode the property values. + + + + By default the properties will be written as text to the xml + output. This can cause problems when one or more properties contain + binary data. By setting this to true the values of the properties + will be base64 encoded. If this is set then invalid character replacement + (see ) will not be performed + on the property values. + + + + + + Initialize layout options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + Builds a cache of the element names + + + + + + Does the actual writing of the XML. + + The writer to use to output the event to. + The event to write. + + + Override the base class method + to write the to the . + + + + + + The prefix to use for all generated element names + + + + + Layout that formats the log events as XML elements. + + + + This is an abstract class that must be subclassed by an implementation + to conform to a specific schema. + + + Deriving classes must implement the method. + + + Nicko Cadell + Gert Driesen + + + + Protected constructor to support subclasses + + + + Initializes a new instance of the class + with no location info. + + + + + + Protected constructor to support subclasses + + + + The parameter determines whether + location information will be output by the layout. If + is set to true, then the + file name and line number of the statement at the origin of the log + statement will be output. + + + If you are embedding this layout within an SMTPAppender + then make sure to set the LocationInfo option of that + appender as well. + + + + + + Gets a value indicating whether to include location information in + the XML events. + + + true if location information should be included in the XML + events; otherwise, false. + + + + If is set to true, then the file + name and line number of the statement at the origin of the log + statement will be output. + + + If you are embedding this layout within an SMTPAppender + then make sure to set the LocationInfo option of that + appender as well. + + + + + + The string to replace characters that can not be expressed in XML with. + + + Not all characters may be expressed in XML. This property contains the + string to replace those that can not with. This defaults to a ?. Set it + to the empty string to simply remove offending characters. For more + details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets + Character replacement will occur in the log message, the property names + and the property values. + + + + + + + Initialize layout options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Gets the content type output by this layout. + + + As this is the XML layout, the value is always "text/xml". + + + + As this is the XML layout, the value is always "text/xml". + + + + + + Produces a formatted string. + + The event being logged. + The TextWriter to write the formatted event to + + + Format the and write it to the . + + + This method creates an that writes to the + . The is passed + to the method. Subclasses should override the + method rather than this method. + + + + + + Does the actual writing of the XML. + + The writer to use to output the event to. + The event to write. + + + Subclasses should override this method to format + the as XML. + + + + + + Flag to indicate if location information should be included in + the XML events. + + + + + The string to replace invalid chars with + + + + + Layout that formats the log events as XML elements compatible with the log4j schema + + + + Formats the log events according to the http://logging.apache.org/log4j schema. + + + Nicko Cadell + + + + The 1st of January 1970 in UTC + + + + + Constructs an XMLLayoutSchemaLog4j + + + + + Constructs an XMLLayoutSchemaLog4j. + + + + The LocationInfo option takes a boolean value. By + default, it is set to false which means there will be no location + information output by this layout. If the the option is set to + true, then the file name and line number of the statement + at the origin of the log statement will be output. + + + If you are embedding this layout within an SMTPAppender + then make sure to set the LocationInfo option of that + appender as well. + + + + + + The version of the log4j schema to use. + + + + Only version 1.2 of the log4j schema is supported. + + + + + + Actually do the writing of the xml + + the writer to use + the event to write + + + Generate XML that is compatible with the log4j schema. + + + + + + The log4net Logical Thread Context. + + + + The LogicalThreadContext provides a location for specific debugging + information to be stored. + The LogicalThreadContext properties override any or + properties with the same name. + + + For .NET Standard 1.3 this class uses + System.Threading.AsyncLocal rather than . + + + The Logical Thread Context has a properties map and a stack. + The properties and stack can + be included in the output of log messages. The + supports selecting and outputting these properties. + + + The Logical Thread Context provides a diagnostic context for the current call context. + This is an instrument for distinguishing interleaved log + output from different sources. Log output is typically interleaved + when a server handles multiple clients near-simultaneously. + + + The Logical Thread Context is managed on a per basis. + + + The requires a link time + for the + . + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + + + Example of using the thread context properties to store a username. + + LogicalThreadContext.Properties["user"] = userName; + log.Info("This log message has a LogicalThreadContext Property called 'user'"); + + + Example of how to push a message into the context stack + + using(LogicalThreadContext.Stacks["LDC"].Push("my context message")) + { + log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'"); + + } // at the end of the using block the message is automatically popped + + + + Nicko Cadell + + + + Private Constructor. + + + + Uses a private access modifier to prevent instantiation of this class. + + + + + + The thread properties map + + + The thread properties map + + + + The LogicalThreadContext properties override any + or properties with the same name. + + + + + + The thread stacks + + + stack map + + + + The logical thread stacks. + + + + + + The thread context properties instance + + + + + The thread context stacks instance + + + + + This class is used by client applications to request logger instances. + + + + This class has static methods that are used by a client to request + a logger instance. The method is + used to retrieve a logger. + + + See the interface for more details. + + + Simple example of logging messages + + ILog log = LogManager.GetLogger("application-log"); + + log.Info("Application Start"); + log.Debug("This is a debug message"); + + if (log.IsDebugEnabled) + { + log.Debug("This is another debug message"); + } + + + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + Uses a private access modifier to prevent instantiation of this class. + + + + Returns the named logger if it exists. + + Returns the named logger if it exists. + + + + If the named logger exists (in the default repository) then it + returns a reference to the logger, otherwise it returns null. + + + The fully qualified logger name to look for. + The logger found, or null if no logger could be found. + + + Get the currently defined loggers. + + Returns all the currently defined loggers in the default repository. + + + The root logger is not included in the returned array. + + All the defined loggers. + + + Get or create a logger. + + Retrieves or creates a named logger. + + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The name of the logger to retrieve. + The logger with the name specified. + + + + Returns the named logger if it exists. + + + + If the named logger exists (in the specified repository) then it + returns a reference to the logger, otherwise it returns + null. + + + The repository to lookup in. + The fully qualified logger name to look for. + + The logger found, or null if the logger doesn't exist in the specified + repository. + + + + + Returns the named logger if it exists. + + + + If the named logger exists (in the repository for the specified assembly) then it + returns a reference to the logger, otherwise it returns + null. + + + The assembly to use to lookup the repository. + The fully qualified logger name to look for. + + The logger, or null if the logger doesn't exist in the specified + assembly's repository. + + + + + Returns all the currently defined loggers in the specified repository. + + The repository to lookup in. + + The root logger is not included in the returned array. + + All the defined loggers. + + + + Returns all the currently defined loggers in the specified assembly's repository. + + The assembly to use to lookup the repository. + + The root logger is not included in the returned array. + + All the defined loggers. + + + + Retrieves or creates a named logger. + + + + Retrieve a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The repository to lookup in. + The name of the logger to retrieve. + The logger with the name specified. + + + + Retrieves or creates a named logger. + + + + Retrieve a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The assembly to use to lookup the repository. + The name of the logger to retrieve. + The logger with the name specified. + + + + Shorthand for . + + + Get the logger for the fully qualified name of the type specified. + + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. + + + + Shorthand for . + + + Gets the logger for the fully qualified name of the type specified. + + The repository to lookup in. + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. + + + + Shorthand for . + + + Gets the logger for the fully qualified name of the type specified. + + The assembly to use to lookup the repository. + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. + + + + Shuts down the log4net system. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in all the + default repositories. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + Shutdown a logger repository. + + Shuts down the default repository. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + default repository. + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Shuts down the repository for the repository specified. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + The repository to shutdown. + + + + Shuts down the repository specified. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository. The repository is looked up using + the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + The assembly to use to lookup the repository. + + + Reset the configuration of a repository + + Resets all values contained in this repository instance to their defaults. + + + + Resets all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set to its default "off" value. + + + + + + Resets all values contained in this repository instance to their defaults. + + + + Reset all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set to its default "off" value. + + + The repository to reset. + + + + Resets all values contained in this repository instance to their defaults. + + + + Reset all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set to its default "off" value. + + + The assembly to use to lookup the repository to reset. + + + Get the logger repository. + + Returns the default instance. + + + + Gets the for the repository specified + by the callers assembly (). + + + The instance for the default repository. + + + + Returns the default instance. + + The default instance. + + + Gets the for the repository specified + by the argument. + + + The repository to lookup in. + + + + Returns the default instance. + + The default instance. + + + Gets the for the repository specified + by the argument. + + + The assembly to use to lookup the repository. + + + Get a logger repository. + + Returns the default instance. + + + + Gets the for the repository specified + by the callers assembly (). + + + The instance for the default repository. + + + + Returns the default instance. + + The default instance. + + + Gets the for the repository specified + by the argument. + + + The repository to lookup in. + + + + Returns the default instance. + + The default instance. + + + Gets the for the repository specified + by the argument. + + + The assembly to use to lookup the repository. + + + Create a domain + + Creates a repository with the specified repository type. + + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + The created will be associated with the repository + specified such that a call to will return + the same repository instance. + + + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + Create a logger repository. + + Creates a repository with the specified repository type. + + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + The created will be associated with the repository + specified such that a call to will return + the same repository instance. + + + + + + Creates a repository with the specified name. + + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + Creates the default type of which is a + object. + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The name of the repository, this must be unique amongst repositories. + The created for the repository. + The specified repository already exists. + + + + Creates a repository with the specified name. + + + + Creates the default type of which is a + object. + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The name of the repository, this must be unique amongst repositories. + The created for the repository. + The specified repository already exists. + + + + Creates a repository with the specified name and repository type. + + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The name of the repository, this must be unique to the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + The specified repository already exists. + + + + Creates a repository with the specified name and repository type. + + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The name of the repository, this must be unique to the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + The specified repository already exists. + + + + Creates a repository for the specified assembly and repository type. + + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + The assembly to use to get the name of the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + + Creates a repository for the specified assembly and repository type. + + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + The assembly to use to get the name of the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + + Gets the list of currently defined repositories. + + + + Get an array of all the objects that have been created. + + + An array of all the known objects. + + + + Flushes logging events buffered in all configured appenders in the default repository. + + The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed. + True if all logging events were flushed successfully, else false. + + + + Looks up the wrapper object for the logger specified. + + The logger to get the wrapper for. + The wrapper for the logger specified. + + + + Looks up the wrapper objects for the loggers specified. + + The loggers to get the wrappers for. + The wrapper objects for the loggers specified. + + + + Create the objects used by + this manager. + + The logger to wrap. + The wrapper for the logger specified. + + + + The wrapper map to use to hold the objects. + + + + + Implementation of Mapped Diagnostic Contexts. + + + + + The MDC is deprecated and has been replaced by the . + The current MDC implementation forwards to the ThreadContext.Properties. + + + + The MDC class is similar to the class except that it is + based on a map instead of a stack. It provides mapped + diagnostic contexts. A Mapped Diagnostic Context, or + MDC in short, is an instrument for distinguishing interleaved log + output from different sources. Log output is typically interleaved + when a server handles multiple clients near-simultaneously. + + + The MDC is managed on a per thread basis. + + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + Uses a private access modifier to prevent instantiation of this class. + + + + + Gets the context value identified by the parameter. + + The key to lookup in the MDC. + The string value held for the key, or a null reference if no corresponding value is found. + + + + The MDC is deprecated and has been replaced by the . + The current MDC implementation forwards to the ThreadContext.Properties. + + + + If the parameter does not look up to a + previously defined context then null will be returned. + + + + + + Add an entry to the MDC + + The key to store the value under. + The value to store. + + + + The MDC is deprecated and has been replaced by the . + The current MDC implementation forwards to the ThreadContext.Properties. + + + + Puts a context value (the parameter) as identified + with the parameter into the current thread's + context map. + + + If a value is already defined for the + specified then the value will be replaced. If the + is specified as null then the key value mapping will be removed. + + + + + + Removes the key value mapping for the key specified. + + The key to remove. + + + + The MDC is deprecated and has been replaced by the . + The current MDC implementation forwards to the ThreadContext.Properties. + + + + Remove the specified entry from this thread's MDC + + + + + + Clear all entries in the MDC + + + + + The MDC is deprecated and has been replaced by the . + The current MDC implementation forwards to the ThreadContext.Properties. + + + + Remove all the entries from this thread's MDC + + + + + + Implementation of Nested Diagnostic Contexts. + + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + A Nested Diagnostic Context, or NDC in short, is an instrument + to distinguish interleaved log output from different sources. Log + output is typically interleaved when a server handles multiple + clients near-simultaneously. + + + Interleaved log output can still be meaningful if each log entry + from different contexts had a distinctive stamp. This is where NDCs + come into play. + + + Note that NDCs are managed on a per thread basis. The NDC class + is made up of static methods that operate on the context of the + calling thread. + + + How to push a message into the context + + using(NDC.Push("my context message")) + { + ... all log calls will have 'my context message' included ... + + } // at the end of the using block the message is automatically removed + + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + Uses a private access modifier to prevent instantiation of this class. + + + + + Gets the current context depth. + + The current context depth. + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + The number of context values pushed onto the context stack. + + + Used to record the current depth of the context. This can then + be restored using the method. + + + + + + + Clears all the contextual information held on the current thread. + + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + Clears the stack of NDC data held on the current thread. + + + + + + Creates a clone of the stack of context information. + + A clone of the context info for this thread. + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + The results of this method can be passed to the + method to allow child threads to inherit the context of their + parent thread. + + + + + + Inherits the contextual information from another thread. + + The context stack to inherit. + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + This thread will use the context information from the stack + supplied. This can be used to initialize child threads with + the same contextual information as their parent threads. These + contexts will NOT be shared. Any further contexts that + are pushed onto the stack will not be visible to the other. + Call to obtain a stack to pass to + this method. + + + + + + Removes the top context from the stack. + + + The message in the context that was removed from the top + of the stack. + + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + Remove the top context from the stack, and return + it to the caller. If the stack is empty then an + empty string (not null) is returned. + + + + + + Pushes a new context message. + + The new context message. + + An that can be used to clean up + the context stack. + + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + Pushes a new context onto the context stack. An + is returned that can be used to clean up the context stack. This + can be easily combined with the using keyword to scope the + context. + + + Simple example of using the Push method with the using keyword. + + using(log4net.NDC.Push("NDC_Message")) + { + log.Warn("This should have an NDC message"); + } + + + + + + Pushes a new context message. + + The new context message string format. + Arguments to be passed into messageFormat. + + An that can be used to clean up + the context stack. + + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + Pushes a new context onto the context stack. An + is returned that can be used to clean up the context stack. This + can be easily combined with the using keyword to scope the + context. + + + Simple example of using the Push method with the using keyword. + + var someValue = "ExampleContext" + using(log4net.NDC.PushFormat("NDC_Message {0}", someValue)) + { + log.Warn("This should have an NDC message"); + } + + + + + + Removes the context information for this thread. It is + not required to call this method. + + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + This method is not implemented. + + + + + + Forces the stack depth to be at most . + + The maximum depth of the stack + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + Forces the stack depth to be at most . + This may truncate the head of the stack. This only affects the + stack in the current thread. Also it does not prevent it from + growing, it only sets the maximum depth at the time of the + call. This can be used to return to a known context depth. + + + + + + The default object Renderer. + + + + The default renderer supports rendering objects and collections to strings. + + + See the method for details of the output. + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Default constructor + + + + + + Render the object to a string + + The map used to lookup renderers + The object to render + The writer to render to + + + Render the object to a string. + + + The parameter is + provided to lookup and render other objects. This is + very useful where contains + nested objects of unknown type. The + method can be used to render these objects. + + + The default renderer supports rendering objects to strings as follows: + + + + Value + Rendered String + + + null + + "(null)" + + + + + + + For a one dimensional array this is the + array type name, an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. + + + For example: int[] {1, 2, 3}. + + + If the array is not one dimensional the + Array.ToString() is returned. + + + + + , & + + + Rendered as an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. + + + For example: {a, b, c}. + + + All collection classes that implement its subclasses, + or generic equivalents all implement the interface. + + + + + + + + Rendered as the key, an equals sign ('='), and the value (using the appropriate + renderer). + + + For example: key=value. + + + + + other + + Object.ToString() + + + + + + + + Render the array argument into a string + + The map used to lookup renderers + the array to render + The writer to render to + + + For a one dimensional array this is the + array type name, an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. For example: + int[] {1, 2, 3}. + + + If the array is not one dimensional the + Array.ToString() is returned. + + + + + + Render the enumerator argument into a string + + The map used to lookup renderers + the enumerator to render + The writer to render to + + + Rendered as an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. For example: + {a, b, c}. + + + + + + Render the DictionaryEntry argument into a string + + The map used to lookup renderers + the DictionaryEntry to render + The writer to render to + + + Render the key, an equals sign ('='), and the value (using the appropriate + renderer). For example: key=value. + + + + + + Implement this interface in order to render objects as strings + + + + Certain types require special case conversion to + string form. This conversion is done by an object renderer. + Object renderers implement the + interface. + + + Nicko Cadell + Gert Driesen + + + + Render the object to a string + + The map used to lookup renderers + The object to render + The writer to render to + + + Render the object to a + string. + + + The parameter is + provided to lookup and render other objects. This is + very useful where contains + nested objects of unknown type. The + method can be used to render these objects. + + + + + + Map class objects to an . + + + + Maintains a mapping between types that require special + rendering and the that + is used to render them. + + + The method is used to render an + object using the appropriate renderers defined in this map. + + + Nicko Cadell + Gert Driesen + + + + Default Constructor + + + + Default constructor. + + + + + + Render using the appropriate renderer. + + the object to render to a string + the object rendered as a string + + + This is a convenience method used to render an object to a string. + The alternative method + should be used when streaming output to a . + + + + + + Render using the appropriate renderer. + + the object to render to a string + The writer to render to + + + Find the appropriate renderer for the type of the + parameter. This is accomplished by calling the + method. Once a renderer is found, it is + applied on the object and the result is returned + as a . + + + + + + Gets the renderer for the specified object type + + the object to lookup the renderer for + the renderer for + + + Gets the renderer for the specified object type. + + + Syntactic sugar method that calls + with the type of the object parameter. + + + + + + Gets the renderer for the specified type + + the type to lookup the renderer for + the renderer for the specified type + + + Returns the renderer for the specified type. + If no specific renderer has been defined the + will be returned. + + + + + + Internal function to recursively search interfaces + + the type to lookup the renderer for + the renderer for the specified type + + + + Get the default renderer instance + + the default renderer + + + Get the default renderer + + + + + + Clear the map of renderers + + + + Clear the custom renderers defined by using + . The + cannot be removed. + + + + + + Register an for . + + the type that will be rendered by + the renderer for + + + Register an object renderer for a specific source type. + This renderer will be returned from a call to + specifying the same as an argument. + + + + + + Interface implemented by logger repository plugins. + + + + Plugins define additional behavior that can be associated + with a . + The held by the + property is used to store the plugins for a repository. + + + The log4net.Config.PluginAttribute can be used to + attach plugins to repositories created using configuration + attributes. + + + Nicko Cadell + Gert Driesen + + + + Gets the name of the plugin. + + + The name of the plugin. + + + + Plugins are stored in the + keyed by name. Each plugin instance attached to a + repository must be a unique name. + + + + + + Attaches the plugin to the specified . + + The that this plugin should be attached to. + + + A plugin may only be attached to a single repository. + + + This method is called when the plugin is attached to the repository. + + + + + + Is called when the plugin is to shutdown. + + + + This method is called to notify the plugin that + it should stop operating and should detach from + the repository. + + + + + + Interface used to create plugins. + + + + Interface used to create a plugin. + + + Nicko Cadell + Gert Driesen + + + + Creates the plugin object. + + the new plugin instance + + + Create and return a new plugin instance. + + + + + + A strongly-typed collection of objects. + + Nicko Cadell + + + + Supports type-safe iteration over a . + + + + + + Gets the current element in the collection. + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + Creates a read-only wrapper for a PluginCollection instance. + + list to create a readonly wrapper arround + + A PluginCollection wrapper that is read-only. + + + + + Initializes a new instance of the PluginCollection class + that is empty and has the default initial capacity. + + + + + Initializes a new instance of the PluginCollection class + that has the specified initial capacity. + + + The number of elements that the new PluginCollection is initially capable of storing. + + + + + Initializes a new instance of the PluginCollection class + that contains elements copied from the specified PluginCollection. + + The PluginCollection whose elements are copied to the new collection. + + + + Initializes a new instance of the PluginCollection class + that contains elements copied from the specified array. + + The array whose elements are copied to the new list. + + + + Initializes a new instance of the PluginCollection class + that contains elements copied from the specified collection. + + The collection whose elements are copied to the new list. + + + + Type visible only to our subclasses + Used to access protected constructor + + + + + + A value + + + + + Allow subclasses to avoid our default constructors + + + + + + + Gets the number of elements actually contained in the PluginCollection. + + + + + Copies the entire PluginCollection to a one-dimensional + array. + + The one-dimensional array to copy to. + + + + Copies the entire PluginCollection to a one-dimensional + array, starting at the specified index of the target array. + + The one-dimensional array to copy to. + The zero-based index in at which copying begins. + + + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + false, because the backing type is an array, which is never thread-safe. + + + + Gets an object that can be used to synchronize access to the collection. + + + An object that can be used to synchronize access to the collection. + + + + + Gets or sets the at the specified index. + + + The at the specified index. + + The zero-based index of the element to get or set. + + is less than zero. + -or- + is equal to or greater than . + + + + + Adds a to the end of the PluginCollection. + + The to be added to the end of the PluginCollection. + The index at which the value has been added. + + + + Removes all elements from the PluginCollection. + + + + + Creates a shallow copy of the . + + A new with a shallow copy of the collection data. + + + + Determines whether a given is in the PluginCollection. + + The to check for. + true if is found in the PluginCollection; otherwise, false. + + + + Returns the zero-based index of the first occurrence of a + in the PluginCollection. + + The to locate in the PluginCollection. + + The zero-based index of the first occurrence of + in the entire PluginCollection, if found; otherwise, -1. + + + + + Inserts an element into the PluginCollection at the specified index. + + The zero-based index at which should be inserted. + The to insert. + + is less than zero + -or- + is equal to or greater than . + + + + + Removes the first occurrence of a specific from the PluginCollection. + + The to remove from the PluginCollection. + + The specified was not found in the PluginCollection. + + + + + Removes the element at the specified index of the PluginCollection. + + The zero-based index of the element to remove. + + is less than zero. + -or- + is equal to or greater than . + + + + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false. + + + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false. + + + + Returns an enumerator that can iterate through the PluginCollection. + + An for the entire PluginCollection. + + + + Gets or sets the number of elements the PluginCollection can contain. + + + The number of elements the PluginCollection can contain. + + + + + Adds the elements of another PluginCollection to the current PluginCollection. + + The PluginCollection whose elements should be added to the end of the current PluginCollection. + The new of the PluginCollection. + + + + Adds the elements of a array to the current PluginCollection. + + The array whose elements should be added to the end of the PluginCollection. + The new of the PluginCollection. + + + + Adds the elements of a collection to the current PluginCollection. + + The collection whose elements should be added to the end of the PluginCollection. + The new of the PluginCollection. + + + + Sets the capacity to the actual number of elements. + + + + + is less than zero. + -or- + is equal to or greater than . + + + + + is less than zero. + -or- + is equal to or greater than . + + + + + Supports simple iteration over a . + + + + + + Initializes a new instance of the Enumerator class. + + + + + + Gets the current element in the collection. + + + The current element in the collection. + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + + + + Map of repository plugins. + + + + This class is a name keyed map of the plugins that are + attached to a repository. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + The repository that the plugins should be attached to. + + + Initialize a new instance of the class with a + repository that the plugins should be attached to. + + + + + + Gets a by name. + + The name of the to lookup. + + The from the map with the name specified, or + null if no plugin is found. + + + + Lookup a plugin by name. If the plugin is not found null + will be returned. + + + + + + Gets all possible plugins as a list of objects. + + All possible plugins as a list of objects. + + + Get a collection of all the plugins defined in this map. + + + + + + Adds a to the map. + + The to add to the map. + + + The will be attached to the repository when added. + + + If there already exists a plugin with the same name + attached to the repository then the old plugin will + be and replaced with + the new plugin. + + + + + + Removes a from the map. + + The to remove from the map. + + + Remove a specific plugin from this map. + + + + + + Base implementation of + + + + Default abstract implementation of the + interface. This base class can be used by implementors + of the interface. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + the name of the plugin + + Initializes a new Plugin with the specified name. + + + + + Gets or sets the name of the plugin. + + + The name of the plugin. + + + + Plugins are stored in the + keyed by name. Each plugin instance attached to a + repository must be a unique name. + + + The name of the plugin must not change one the + plugin has been attached to a repository. + + + + + + Attaches this plugin to a . + + The that this plugin should be attached to. + + + A plugin may only be attached to a single repository. + + + This method is called when the plugin is attached to the repository. + + + + + + Is called when the plugin is to shutdown. + + + + This method is called to notify the plugin that + it should stop operating and should detach from + the repository. + + + + + + The repository for this plugin + + + The that this plugin is attached to. + + + + Gets or sets the that this plugin is + attached to. + + + + + + The name of this plugin. + + + + + The repository this plugin is attached to. + + + + + Plugin that listens for events from the + + + + This plugin publishes an instance of + on a specified . This listens for logging events delivered from + a remote . + + + When an event is received it is relogged within the attached repository + as if it had been raised locally. + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Initializes a new instance of the class. + + + The property must be set. + + + + + + Construct with sink Uri. + + The name to publish the sink under in the remoting infrastructure. + See for more details. + + + Initializes a new instance of the class + with specified name. + + + + + + Gets or sets the URI of this sink. + + + The URI of this sink. + + + + This is the name under which the object is marshaled. + + + + + + + Attaches this plugin to a . + + The that this plugin should be attached to. + + + A plugin may only be attached to a single repository. + + + This method is called when the plugin is attached to the repository. + + + + + + Is called when the plugin is to shutdown. + + + + When the plugin is shutdown the remote logging + sink is disconnected. + + + + + + The fully qualified type of the RemoteLoggingServerPlugin class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Delivers objects to a remote sink. + + + + Internal class used to listen for logging events + and deliver them to the local repository. + + + + + + Constructor + + The repository to log to. + + + Initializes a new instance of the for the + specified . + + + + + + Logs the events to the repository. + + The events to log. + + + The events passed are logged to the + + + + + + Obtains a lifetime service object to control the lifetime + policy for this instance. + + null to indicate that this instance should live forever. + + + Obtains a lifetime service object to control the lifetime + policy for this instance. This object should live forever + therefore this implementation returns null. + + + + + + The underlying that events should + be logged to. + + + + + + + + + + + + + + + + + + + + + Default implementation of + + + + This default implementation of the + interface is used to create the default subclass + of the object. + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Initializes a new instance of the class. + + + + + + Create a new instance + + The that will own the . + The name of the . + The instance for the specified name. + + + Create a new instance with the + specified name. + + + Called by the to create + new named instances. + + + If the is null then the root logger + must be returned. + + + + + + Default internal subclass of + + + + This subclass has no additional behavior over the + class but does allow instances + to be created. + + + + + + Construct a new Logger + + the name of the logger + + + Initializes a new instance of the class + with the specified name. + + + + + + Delegate used to handle logger creation event notifications. + + The in which the has been created. + The event args that hold the instance that has been created. + + + Delegate used to handle logger creation event notifications. + + + + + + Provides data for the event. + + + + A event is raised every time a + is created. + + + + + + The created + + + + + Constructor + + The that has been created. + + + Initializes a new instance of the event argument + class,with the specified . + + + + + + Gets the that has been created. + + + The that has been created. + + + + The that has been created. + + + + + + Hierarchical organization of loggers + + + + The casual user should not have to deal with this class + directly. + + + This class is specialized in retrieving loggers by name and + also maintaining the logger hierarchy. Implements the + interface. + + + The structure of the logger hierarchy is maintained by the + method. The hierarchy is such that children + link to their parent but parents do not have any references to their + children. Moreover, loggers can be instantiated in any order, in + particular descendant before ancestor. + + + In case a descendant is created before a particular ancestor, + then it creates a provision node for the ancestor and adds itself + to the provision node. Other descendants of the same ancestor add + themselves to the previously created provision node. + + + Nicko Cadell + Gert Driesen + + + + Event used to notify that a logger has been created. + + + + Event raised when a logger is created. + + + + + + Default constructor + + + + Initializes a new instance of the class. + + + + + + Construct with properties + + The properties to pass to this repository. + + + Initializes a new instance of the class. + + + + + + Construct with a logger factory + + The factory to use to create new logger instances. + + + Initializes a new instance of the class with + the specified . + + + + + + Construct with properties and a logger factory + + The properties to pass to this repository. + The factory to use to create new logger instances. + + + Initializes a new instance of the class with + the specified . + + + + + + Has no appender warning been emitted + + + + Flag to indicate if we have already issued a warning + about not having an appender warning. + + + + + + Get the root of this hierarchy + + + + Get the root of this hierarchy. + + + + + + Gets or sets the default instance. + + The default + + + The logger factory is used to create logger instances. + + + + + + Test if a logger exists + + The name of the logger to lookup + The Logger object with the name specified + + + Check if the named logger exists in the hierarchy. If so return + its reference, otherwise returns null. + + + + + + Returns all the currently defined loggers in the hierarchy as an Array + + All the defined loggers + + + Returns all the currently defined loggers in the hierarchy as an Array. + The root logger is not included in the returned + enumeration. + + + + + + Return a new logger instance named as the first parameter using + the default factory. + + + + Return a new logger instance named as the first parameter using + the default factory. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + + The name of the logger to retrieve + The logger object with the name specified + + + + Shutting down a hierarchy will safely close and remove + all appenders in all loggers including the root logger. + + + + Shutting down a hierarchy will safely close and remove + all appenders in all loggers including the root logger. + + + Some appenders need to be closed before the + application exists. Otherwise, pending logging events might be + lost. + + + The Shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Reset all values contained in this hierarchy instance to their default. + + + + Reset all values contained in this hierarchy instance to their + default. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set its default "off" value. + + + Existing loggers are not removed. They are just reset. + + + This method should be used sparingly and with care as it will + block all logging until it is completed. + + + + + + Log the logEvent through this hierarchy. + + the event to log + + + This method should not normally be used to log. + The interface should be used + for routine logging. This interface can be obtained + using the method. + + + The logEvent is delivered to the appropriate logger and + that logger is then responsible for logging the event. + + + + + + Returns all the Appenders that are currently configured + + An array containing all the currently configured appenders + + + Returns all the instances that are currently configured. + All the loggers are searched for appenders. The appenders may also be containers + for appenders and these are also searched for additional loggers. + + + The list returned is unordered but does not contain duplicates. + + + + + + Collect the appenders from an . + The appender may also be a container. + + + + + + + Collect the appenders from an container + + + + + + + Initialize the log4net system using the specified appender + + the appender to use to log all logging events + + + + Initialize the log4net system using the specified appenders + + the appenders to use to log all logging events + + + + Initialize the log4net system using the specified appenders + + the appenders to use to log all logging events + + + This method provides the same functionality as the + method implemented + on this object, but it is protected and therefore can be called by subclasses. + + + + + + Initialize the log4net system using the specified config + + the element containing the root of the config + + + + Initialize the log4net system using the specified config + + the element containing the root of the config + + + This method provides the same functionality as the + method implemented + on this object, but it is protected and therefore can be called by subclasses. + + + + + + Test if this hierarchy is disabled for the specified . + + The level to check against. + + true if the repository is disabled for the level argument, false otherwise. + + + + If this hierarchy has not been configured then this method will + always return true. + + + This method will return true if this repository is + disabled for level object passed as parameter and + false otherwise. + + + See also the property. + + + + + + Clear all logger definitions from the internal hashtable + + + + This call will clear all logger definitions from the internal + hashtable. Invoking this method will irrevocably mess up the + logger hierarchy. + + + You should really know what you are doing before + invoking this method. + + + + + + Return a new logger instance named as the first parameter using + . + + The name of the logger to retrieve + The factory that will make the new logger instance + The logger object with the name specified + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated by the + parameter and linked with its existing + ancestors as well as children. + + + + + + Sends a logger creation event to all registered listeners + + The newly created logger + + Raises the logger creation event. + + + + + Updates all the parents of the specified logger + + The logger to update the parents for + + + This method loops through all the potential parents of + . There 3 possible cases: + + + + No entry for the potential parent of exists + + We create a ProvisionNode for this potential + parent and insert in that provision node. + + + + The entry is of type Logger for the potential parent. + + The entry is 's nearest existing parent. We + update 's parent field with this entry. We also break from + he loop because updating our parent's parent is our parent's + responsibility. + + + + The entry is of type ProvisionNode for this potential parent. + + We add to the list of children for this + potential parent. + + + + + + + + Replace a with a in the hierarchy. + + + + + + We update the links for all the children that placed themselves + in the provision node 'pn'. The second argument 'log' is a + reference for the newly created Logger, parent of all the + children in 'pn'. + + + We loop on all the children 'c' in 'pn'. + + + If the child 'c' has been already linked to a child of + 'log' then there is no need to update 'c'. + + + Otherwise, we set log's parent field to c's parent and set + c's parent field to log. + + + + + + Define or redefine a Level using the values in the argument + + the level values + + + Define or redefine a Level using the values in the argument + + + Supports setting levels via the configuration file. + + + + + + A class to hold the value, name and display name for a level + + + + A class to hold the value, name and display name for a level + + + + + + Value of the level + + + + If the value is not set (defaults to -1) the value will be looked + up for the current level with the same name. + + + + + + Name of the level + + + The name of the level + + + + The name of the level. + + + + + + Display name for the level + + + The display name of the level + + + + The display name of the level. + + + + + + Override Object.ToString to return sensible debug info + + string info about this object + + + + Set a Property using the values in the argument + + the property value + + + Set a Property using the values in the argument. + + + Supports setting property values via the configuration file. + + + + + + The fully qualified type of the Hierarchy class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Interface abstracts creation of instances + + + + This interface is used by the to + create new objects. + + + The method is called + to create a named . + + + Implement this interface to create new subclasses of . + + + Nicko Cadell + Gert Driesen + + + + Create a new instance + + The that will own the . + The name of the . + The instance for the specified name. + + + Create a new instance with the + specified name. + + + Called by the to create + new named instances. + + + If the is null then the root logger + must be returned. + + + + + + Implementation of used by + + + + Internal class used to provide implementation of + interface. Applications should use to get + logger instances. + + + This is one of the central classes in the log4net implementation. One of the + distinctive features of log4net are hierarchical loggers and their + evaluation. The organizes the + instances into a rooted tree hierarchy. + + + The class is abstract. Only concrete subclasses of + can be created. The + is used to create instances of this type for the . + + + Nicko Cadell + Gert Driesen + Aspi Havewala + Douglas de la Torre + + + + This constructor created a new instance and + sets its name. + + The name of the . + + + This constructor is protected and designed to be used by + a subclass that is not abstract. + + + Loggers are constructed by + objects. See for the default + logger creator. + + + + + + Gets or sets the parent logger in the hierarchy. + + + The parent logger in the hierarchy. + + + + Part of the Composite pattern that makes the hierarchy. + The hierarchy is parent linked rather than child linked. + + + + + + Gets or sets a value indicating if child loggers inherit their parent's appenders. + + + true if child loggers inherit their parent's appenders. + + + + Additivity is set to true by default, that is children inherit + the appenders of their ancestors by default. If this variable is + set to false then the appenders found in the + ancestors of this logger are not used. However, the children + of this logger will inherit its appenders, unless the children + have their additivity flag set to false too. See + the user manual for more details. + + + + + + Gets the effective level for this logger. + + The nearest level in the logger hierarchy. + + + Starting from this logger, searches the logger hierarchy for a + non-null level and returns it. Otherwise, returns the level of the + root logger. + + The Logger class is designed so that this method executes as + quickly as possible. + + + + + Gets or sets the where this + Logger instance is attached to. + + The hierarchy that this logger belongs to. + + + This logger must be attached to a single . + + + + + + Gets or sets the assigned , if any, for this Logger. + + + The of this logger. + + + + The assigned can be null. + + + + + + Add to the list of appenders of this + Logger instance. + + An appender to add to this logger + + + Add to the list of appenders of this + Logger instance. + + + If is already in the list of + appenders, then it won't be added again. + + + + + + Get the appenders contained in this logger as an + . + + A collection of the appenders in this logger + + + Get the appenders contained in this logger as an + . If no appenders + can be found, then a is returned. + + + + + + Look for the appender named as name + + The name of the appender to lookup + The appender with the name specified, or null. + + + Returns the named appender, or null if the appender is not found. + + + + + + Remove all previously added appenders from this Logger instance. + + + + Remove all previously added appenders from this Logger instance. + + + This is useful when re-reading configuration information. + + + + + + Remove the appender passed as parameter form the list of appenders. + + The appender to remove + The appender removed from the list + + + Remove the appender passed as parameter form the list of appenders. + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + Remove the appender passed as parameter form the list of appenders. + + The name of the appender to remove + The appender removed from the list + + + Remove the named appender passed as parameter form the list of appenders. + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + Gets the logger name. + + + The name of the logger. + + + + The name of this logger + + + + + + This generic form is intended to be used by wrappers. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generate a logging event for the specified using + the and . + + + This method must not throw any exception to the caller. + + + + + + This is the most generic printing method that is intended to be used + by wrappers. + + The event being logged. + + + Logs the specified logging event through this logger. + + + This method must not throw any exception to the caller. + + + + + + Checks if this logger is enabled for a given passed as parameter. + + The level to check. + + true if this logger is enabled for level, otherwise false. + + + + Test if this logger is going to log events of the specified . + + + This method must not throw any exception to the caller. + + + + + + Gets the where this + Logger instance is attached to. + + + The that this logger belongs to. + + + + Gets the where this + Logger instance is attached to. + + + + + + Deliver the to the attached appenders. + + The event to log. + + + Call the appenders in the hierarchy starting at + this. If no appenders could be found, emit a + warning. + + + This method calls all the appenders inherited from the + hierarchy circumventing any evaluation of whether to log or not + to log the particular log request. + + + + + + Closes all attached appenders implementing the interface. + + + + Used to ensure that the appenders are correctly shutdown. + + + + + + This is the most generic printing method. This generic form is intended to be used by wrappers + + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generate a logging event for the specified using + the . + + + + + + Creates a new logging event and logs the event without further checks. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generates a logging event and delivers it to the attached + appenders. + + + + + + Creates a new logging event and logs the event without further checks. + + The event being logged. + + + Delivers the logging event to the attached appenders. + + + + + + The fully qualified type of the Logger class. + + + + + The name of this logger. + + + + + The assigned level of this logger. + + + + The level variable need not be + assigned a value in which case it is inherited + form the hierarchy. + + + + + + The parent of this logger. + + + + The parent of this logger. + All loggers have at least one ancestor which is the root logger. + + + + + + Loggers need to know what Hierarchy they are in. + + + + Loggers need to know what Hierarchy they are in. + The hierarchy that this logger is a member of is stored + here. + + + + + + Helper implementation of the interface + + + + + Flag indicating if child loggers inherit their parents appenders + + + + Additivity is set to true by default, that is children inherit + the appenders of their ancestors by default. If this variable is + set to false then the appenders found in the + ancestors of this logger are not used. However, the children + of this logger will inherit its appenders, unless the children + have their additivity flag set to false too. See + the user manual for more details. + + + + + + Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl + + + + + Used internally to accelerate hash table searches. + + + + Internal class used to improve performance of + string keyed hashtables. + + + The hashcode of the string is cached for reuse. + The string is stored as an interned value. + When comparing two objects for equality + the reference equality of the interned strings is compared. + + + Nicko Cadell + Gert Driesen + + + + Construct key with string name + + + + Initializes a new instance of the class + with the specified name. + + + Stores the hashcode of the string and interns + the string key to optimize comparisons. + + + The Compact Framework 1.0 the + method does not work. On the Compact Framework + the string keys are not interned nor are they + compared by reference. + + + The name of the logger. + + + + Returns a hash code for the current instance. + + A hash code for the current instance. + + + Returns the cached hashcode. + + + + + + Determines whether two instances + are equal. + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + Compares the references of the interned strings. + + + + + + Provision nodes are used where no logger instance has been specified + + + + instances are used in the + when there is no specified + for that node. + + + A provision node holds a list of child loggers on behalf of + a logger that does not exist. + + + Nicko Cadell + Gert Driesen + + + + Create a new provision node with child node + + A child logger to add to this node. + + + Initializes a new instance of the class + with the specified child logger. + + + + + + The sits at the root of the logger hierarchy tree. + + + + The is a regular except + that it provides several guarantees. + + + First, it cannot be assigned a null + level. Second, since the root logger cannot have a parent, the + property always returns the value of the + level field without walking the hierarchy. + + + Nicko Cadell + Gert Driesen + + + + Construct a + + The level to assign to the root logger. + + + Initializes a new instance of the class with + the specified logging level. + + + The root logger names itself as "root". However, the root + logger cannot be retrieved by name. + + + + + + Gets the assigned level value without walking the logger hierarchy. + + The assigned level value without walking the logger hierarchy. + + + Because the root logger cannot have a parent and its level + must not be null this property just returns the + value of . + + + + + + Gets or sets the assigned for the root logger. + + + The of the root logger. + + + + Setting the level of the root logger to a null reference + may have catastrophic results. We prevent this here. + + + + + + The fully qualified type of the RootLogger class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Initializes the log4net environment using an XML DOM. + + + + Configures a using an XML DOM. + + + Nicko Cadell + Gert Driesen + + + + Construct the configurator for a hierarchy + + The hierarchy to build. + + + Initializes a new instance of the class + with the specified . + + + + + + Configure the hierarchy by parsing a DOM tree of XML elements. + + The root element to parse. + + + Configure the hierarchy by parsing a DOM tree of XML elements. + + + + + + Parse appenders by IDREF. + + The appender ref element. + The instance of the appender that the ref refers to. + + + Parse an XML element that represents an appender and return + the appender. + + + + + + Parses an appender element. + + The appender element. + The appender instance or null when parsing failed. + + + Parse an XML element that represents an appender and return + the appender instance. + + + + + + Parses a logger element. + + The logger element. + + + Parse an XML element that represents a logger. + + + + + + Parses the root logger element. + + The root element. + + + Parse an XML element that represents the root logger. + + + + + + Parses the children of a logger element. + + The category element. + The logger instance. + Flag to indicate if the logger is the root logger. + + + Parse the child elements of a <logger> element. + + + + + + Parses an object renderer. + + The renderer element. + + + Parse an XML element that represents a renderer. + + + + + + Parses a level element. + + The level element. + The logger object to set the level on. + Flag to indicate if the logger is the root logger. + + + Parse an XML element that represents a level. + + + + + + Sets a parameter on an object. + + The parameter element. + The object to set the parameter on. + + The parameter name must correspond to a writable property + on the object. The value of the parameter is a string, + therefore this function will attempt to set a string + property first. If unable to set a string property it + will inspect the property and its argument type. It will + attempt to call a static method called Parse on the + type of the property. This method will take a single + string argument and return a value that can be used to + set the property. + + + + + Test if an element has no attributes or child elements + + the element to inspect + true if the element has any attributes or child elements, false otherwise + + + + Test if a is constructible with Activator.CreateInstance. + + the type to inspect + true if the type is creatable using a default constructor, false otherwise + + + + Look for a method on the that matches the supplied + + the type that has the method + the name of the method + the method info found + + + The method must be a public instance method on the . + The method must be named or "Add" followed by . + The method must take a single parameter. + + + + + + Converts a string value to a target type. + + The type of object to convert the string to. + The string value to use as the value of the object. + + + An object of type with value or + null when the conversion could not be performed. + + + + + + Creates an object as specified in XML. + + The XML element that contains the definition of the object. + The object type to use if not explicitly specified. + The type that the returned object must be or must inherit from. + The object or null + + + Parse an XML element and create an object instance based on the configuration + data. + + + The type of the instance may be specified in the XML. If not + specified then the is used + as the type. However the type is specified it must support the + type. + + + + + + key: appenderName, value: appender. + + + + + The Hierarchy being configured. + + + + + The fully qualified type of the XmlHierarchyConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Basic Configurator interface for repositories + + + + Interface used by basic configurator to configure a + with a default . + + + A should implement this interface to support + configuration by the . + + + Nicko Cadell + Gert Driesen + + + + Initialize the repository using the specified appender + + the appender to use to log all logging events + + + Configure the repository to route all logging events to the + specified appender. + + + + + + Initialize the repository using the specified appenders + + the appenders to use to log all logging events + + + Configure the repository to route all logging events to the + specified appenders. + + + + + + Delegate used to handle logger repository shutdown event notifications + + The that is shutting down. + Empty event args + + + Delegate used to handle logger repository shutdown event notifications. + + + + + + Delegate used to handle logger repository configuration reset event notifications + + The that has had its configuration reset. + Empty event args + + + Delegate used to handle logger repository configuration reset event notifications. + + + + + + Delegate used to handle event notifications for logger repository configuration changes. + + The that has had its configuration changed. + Empty event arguments. + + + Delegate used to handle event notifications for logger repository configuration changes. + + + + + + Interface implemented by logger repositories. + + + + This interface is implemented by logger repositories. e.g. + . + + + This interface is used by the + to obtain interfaces. + + + Nicko Cadell + Gert Driesen + + + + The name of the repository + + + The name of the repository + + + + The name of the repository. + + + + + + RendererMap accesses the object renderer map for this repository. + + + RendererMap accesses the object renderer map for this repository. + + + + RendererMap accesses the object renderer map for this repository. + + + The RendererMap holds a mapping between types and + objects. + + + + + + The plugin map for this repository. + + + The plugin map for this repository. + + + + The plugin map holds the instances + that have been attached to this repository. + + + + + + Get the level map for the Repository. + + + + Get the level map for the Repository. + + + The level map defines the mappings between + level names and objects in + this repository. + + + + + + The threshold for all events in this repository + + + The threshold for all events in this repository + + + + The threshold for all events in this repository. + + + + + + Check if the named logger exists in the repository. If so return + its reference, otherwise returns null. + + The name of the logger to lookup + The Logger object with the name specified + + + If the names logger exists it is returned, otherwise + null is returned. + + + + + + Returns all the currently defined loggers as an Array. + + All the defined loggers + + + Returns all the currently defined loggers as an Array. + + + + + + Returns a named logger instance + + The name of the logger to retrieve + The logger object with the name specified + + + Returns a named logger instance. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + + + + Shutdown the repository + + + Shutting down a repository will safely close and remove + all appenders in all loggers including the root logger. + + + Some appenders need to be closed before the + application exists. Otherwise, pending logging events might be + lost. + + + The method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Reset the repositories configuration to a default state + + + + Reset all values contained in this instance to their + default state. + + + Existing loggers are not removed. They are just reset. + + + This method should be used sparingly and with care as it will + block all logging until it is completed. + + + + + + Log the through this repository. + + the event to log + + + This method should not normally be used to log. + The interface should be used + for routine logging. This interface can be obtained + using the method. + + + The logEvent is delivered to the appropriate logger and + that logger is then responsible for logging the event. + + + + + + Flag indicates if this repository has been configured. + + + Flag indicates if this repository has been configured. + + + + Flag indicates if this repository has been configured. + + + + + + Collection of internal messages captured during the most + recent configuration process. + + + + + Event to notify that the repository has been shutdown. + + + Event to notify that the repository has been shutdown. + + + + Event raised when the repository has been shutdown. + + + + + + Event to notify that the repository has had its configuration reset. + + + Event to notify that the repository has had its configuration reset. + + + + Event raised when the repository's configuration has been + reset to default. + + + + + + Event to notify that the repository has had its configuration changed. + + + Event to notify that the repository has had its configuration changed. + + + + Event raised when the repository's configuration has been changed. + + + + + + Repository specific properties + + + Repository specific properties + + + + These properties can be specified on a repository specific basis. + + + + + + Returns all the Appenders that are configured as an Array. + + All the Appenders + + + Returns all the Appenders that are configured as an Array. + + + + + + Configure repository using XML + + + + Interface used by Xml configurator to configure a . + + + A should implement this interface to support + configuration by the . + + + Nicko Cadell + Gert Driesen + + + + Initialize the repository using the specified config + + the element containing the root of the config + + + The schema for the XML configuration data is defined by + the implementation. + + + + + + Base implementation of + + + + Default abstract implementation of the interface. + + + Skeleton implementation of the interface. + All types can extend this type. + + + Nicko Cadell + Gert Driesen + + + + Default Constructor + + + + Initializes the repository with default (empty) properties. + + + + + + Construct the repository using specific properties + + the properties to set for this repository + + + Initializes the repository with specified properties. + + + + + + The name of the repository + + + The string name of the repository + + + + The name of this repository. The name is + used to store and lookup the repositories + stored by the . + + + + + + The threshold for all events in this repository + + + The threshold for all events in this repository + + + + The threshold for all events in this repository + + + + + + RendererMap accesses the object renderer map for this repository. + + + RendererMap accesses the object renderer map for this repository. + + + + RendererMap accesses the object renderer map for this repository. + + + The RendererMap holds a mapping between types and + objects. + + + + + + The plugin map for this repository. + + + The plugin map for this repository. + + + + The plugin map holds the instances + that have been attached to this repository. + + + + + + Get the level map for the Repository. + + + + Get the level map for the Repository. + + + The level map defines the mappings between + level names and objects in + this repository. + + + + + + Test if logger exists + + The name of the logger to lookup + The Logger object with the name specified + + + Check if the named logger exists in the repository. If so return + its reference, otherwise returns null. + + + + + + Returns all the currently defined loggers in the repository + + All the defined loggers + + + Returns all the currently defined loggers in the repository as an Array. + + + + + + Return a new logger instance + + The name of the logger to retrieve + The logger object with the name specified + + + Return a new logger instance. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + + + + + Shutdown the repository + + + + Shutdown the repository. Can be overridden in a subclass. + This base class implementation notifies the + listeners and all attached plugins of the shutdown event. + + + + + + Reset the repositories configuration to a default state + + + + Reset all values contained in this instance to their + default state. + + + Existing loggers are not removed. They are just reset. + + + This method should be used sparingly and with care as it will + block all logging until it is completed. + + + + + + Log the logEvent through this repository. + + the event to log + + + This method should not normally be used to log. + The interface should be used + for routine logging. This interface can be obtained + using the method. + + + The logEvent is delivered to the appropriate logger and + that logger is then responsible for logging the event. + + + + + + Flag indicates if this repository has been configured. + + + Flag indicates if this repository has been configured. + + + + Flag indicates if this repository has been configured. + + + + + + Contains a list of internal messages captures during the + last configuration. + + + + + Event to notify that the repository has been shutdown. + + + Event to notify that the repository has been shutdown. + + + + Event raised when the repository has been shutdown. + + + + + + Event to notify that the repository has had its configuration reset. + + + Event to notify that the repository has had its configuration reset. + + + + Event raised when the repository's configuration has been + reset to default. + + + + + + Event to notify that the repository has had its configuration changed. + + + Event to notify that the repository has had its configuration changed. + + + + Event raised when the repository's configuration has been changed. + + + + + + Repository specific properties + + + Repository specific properties + + + These properties can be specified on a repository specific basis + + + + + Returns all the Appenders that are configured as an Array. + + All the Appenders + + + Returns all the Appenders that are configured as an Array. + + + + + + The fully qualified type of the LoggerRepositorySkeleton class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Adds an object renderer for a specific class. + + The type that will be rendered by the renderer supplied. + The object renderer used to render the object. + + + Adds an object renderer for a specific class. + + + + + + Notify the registered listeners that the repository is shutting down + + Empty EventArgs + + + Notify any listeners that this repository is shutting down. + + + + + + Notify the registered listeners that the repository has had its configuration reset + + Empty EventArgs + + + Notify any listeners that this repository's configuration has been reset. + + + + + + Notify the registered listeners that the repository has had its configuration changed + + Empty EventArgs + + + Notify any listeners that this repository's configuration has changed. + + + + + + Raise a configuration changed event on this repository + + EventArgs.Empty + + + Applications that programmatically change the configuration of the repository should + raise this event notification to notify listeners. + + + + + + Flushes all configured Appenders that implement . + + The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed, + or to wait indefinitely. + True if all logging events were flushed successfully, else false. + + + + The log4net Thread Context. + + + + The ThreadContext provides a location for thread specific debugging + information to be stored. + The ThreadContext properties override any + properties with the same name. + + + The thread context has a properties map and a stack. + The properties and stack can + be included in the output of log messages. The + supports selecting and outputting these properties. + + + The Thread Context provides a diagnostic context for the current thread. + This is an instrument for distinguishing interleaved log + output from different sources. Log output is typically interleaved + when a server handles multiple clients near-simultaneously. + + + The Thread Context is managed on a per thread basis. + + + Example of using the thread context properties to store a username. + + ThreadContext.Properties["user"] = userName; + log.Info("This log message has a ThreadContext Property called 'user'"); + + + Example of how to push a message into the context stack + + using(ThreadContext.Stacks["NDC"].Push("my context message")) + { + log.Info("This log message has a ThreadContext Stack message that includes 'my context message'"); + + } // at the end of the using block the message is automatically popped + + + + Nicko Cadell + + + + Private Constructor. + + + + Uses a private access modifier to prevent instantiation of this class. + + + + + + The thread properties map + + + The thread properties map + + + + The ThreadContext properties override any + properties with the same name. + + + + + + The thread stacks + + + stack map + + + + The thread local stacks. + + + + + + The thread context properties instance + + + + + The thread context stacks instance + + + + + A straightforward implementation of the interface. + + + + This is the default implementation of the + interface. Implementors of the interface + should aggregate an instance of this type. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Append on on all attached appenders. + + The event being logged. + The number of appenders called. + + + Calls the method on all + attached appenders. + + + + + + Append on on all attached appenders. + + The array of events being logged. + The number of appenders called. + + + Calls the method on all + attached appenders. + + + + + + Calls the DoAppende method on the with + the objects supplied. + + The appender + The events + + + If the supports the + interface then the will be passed + through using that interface. Otherwise the + objects in the array will be passed one at a time. + + + + + + Attaches an appender. + + The appender to add. + + + If the appender is already in the list it won't be added again. + + + + + + Gets all attached appenders. + + + A collection of attached appenders, or null if there + are no attached appenders. + + + + The read only collection of all currently attached appenders. + + + + + + Gets an attached appender with the specified name. + + The name of the appender to get. + + The appender with the name specified, or null if no appender with the + specified name is found. + + + + Lookup an attached appender by name. + + + + + + Removes all attached appenders. + + + + Removes and closes all attached appenders + + + + + + Removes the specified appender from the list of attached appenders. + + The appender to remove. + The appender removed from the list + + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + Removes the appender with the specified name from the list of appenders. + + The name of the appender to remove. + The appender removed from the list + + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + List of appenders + + + + + Array of appenders, used to cache the m_appenderList + + + + + The fully qualified type of the AppenderAttachedImpl class. + + + Used by the internal logger to record the Type of the + log message. + + + + + This class aggregates several PropertiesDictionary collections together. + + + + Provides a dictionary style lookup over an ordered list of + collections. + + + Nicko Cadell + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Gets the value of a property + + + The value for the property with the specified key + + + + Looks up the value for the specified. + The collections are searched + in the order in which they were added to this collection. The value + returned is the value held by the first collection that contains + the specified key. + + + If none of the collections contain the specified key then + null is returned. + + + + + + Add a Properties Dictionary to this composite collection + + the properties to add + + + Properties dictionaries added first take precedence over dictionaries added + later. + + + + + + Flatten this composite collection into a single properties dictionary + + the flattened dictionary + + + Reduces the collection of ordered dictionaries to a single dictionary + containing the resultant values for the keys. + + + + + + Base class for Context Properties implementations + + + + This class defines a basic property get set accessor + + + Nicko Cadell + + + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Gets or sets the value of a property + + + + + + Wrapper class used to map converter names to converter types + + + + Pattern converter info class used during configuration by custom + PatternString and PatternLayer converters. + + + + + + default constructor + + + + + Gets or sets the name of the conversion pattern + + + + The name of the pattern in the format string + + + + + + Gets or sets the type of the converter + + + + The value specified must extend the + type. + + + + + + + + + + + + + + + + + Subclass of that maintains a count of + the number of bytes written. + + + + This writer counts the number of bytes written. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + The to actually write to. + The to report errors to. + + + Creates a new instance of the class + with the specified and . + + + + + + Writes a character to the underlying writer and counts the number of bytes written. + + the char to write + + + Overrides implementation of . Counts + the number of bytes written. + + + + + + Writes a buffer to the underlying writer and counts the number of bytes written. + + the buffer to write + the start index to write from + the number of characters to write + + + Overrides implementation of . Counts + the number of bytes written. + + + + + + Writes a string to the output and counts the number of bytes written. + + The string data to write to the output. + + + Overrides implementation of . Counts + the number of bytes written. + + + + + + Gets or sets the total number of bytes written. + + + The total number of bytes written. + + + + Gets or sets the total number of bytes written. + + + + + + Total number of bytes written. + + + + + A fixed size rolling buffer of logging events. + + + + An array backed fixed size leaky bucket. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + The maximum number of logging events in the buffer. + + + Initializes a new instance of the class with + the specified maximum number of buffered logging events. + + + The argument is not a positive integer. + + + + Appends a to the buffer. + + The event to append to the buffer. + The event discarded from the buffer, if the buffer is full, otherwise null. + + + Append an event to the buffer. If the buffer still contains free space then + null is returned. If the buffer is full then an event will be dropped + to make space for the new event, the event dropped is returned. + + + + + + Get and remove the oldest event in the buffer. + + The oldest logging event in the buffer + + + Gets the oldest (first) logging event in the buffer and removes it + from the buffer. + + + + + + Pops all the logging events from the buffer into an array. + + An array of all the logging events in the buffer. + + + Get all the events in the buffer and clear the buffer. + + + + + + Clear the buffer + + + + Clear the buffer of all events. The events in the buffer are lost. + + + + + + Gets the th oldest event currently in the buffer. + + The th oldest event currently in the buffer. + + + If is outside the range 0 to the number of events + currently in the buffer, then null is returned. + + + + + + Gets the maximum size of the buffer. + + The maximum size of the buffer. + + + Gets the maximum size of the buffer + + + + + + Gets the number of logging events in the buffer. + + The number of logging events in the buffer. + + + This number is guaranteed to be in the range 0 to + (inclusive). + + + + + + An always empty . + + + + A singleton implementation of the + interface that always represents an empty collection. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to enforce the singleton pattern. + + + + + + Gets the singleton instance of the empty collection. + + The singleton instance of the empty collection. + + + Gets the singleton instance of the empty collection. + + + + + + Copies the elements of the to an + , starting at a particular Array index. + + The one-dimensional + that is the destination of the elements copied from + . The Array must have zero-based + indexing. + The zero-based index in array at which + copying begins. + + + As the collection is empty no values are copied into the array. + + + + + + Gets a value indicating if access to the is synchronized (thread-safe). + + + true if access to the is synchronized (thread-safe); otherwise, false. + + + + For the this property is always true. + + + + + + Gets the number of elements contained in the . + + + The number of elements contained in the . + + + + As the collection is empty the is always 0. + + + + + + Gets an object that can be used to synchronize access to the . + + + An object that can be used to synchronize access to the . + + + + As the collection is empty and thread safe and synchronized this instance is also + the object. + + + + + + Returns an enumerator that can iterate through a collection. + + + An that can be used to + iterate through the collection. + + + + As the collection is empty a is returned. + + + + + + The singleton instance of the empty collection. + + + + + An always empty . + + + + A singleton implementation of the + interface that always represents an empty collection. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to enforce the singleton pattern. + + + + + + Gets the singleton instance of the . + + The singleton instance of the . + + + Gets the singleton instance of the . + + + + + + Copies the elements of the to an + , starting at a particular Array index. + + The one-dimensional + that is the destination of the elements copied from + . The Array must have zero-based + indexing. + The zero-based index in array at which + copying begins. + + + As the collection is empty no values are copied into the array. + + + + + + Gets a value indicating if access to the is synchronized (thread-safe). + + + true if access to the is synchronized (thread-safe); otherwise, false. + + + + For the this property is always true. + + + + + + Gets the number of elements contained in the + + + The number of elements contained in the . + + + + As the collection is empty the is always 0. + + + + + + Gets an object that can be used to synchronize access to the . + + + An object that can be used to synchronize access to the . + + + + As the collection is empty and thread safe and synchronized this instance is also + the object. + + + + + + Returns an enumerator that can iterate through a collection. + + + An that can be used to + iterate through the collection. + + + + As the collection is empty a is returned. + + + + + + Adds an element with the provided key and value to the + . + + The to use as the key of the element to add. + The to use as the value of the element to add. + + + As the collection is empty no new values can be added. A + is thrown if this method is called. + + + This dictionary is always empty and cannot be modified. + + + + Removes all elements from the . + + + + As the collection is empty no values can be removed. A + is thrown if this method is called. + + + This dictionary is always empty and cannot be modified. + + + + Determines whether the contains an element + with the specified key. + + The key to locate in the . + false + + + As the collection is empty the method always returns false. + + + + + + Returns an enumerator that can iterate through a collection. + + + An that can be used to + iterate through the collection. + + + + As the collection is empty a is returned. + + + + + + Removes the element with the specified key from the . + + The key of the element to remove. + + + As the collection is empty no values can be removed. A + is thrown if this method is called. + + + This dictionary is always empty and cannot be modified. + + + + Gets a value indicating whether the has a fixed size. + + true + + + As the collection is empty always returns true. + + + + + + Gets a value indicating whether the is read-only. + + true + + + As the collection is empty always returns true. + + + + + + Gets an containing the keys of the . + + An containing the keys of the . + + + As the collection is empty a is returned. + + + + + + Gets an containing the values of the . + + An containing the values of the . + + + As the collection is empty a is returned. + + + + + + Gets or sets the element with the specified key. + + The key of the element to get or set. + null + + + As the collection is empty no values can be looked up or stored. + If the index getter is called then null is returned. + A is thrown if the setter is called. + + + This dictionary is always empty and cannot be modified. + + + + The singleton instance of the empty dictionary. + + + + + Contain the information obtained when parsing formatting modifiers + in conversion modifiers. + + + + Holds the formatting information extracted from the format string by + the . This is used by the + objects when rendering the output. + + + Nicko Cadell + Gert Driesen + + + + Defaut Constructor + + + + Initializes a new instance of the class. + + + + + + Constructor + + + + Initializes a new instance of the class + with the specified parameters. + + + + + + Gets or sets the minimum value. + + + The minimum value. + + + + Gets or sets the minimum value. + + + + + + Gets or sets the maximum value. + + + The maximum value. + + + + Gets or sets the maximum value. + + + + + + Gets or sets a flag indicating whether left align is enabled + or not. + + + A flag indicating whether left align is enabled or not. + + + + Gets or sets a flag indicating whether left align is enabled or not. + + + + + + Implementation of Properties collection for the + + + + This class implements a properties collection that is thread safe and supports both + storing properties and capturing a read only copy of the current propertied. + + + This class is optimized to the scenario where the properties are read frequently + and are modified infrequently. + + + Nicko Cadell + + + + The read only copy of the properties. + + + + This variable is declared volatile to prevent the compiler and JIT from + reordering reads and writes of this thread performed on different threads. + + + + + + Lock object used to synchronize updates within this instance + + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Reading the value for a key is faster than setting the value. + When the value is written a new read only copy of + the properties is created. + + + + + + Remove a property from the global context + + the key for the entry to remove + + + Removing an entry from the global context properties is relatively expensive compared + with reading a value. + + + + + + Clear the global context properties + + + + + Get a readonly immutable copy of the properties + + the current global context properties + + + This implementation is fast because the GlobalContextProperties class + stores a readonly copy of the properties. + + + + + + The static class ILogExtensions contains a set of widely used + methods that ease the interaction with the ILog interface implementations. + + + + This class contains methods for logging at different levels and checks the + properties for determining if those logging levels are enabled in the current + configuration. + + + Simple example of logging messages + + using log4net.Util; + + ILog log = LogManager.GetLogger("application-log"); + + log.InfoExt("Application Start"); + log.DebugExt("This is a debug message"); + + + + + + The fully qualified type of the Logger class. + + + + + Log a message object with the level. + + The logger on which the message is logged. + The lambda expression that gets the object to log. + + + This method first checks if this logger is INFO + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is INFO enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate . + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The logger on which the message is logged. + The lambda expression that gets the object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a message object with the level. //TODO + + Log a message object with the level. + + The logger on which the message is logged. + The message object to log. + + + This method first checks if this logger is INFO + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is INFO enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The logger on which the message is logged. + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Log a message object with the level. + + The logger on which the message is logged. + The lambda expression that gets the object to log. + + + This method first checks if this logger is INFO + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is INFO enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate . + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The logger on which the message is logged. + The lambda expression that gets the object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a message object with the level. //TODO + + Log a message object with the level. + + The logger on which the message is logged. + The message object to log. + + + This method first checks if this logger is INFO + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is INFO enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The logger on which the message is logged. + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Log a message object with the level. + + The logger on which the message is logged. + The lambda expression that gets the object to log. + + + This method first checks if this logger is WARN + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is WARN enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate . + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The logger on which the message is logged. + The lambda expression that gets the object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a message object with the level. //TODO + + Log a message object with the level. + + The logger on which the message is logged. + The message object to log. + + + This method first checks if this logger is WARN + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is WARN enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The logger on which the message is logged. + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Log a message object with the level. + + The logger on which the message is logged. + The lambda expression that gets the object to log. + + + This method first checks if this logger is ERROR + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is ERROR enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate . + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The logger on which the message is logged. + The lambda expression that gets the object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a message object with the level. //TODO + + Log a message object with the level. + + The logger on which the message is logged. + The message object to log. + + + This method first checks if this logger is ERROR + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is ERROR enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The logger on which the message is logged. + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Log a message object with the level. + + The logger on which the message is logged. + The lambda expression that gets the object to log. + + + This method first checks if this logger is FATAL + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is FATAL enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate . + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The logger on which the message is logged. + The lambda expression that gets the object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a message object with the level. //TODO + + Log a message object with the level. + + The logger on which the message is logged. + The message object to log. + + + This method first checks if this logger is FATAL + enabled by reading the value property. + This check happens always and does not depend on the + implementation. If this logger is FATAL enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The logger on which the message is logged. + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + The logger on which the message is logged. + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + The logger on which the message is logged. + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Manages a mapping from levels to + + + + Manages an ordered mapping from instances + to subclasses. + + + Nicko Cadell + + + + Default constructor + + + + Initialise a new instance of . + + + + + + Add a to this mapping + + the entry to add + + + If a has previously been added + for the same then that entry will be + overwritten. + + + + + + Lookup the mapping for the specified level + + the level to lookup + the for the level or null if no mapping found + + + Lookup the value for the specified level. Finds the nearest + mapping value for the level that is equal to or less than the + specified. + + + If no mapping could be found then null is returned. + + + + + + Initialize options + + + + Caches the sorted list of in an array + + + + + + An entry in the + + + + This is an abstract base class for types that are stored in the + object. + + + Nicko Cadell + + + + Default protected constructor + + + + Default protected constructor + + + + + + The level that is the key for this mapping + + + The that is the key for this mapping + + + + Get or set the that is the key for this + mapping subclass. + + + + + + Initialize any options defined on this entry + + + + Should be overridden by any classes that need to initialise based on their options + + + + + + Implementation of Properties collection for the + + + + Class implements a collection of properties that is specific to each thread. + The class is not synchronized as each thread has its own . + + + This class stores its properties in a slot on the named + log4net.Util.LogicalThreadContextProperties. + + + For .NET Standard 1.3 this class uses + System.Threading.AsyncLocal rather than . + + + The requires a link time + for the + . + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + + + Nicko Cadell + + + + Flag used to disable this context if we don't have permission to access the CallContext. + + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Get or set the property value for the specified. + + + + + + Remove a property + + the key for the entry to remove + + + Remove the value for the specified from the context. + + + + + + Clear all the context properties + + + + Clear all the context properties + + + + + + Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread. + + create the dictionary if it does not exist, otherwise return null if is does not exist + the properties for this thread + + + The collection returned is only to be used on the calling thread. If the + caller needs to share the collection between different threads then the + caller must clone the collection before doings so. + + + + + + Gets the call context get data. + + The peroperties dictionary stored in the call context + + The method has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. + + + + + Sets the call context data. + + The properties. + + The method has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. + + + + + The fully qualified type of the LogicalThreadContextProperties class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Delegate type used for LogicalThreadContextStack's callbacks. + + + + + Implementation of Stack for the + + + + Implementation of Stack for the + + + Nicko Cadell + + + + The stack store. + + + + + The name of this within the + . + + + + + The callback used to let the register a + new instance of a . + + + + + Internal constructor + + + + Initializes a new instance of the class. + + + + + + The number of messages in the stack + + + The current number of messages in the stack + + + + The current number of messages in the stack. That is + the number of times has been called + minus the number of times has been called. + + + + + + Clears all the contextual information held in this stack. + + + + Clears all the contextual information held in this stack. + Only call this if you think that this thread is being reused after + a previous call execution which may not have completed correctly. + You do not need to use this method if you always guarantee to call + the method of the + returned from even in exceptional circumstances, + for example by using the using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message")) + syntax. + + + + + + Removes the top context from this stack. + + The message in the context that was removed from the top of this stack. + + + Remove the top context from this stack, and return + it to the caller. If this stack is empty then an + empty string (not ) is returned. + + + + + + Pushes a new context message into this stack. + + The new context message. + + An that can be used to clean up the context stack. + + + + Pushes a new context onto this stack. An + is returned that can be used to clean up this stack. This + can be easily combined with the using keyword to scope the + context. + + + Simple example of using the Push method with the using keyword. + + using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message")) + { + log.Warn("This should have an ThreadContext Stack message"); + } + + + + + + Gets the current context information for this stack. + + The current context information. + + + + Gets and sets the internal stack used by this + + The internal storage stack + + + This property is provided only to support backward compatability + of the . Tytpically the internal stack should not + be modified. + + + + + + Gets the current context information for this stack. + + Gets the current context information + + + Gets the current context information for this stack. + + + + + + Get a portable version of this object + + the portable instance of this object + + + Get a cross thread portable version of this object + + + + + + Inner class used to represent a single context frame in the stack. + + + + Inner class used to represent a single context frame in the stack. + + + + + + Constructor + + The message for this context. + The parent context in the chain. + + + Initializes a new instance of the class + with the specified message and parent context. + + + + + + Get the message. + + The message. + + + Get the message. + + + + + + Gets the full text of the context down to the root level. + + + The full text of the context down to the root level. + + + + Gets the full text of the context down to the root level. + + + + + + Struct returned from the method. + + + + This struct implements the and is designed to be used + with the pattern to remove the stack frame at the end of the scope. + + + + + + The depth to trim the stack to when this instance is disposed + + + + + The outer LogicalThreadContextStack. + + + + + Constructor + + The internal stack used by the ThreadContextStack. + The depth to return the stack to when this object is disposed. + + + Initializes a new instance of the class with + the specified stack and return depth. + + + + + + Returns the stack to the correct depth. + + + + Returns the stack to the correct depth. + + + + + + Implementation of Stacks collection for the + + + + Implementation of Stacks collection for the + + + Nicko Cadell + + + + Internal constructor + + + + Initializes a new instance of the class. + + + + + + Gets the named thread context stack + + + The named stack + + + + Gets the named thread context stack + + + + + + The fully qualified type of the ThreadContextStacks class. + + + Used by the internal logger to record the Type of the + log message. + + + + + + + + + + + + Outputs log statements from within the log4net assembly. + + + + Log4net components cannot make log4net logging calls. However, it is + sometimes useful for the user to learn about what log4net is + doing. + + + All log4net internal debug calls go to the standard output stream + whereas internal error messages are sent to the standard error output + stream. + + + Nicko Cadell + Gert Driesen + + + + The event raised when an internal message has been received. + + + + + The Type that generated the internal message. + + + + + The DateTime stamp of when the internal message was received. + + + + + The UTC DateTime stamp of when the internal message was received. + + + + + A string indicating the severity of the internal message. + + + "log4net: ", + "log4net:ERROR ", + "log4net:WARN " + + + + + The internal log message. + + + + + The Exception related to the message. + + + Optional. Will be null if no Exception was passed. + + + + + Formats Prefix, Source, and Message in the same format as the value + sent to Console.Out and Trace.Write. + + + + + + Initializes a new instance of the class. + + + + + + + + + Static constructor that initializes logging by reading + settings from the application configuration file. + + + + The log4net.Internal.Debug application setting + controls internal debugging. This setting should be set + to true to enable debugging. + + + The log4net.Internal.Quiet application setting + suppresses all internal logging including error messages. + This setting should be set to true to enable message + suppression. + + + + + + Gets or sets a value indicating whether log4net internal logging + is enabled or disabled. + + + true if log4net internal logging is enabled, otherwise + false. + + + + When set to true, internal debug level logging will be + displayed. + + + This value can be set by setting the application setting + log4net.Internal.Debug in the application configuration + file. + + + The default value is false, i.e. debugging is + disabled. + + + + + The following example enables internal debugging using the + application configuration file : + + + + + + + + + + + + + Gets or sets a value indicating whether log4net should generate no output + from internal logging, not even for errors. + + + true if log4net should generate no output at all from internal + logging, otherwise false. + + + + When set to true will cause internal logging at all levels to be + suppressed. This means that no warning or error reports will be logged. + This option overrides the setting and + disables all debug also. + + This value can be set by setting the application setting + log4net.Internal.Quiet in the application configuration file. + + + The default value is false, i.e. internal logging is not + disabled. + + + + The following example disables internal logging using the + application configuration file : + + + + + + + + + + + + + + + + + Raises the LogReceived event when an internal messages is received. + + + + + + + + + Test if LogLog.Debug is enabled for output. + + + true if Debug is enabled + + + + Test if LogLog.Debug is enabled for output. + + + + + + Writes log4net internal debug messages to the + standard output stream. + + + The message to log. + + + All internal debug messages are prepended with + the string "log4net: ". + + + + + + Writes log4net internal debug messages to the + standard output stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal debug messages are prepended with + the string "log4net: ". + + + + + + Test if LogLog.Warn is enabled for output. + + + true if Warn is enabled + + + + Test if LogLog.Warn is enabled for output. + + + + + + Writes log4net internal warning messages to the + standard error stream. + + The Type that generated this message. + The message to log. + + + All internal warning messages are prepended with + the string "log4net:WARN ". + + + + + + Writes log4net internal warning messages to the + standard error stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal warning messages are prepended with + the string "log4net:WARN ". + + + + + + Test if LogLog.Error is enabled for output. + + + true if Error is enabled + + + + Test if LogLog.Error is enabled for output. + + + + + + Writes log4net internal error messages to the + standard error stream. + + The Type that generated this message. + The message to log. + + + All internal error messages are prepended with + the string "log4net:ERROR ". + + + + + + Writes log4net internal error messages to the + standard error stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal debug messages are prepended with + the string "log4net:ERROR ". + + + + + + Writes output to the standard output stream. + + The message to log. + + + Writes to both Console.Out and System.Diagnostics.Trace. + Note that the System.Diagnostics.Trace is not supported + on the Compact Framework. + + + If the AppDomain is not configured with a config file then + the call to System.Diagnostics.Trace may fail. This is only + an issue if you are programmatically creating your own AppDomains. + + + + + + Writes output to the standard error stream. + + The message to log. + + + Writes to both Console.Error and System.Diagnostics.Trace. + Note that the System.Diagnostics.Trace is not supported + on the Compact Framework. + + + If the AppDomain is not configured with a config file then + the call to System.Diagnostics.Trace may fail. This is only + an issue if you are programmatically creating your own AppDomains. + + + + + + Default debug level + + + + + In quietMode not even errors generate any output. + + + + + Subscribes to the LogLog.LogReceived event and stores messages + to the supplied IList instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a native error code and message. + + + + Represents a Win32 platform native error. + + + Nicko Cadell + Gert Driesen + + + + Create an instance of the class with the specified + error number and message. + + The number of the native error. + The message of the native error. + + + Create an instance of the class with the specified + error number and message. + + + + + + Gets the number of the native error. + + + The number of the native error. + + + + Gets the number of the native error. + + + + + + Gets the message of the native error. + + + The message of the native error. + + + + + Gets the message of the native error. + + + + + Create a new instance of the class for the last Windows error. + + + An instance of the class for the last windows error. + + + + The message for the error number is lookup up using the + native Win32 FormatMessage function. + + + + + + Create a new instance of the class. + + the error number for the native error + + An instance of the class for the specified + error number. + + + + The message for the specified error number is lookup up using the + native Win32 FormatMessage function. + + + + + + Retrieves the message corresponding with a Win32 message identifier. + + Message identifier for the requested message. + + The message corresponding with the specified message identifier. + + + + The message will be searched for in system message-table resource(s) + using the native FormatMessage function. + + + + + + Return error information string + + error information string + + + Return error information string + + + + + + Formats a message string. + + Formatting options, and how to interpret the parameter. + Location of the message definition. + Message identifier for the requested message. + Language identifier for the requested message. + If includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the LocalAlloc function, and places the pointer to the buffer at the address specified in . + If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer. + Pointer to an array of values that are used as insert values in the formatted message. + + + The function requires a message definition as input. The message definition can come from a + buffer passed into the function. It can come from a message table resource in an + already-loaded module. Or the caller can ask the function to search the system's message + table resource(s) for the message definition. The function finds the message definition + in a message table resource based on a message identifier and a language identifier. + The function copies the formatted message text to an output buffer, processing any embedded + insert sequences if requested. + + + To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message. + + + + + If the function succeeds, the return value is the number of TCHARs stored in the output + buffer, excluding the terminating null character. + + + If the function fails, the return value is zero. To get extended error information, + call . + + + + + + An always empty . + + + + A singleton implementation of the over a collection + that is empty and not modifiable. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to enforce the singleton pattern. + + + + + + Gets the singleton instance of the . + + The singleton instance of the . + + + Gets the singleton instance of the . + + + + + + Gets the current object from the enumerator. + + + Throws an because the + never has a current value. + + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will throw an . + + + The collection is empty and + cannot be positioned over a valid location. + + + + Test if the enumerator can advance, if so advance. + + false as the cannot advance. + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will always return false. + + + + + + Resets the enumerator back to the start. + + + + As the enumerator is over an empty collection does nothing. + + + + + + Gets the current key from the enumerator. + + + Throws an exception because the + never has a current value. + + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will throw an . + + + The collection is empty and + cannot be positioned over a valid location. + + + + Gets the current value from the enumerator. + + The current value from the enumerator. + + Throws an because the + never has a current value. + + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will throw an . + + + The collection is empty and + cannot be positioned over a valid location. + + + + Gets the current entry from the enumerator. + + + Throws an because the + never has a current entry. + + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will throw an . + + + The collection is empty and + cannot be positioned over a valid location. + + + + The singleton instance of the . + + + + + An always empty . + + + + A singleton implementation of the over a collection + that is empty and not modifiable. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to enforce the singleton pattern. + + + + + + Get the singleton instance of the . + + The singleton instance of the . + + + Gets the singleton instance of the . + + + + + + Gets the current object from the enumerator. + + + Throws an because the + never has a current value. + + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will throw an . + + + The collection is empty and + cannot be positioned over a valid location. + + + + Test if the enumerator can advance, if so advance + + false as the cannot advance. + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will always return false. + + + + + + Resets the enumerator back to the start. + + + + As the enumerator is over an empty collection does nothing. + + + + + + The singleton instance of the . + + + + + A SecurityContext used when a SecurityContext is not required + + + + The is a no-op implementation of the + base class. It is used where a + is required but one has not been provided. + + + Nicko Cadell + + + + Singleton instance of + + + + Singleton instance of + + + + + + Private constructor + + + + Private constructor for singleton pattern. + + + + + + Impersonate this SecurityContext + + State supplied by the caller + null + + + No impersonation is done and null is always returned. + + + + + + Implements log4net's default error handling policy which consists + of emitting a message for the first error in an appender and + ignoring all subsequent errors. + + + + The error message is processed using the LogLog sub-system by default. + + + This policy aims at protecting an otherwise working application + from being flooded with error messages when logging fails. + + + Nicko Cadell + Gert Driesen + Ron Grabowski + + + + Default Constructor + + + + Initializes a new instance of the class. + + + + + + Constructor + + The prefix to use for each message. + + + Initializes a new instance of the class + with the specified prefix. + + + + + + Reset the error handler back to its initial disabled state. + + + + + Log an Error + + The error message. + The exception. + The internal error code. + + + Invokes if and only if this is the first error or the first error after has been called. + + + + + + Log the very first error + + The error message. + The exception. + The internal error code. + + + Sends the error information to 's Error method. + + + + + + Log an Error + + The error message. + The exception. + + + Invokes if and only if this is the first error or the first error after has been called. + + + + + + Log an error + + The error message. + + + Invokes if and only if this is the first error or the first error after has been called. + + + + + + Is error logging enabled + + + + Is error logging enabled. Logging is only enabled for the + first error delivered to the . + + + + + + The date the first error that trigged this error handler occurred, or if it has not been triggered. + + + + + The UTC date the first error that trigged this error handler occured, or if it has not been triggered. + + + + + The message from the first error that trigged this error handler. + + + + + The exception from the first error that trigged this error handler. + + + May be . + + + + + The error code from the first error that trigged this error handler. + + + Defaults to + + + + + The UTC date the error was recorded. + + + + + Flag to indicate if it is the first error + + + + + The message recorded during the first error. + + + + + The exception recorded during the first error. + + + + + The error code recorded during the first error. + + + + + String to prefix each message with + + + + + The fully qualified type of the OnlyOnceErrorHandler class. + + + Used by the internal logger to record the Type of the + log message. + + + + + A convenience class to convert property values to specific types. + + + + Utility functions for converting types and parsing values. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to prevent instantiation of this class. + + + + + + Converts a string to a value. + + String to convert. + The default value. + The value of . + + + If is "true", then true is returned. + If is "false", then false is returned. + Otherwise, is returned. + + + + + + Parses a file size into a number. + + String to parse. + The default value. + The value of . + + + Parses a file size of the form: number[KB|MB|GB] into a + long value. It is scaled with the appropriate multiplier. + + + is returned when + cannot be converted to a value. + + + + + + Converts a string to an object. + + The target type to convert to. + The string to convert to an object. + + The object converted from a string or null when the + conversion failed. + + + + Converts a string to an object. Uses the converter registry to try + to convert the string value into the specified target type. + + + + + + Checks if there is an appropriate type conversion from the source type to the target type. + + The type to convert from. + The type to convert to. + true if there is a conversion from the source type to the target type. + + Checks if there is an appropriate type conversion from the source type to the target type. + + + + + + + Converts an object to the target type. + + The object to convert to the target type. + The type to convert to. + The converted object. + + + Converts an object to the target type. + + + + + + Instantiates an object given a class name. + + The fully qualified class name of the object to instantiate. + The class to which the new object should belong. + The object to return in case of non-fulfillment. + + An instance of the or + if the object could not be instantiated. + + + + Checks that the is a subclass of + . If that test fails or the object could + not be instantiated, then is returned. + + + + + + Performs variable substitution in string from the + values of keys found in . + + The string on which variable substitution is performed. + The dictionary to use to lookup variables. + The result of the substitutions. + + + The variable substitution delimiters are ${ and }. + + + For example, if props contains key=value, then the call + + + + string s = OptionConverter.SubstituteVariables("Value of key is ${key}."); + + + + will set the variable s to "Value of key is value.". + + + If no value could be found for the specified key, then substitution + defaults to an empty string. + + + For example, if system properties contains no value for the key + "nonExistentKey", then the call + + + + string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]"); + + + + will set s to "Value of nonExistentKey is []". + + + An Exception is thrown if contains a start + delimiter "${" which is not balanced by a stop delimiter "}". + + + + + + Converts the string representation of the name or numeric value of one or + more enumerated constants to an equivalent enumerated object. + + The type to convert to. + The enum string value. + If true, ignore case; otherwise, regard case. + An object of type whose value is represented by . + + + + The fully qualified type of the OptionConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Abstract class that provides the formatting functionality that + derived classes need. + + + + Conversion specifiers in a conversion patterns are parsed to + individual PatternConverters. Each of which is responsible for + converting a logging event in a converter specific manner. + + + Nicko Cadell + Gert Driesen + + + + Protected constructor + + + + Initializes a new instance of the class. + + + + + + Get the next pattern converter in the chain + + + the next pattern converter in the chain + + + + Get the next pattern converter in the chain + + + + + + Gets or sets the formatting info for this converter + + + The formatting info for this converter + + + + Gets or sets the formatting info for this converter + + + + + + Gets or sets the option value for this converter + + + The option for this converter + + + + Gets or sets the option value for this converter + + + + + + Evaluate this pattern converter and write the output to a writer. + + that will receive the formatted result. + The state object on which the pattern converter should be executed. + + + Derived pattern converters must override this method in order to + convert conversion specifiers in the appropriate way. + + + + + + Set the next pattern converter in the chains + + the pattern converter that should follow this converter in the chain + the next converter + + + The PatternConverter can merge with its neighbor during this method (or a sub class). + Therefore the return value may or may not be the value of the argument passed in. + + + + + + Write the pattern converter to the writer with appropriate formatting + + that will receive the formatted result. + The state object on which the pattern converter should be executed. + + + This method calls to allow the subclass to perform + appropriate conversion of the pattern converter. If formatting options have + been specified via the then this method will + apply those formattings before writing the output. + + + + + + Fast space padding method. + + to which the spaces will be appended. + The number of spaces to be padded. + + + Fast space padding method. + + + + + + The option string to the converter + + + + + Initial buffer size + + + + + Maximum buffer size before it is recycled + + + + + Write an dictionary to a + + the writer to write to + a to use for object conversion + the value to write to the writer + + + Writes the to a writer in the form: + + + {key1=value1, key2=value2, key3=value3} + + + If the specified + is not null then it is used to render the key and value to text, otherwise + the object's ToString method is called. + + + + + + Write an dictionary to a + + the writer to write to + a to use for object conversion + the value to write to the writer + + + Writes the to a writer in the form: + + + {key1=value1, key2=value2, key3=value3} + + + If the specified + is not null then it is used to render the key and value to text, otherwise + the object's ToString method is called. + + + + + + Write an object to a + + the writer to write to + a to use for object conversion + the value to write to the writer + + + Writes the Object to a writer. If the specified + is not null then it is used to render the object to text, otherwise + the object's ToString method is called. + + + + + + + + + + + Most of the work of the class + is delegated to the PatternParser class. + + + + The PatternParser processes a pattern string and + returns a chain of objects. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + The pattern to parse. + + + Initializes a new instance of the class + with the specified pattern string. + + + + + + Parses the pattern into a chain of pattern converters. + + The head of a chain of pattern converters. + + + Parses the pattern into a chain of pattern converters. + + + + + + Get the converter registry used by this parser + + + The converter registry used by this parser + + + + Get the converter registry used by this parser + + + + + + Build the unified cache of converters from the static and instance maps + + the list of all the converter names + + + Build the unified cache of converters from the static and instance maps + + + + + + Sort strings by length + + + + that orders strings by string length. + The longest strings are placed first + + + + + + Internal method to parse the specified pattern to find specified matches + + the pattern to parse + the converter names to match in the pattern + + + The matches param must be sorted such that longer strings come before shorter ones. + + + + + + Process a parsed literal + + the literal text + + + + Process a parsed converter pattern + + the name of the converter + the optional option for the converter + the formatting info for the converter + + + + Resets the internal state of the parser and adds the specified pattern converter + to the chain. + + The pattern converter to add. + + + + The first pattern converter in the chain + + + + + the last pattern converter in the chain + + + + + The pattern + + + + + Internal map of converter identifiers to converter types + + + + This map overrides the static s_globalRulesRegistry map. + + + + + + The fully qualified type of the PatternParser class. + + + Used by the internal logger to record the Type of the + log message. + + + + + This class implements a patterned string. + + + + This string has embedded patterns that are resolved and expanded + when the string is formatted. + + + This class functions similarly to the + in that it accepts a pattern and renders it to a string. Unlike the + however the PatternString + does not render the properties of a specific but + of the process in general. + + + The recognized conversion pattern names are: + + + + Conversion Pattern Name + Effect + + + appdomain + + + Used to output the friendly name of the current AppDomain. + + + + + appsetting + + + Used to output the value of a specific appSetting key in the application + configuration file. + + + + + date + + + Used to output the current date and time in the local time zone. + To output the date in universal time use the %utcdate pattern. + The date conversion + specifier may be followed by a date format specifier enclosed + between braces. For example, %date{HH:mm:ss,fff} or + %date{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is + given then ISO8601 format is + assumed (). + + + The date format specifier admits the same syntax as the + time pattern string of the . + + + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + , + and respectively + . For example, + %date{ISO8601} or %date{ABSOLUTE}. + + + These dedicated date formatters perform significantly + better than . + + + + + env + + + Used to output the a specific environment variable. The key to + lookup must be specified within braces and directly following the + pattern specifier, e.g. %env{COMPUTERNAME} would include the value + of the COMPUTERNAME environment variable. + + + The env pattern is not supported on the .NET Compact Framework. + + + + + identity + + + Used to output the user name for the currently active user + (Principal.Identity.Name). + + + + + newline + + + Outputs the platform dependent line separator character or + characters. + + + This conversion pattern name offers the same performance as using + non-portable line separator strings such as "\n", or "\r\n". + Thus, it is the preferred way of specifying a line separator. + + + + + processid + + + Used to output the system process ID for the current process. + + + + + property + + + Used to output a specific context property. The key to + lookup must be specified within braces and directly following the + pattern specifier, e.g. %property{user} would include the value + from the property that is keyed by the string 'user'. Each property value + that is to be included in the log must be specified separately. + Properties are stored in logging contexts. By default + the log4net:HostName property is set to the name of machine on + which the event was originally logged. + + + If no key is specified, e.g. %property then all the keys and their + values are printed in a comma separated list. + + + The properties of an event are combined from a number of different + contexts. These are listed below in the order in which they are searched. + + + + the thread properties + + The that are set on the current + thread. These properties are shared by all events logged on this thread. + + + + the global properties + + The that are set globally. These + properties are shared by all the threads in the AppDomain. + + + + + + + random + + + Used to output a random string of characters. The string is made up of + uppercase letters and numbers. By default the string is 4 characters long. + The length of the string can be specified within braces directly following the + pattern specifier, e.g. %random{8} would output an 8 character string. + + + + + username + + + Used to output the WindowsIdentity for the currently + active user. + + + + + utcdate + + + Used to output the date of the logging event in universal time. + The date conversion + specifier may be followed by a date format specifier enclosed + between braces. For example, %utcdate{HH:mm:ss,fff} or + %utcdate{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is + given then ISO8601 format is + assumed (). + + + The date format specifier admits the same syntax as the + time pattern string of the . + + + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + , + and respectively + . For example, + %utcdate{ISO8601} or %utcdate{ABSOLUTE}. + + + These dedicated date formatters perform significantly + better than . + + + + + % + + + The sequence %% outputs a single percent sign. + + + + + + Additional pattern converters may be registered with a specific + instance using or + . + + + See the for details on the + format modifiers supported by the patterns. + + + Nicko Cadell + + + + Internal map of converter identifiers to converter types. + + + + + the pattern + + + + + the head of the pattern converter chain + + + + + patterns defined on this PatternString only + + + + + Initialize the global registry + + + + + Default constructor + + + + Initialize a new instance of + + + + + + Constructs a PatternString + + The pattern to use with this PatternString + + + Initialize a new instance of with the pattern specified. + + + + + + Gets or sets the pattern formatting string + + + The pattern formatting string + + + + The ConversionPattern option. This is the string which + controls formatting and consists of a mix of literal content and + conversion specifiers. + + + + + + Initialize object options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Create the used to parse the pattern + + the pattern to parse + The + + + Returns PatternParser used to parse the conversion string. Subclasses + may override this to return a subclass of PatternParser which recognize + custom conversion pattern name. + + + + + + Produces a formatted string as specified by the conversion pattern. + + The TextWriter to write the formatted event to + + + Format the pattern to the . + + + + + + Format the pattern as a string + + the pattern formatted as a string + + + Format the pattern to a string. + + + + + + Add a converter to this PatternString + + the converter info + + + This version of the method is used by the configurator. + Programmatic users should use the alternative method. + + + + + + Add a converter to this PatternString + + the name of the conversion pattern for this converter + the type of the converter + + + Add a converter to this PatternString + + + + + + Write the name of the current AppDomain to the output + + + + Write the name of the current AppDomain to the output writer + + + Nicko Cadell + + + + Write the name of the current AppDomain to the output + + the writer to write to + null, state is not set + + + Writes name of the current AppDomain to the output . + + + + + + AppSetting pattern converter + + + + This pattern converter reads appSettings from the application configuration file. + + + If the is specified then that will be used to + lookup a single appSettings value. If no is specified + then all appSettings will be dumped as a list of key value pairs. + + + A typical use is to specify a base directory for log files, e.g. + + + + + ... + + + ]]> + + + + + + + Write the property value to the output + + that will receive the formatted result. + null, state is not set + + + Writes out the value of a named property. The property name + should be set in the + property. + + + If the is set to null + then all the properties are written as key value pairs. + + + + + + Write the current date to the output + + + + Date pattern converter, uses a to format + the current date and time to the writer as a string. + + + The value of the determines + the formatting of the date. The following values are allowed: + + + Option value + Output + + + ISO8601 + + Uses the formatter. + Formats using the "yyyy-MM-dd HH:mm:ss,fff" pattern. + + + + DATE + + Uses the formatter. + Formats using the "dd MMM yyyy HH:mm:ss,fff" for example, "06 Nov 1994 15:49:37,459". + + + + ABSOLUTE + + Uses the formatter. + Formats using the "HH:mm:ss,fff" for example, "15:49:37,459". + + + + other + + Any other pattern string uses the formatter. + This formatter passes the pattern string to the + method. + For details on valid patterns see + DateTimeFormatInfo Class. + + + + + + The date and time is in the local time zone and is rendered in that zone. + To output the time in Universal time see . + + + Nicko Cadell + + + + The used to render the date to a string + + + + The used to render the date to a string + + + + + + Initialize the converter options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Write the current date to the output + + that will receive the formatted result. + null, state is not set + + + Pass the current date and time to the + for it to render it to the writer. + + + The date and time passed is in the local time zone. + + + + + + The fully qualified type of the DatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write an folder path to the output + + + + Write an special path environment folder path to the output writer. + The value of the determines + the name of the variable to output. + should be a value in the enumeration. + + + Ron Grabowski + + + + Write an special path environment folder path to the output + + the writer to write to + null, state is not set + + + Writes the special path environment folder path to the output . + The name of the special path environment folder path to output must be set + using the + property. + + + + + + The fully qualified type of the EnvironmentFolderPathPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write an environment variable to the output + + + + Write an environment variable to the output writer. + The value of the determines + the name of the variable to output. + + + Nicko Cadell + + + + Write an environment variable to the output + + the writer to write to + null, state is not set + + + Writes the environment variable to the output . + The name of the environment variable to output must be set + using the + property. + + + + + + The fully qualified type of the EnvironmentPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the current thread identity to the output + + + + Write the current thread identity to the output writer + + + Nicko Cadell + + + + Write the current thread identity to the output + + the writer to write to + null, state is not set + + + Writes the current thread identity to the output . + + + + + + The fully qualified type of the IdentityPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Pattern converter for literal string instances in the pattern + + + + Writes the literal string value specified in the + property to + the output. + + + Nicko Cadell + + + + Set the next converter in the chain + + The next pattern converter in the chain + The next pattern converter + + + Special case the building of the pattern converter chain + for instances. Two adjacent + literals in the pattern can be represented by a single combined + pattern converter. This implementation detects when a + is added to the chain + after this converter and combines its value with this converter's + literal value. + + + + + + Write the literal to the output + + the writer to write to + null, not set + + + Override the formatting behavior to ignore the FormattingInfo + because we have a literal instead. + + + Writes the value of + to the output . + + + + + + Convert this pattern into the rendered message + + that will receive the formatted result. + null, not set + + + This method is not used. + + + + + + Writes a newline to the output + + + + Writes the system dependent line terminator to the output. + This behavior can be overridden by setting the : + + + + Option Value + Output + + + DOS + DOS or Windows line terminator "\r\n" + + + UNIX + UNIX line terminator "\n" + + + + Nicko Cadell + + + + Initialize the converter + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Write the current process ID to the output + + + + Write the current process ID to the output writer + + + Nicko Cadell + + + + Write the current process ID to the output + + the writer to write to + null, state is not set + + + Write the current process ID to the output . + + + + + + The fully qualified type of the ProcessIdPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Property pattern converter + + + + This pattern converter reads the thread and global properties. + The thread properties take priority over global properties. + See for details of the + thread properties. See for + details of the global properties. + + + If the is specified then that will be used to + lookup a single property. If no is specified + then all properties will be dumped as a list of key value pairs. + + + Nicko Cadell + + + + Write the property value to the output + + that will receive the formatted result. + null, state is not set + + + Writes out the value of a named property. The property name + should be set in the + property. + + + If the is set to null + then all the properties are written as key value pairs. + + + + + + A Pattern converter that generates a string of random characters + + + + The converter generates a string of random characters. By default + the string is length 4. This can be changed by setting the + to the string value of the length required. + + + The random characters in the string are limited to uppercase letters + and numbers only. + + + The random number generator used by this class is not cryptographically secure. + + + Nicko Cadell + + + + Shared random number generator + + + + + Length of random string to generate. Default length 4. + + + + + Initialize the converter options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Write a randoim string to the output + + the writer to write to + null, state is not set + + + Write a randoim string to the output . + + + + + + The fully qualified type of the RandomStringPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the current threads username to the output + + + + Write the current threads username to the output writer + + + Nicko Cadell + + + + Write the current threads username to the output + + the writer to write to + null, state is not set + + + Write the current threads username to the output . + + + + + + The fully qualified type of the UserNamePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the UTC date time to the output + + + + Date pattern converter, uses a to format + the current date and time in Universal time. + + + See the for details on the date pattern syntax. + + + + Nicko Cadell + + + + Write the current date and time to the output + + that will receive the formatted result. + null, state is not set + + + Pass the current date and time to the + for it to render it to the writer. + + + The date is in Universal time when it is rendered. + + + + + + + The fully qualified type of the UtcDatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + String keyed object map. + + + + While this collection is serializable only member + objects that are serializable will + be serialized along with this collection. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Constructor + + properties to copy + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + with serialized data. + + The that holds the serialized object data. + The that contains contextual information about the source or destination. + + + Because this class is sealed the serialization constructor is private. + + + + + + Gets or sets the value of the property with the specified key. + + + The value of the property with the specified key. + + The key of the property to get or set. + + + The property value will only be serialized if it is serializable. + If it cannot be serialized it will be silently ignored if + a serialization operation is performed. + + + + + + Remove the entry with the specified key from this dictionary + + the key for the entry to remove + + + Remove the entry with the specified key from this dictionary + + + + + + See + + an enumerator + + + Returns a over the contest of this collection. + + + + + + See + + the key to remove + + + Remove the entry with the specified key from this dictionary + + + + + + See + + the key to lookup in the collection + true if the collection contains the specified key + + + Test if this collection contains a specified key. + + + + + + Remove all properties from the properties collection + + + + Remove all properties from the properties collection + + + + + + See + + the key + the value to store for the key + + + Store a value for the specified . + + + Thrown if the is not a string + + + + See + + + false + + + + This collection is modifiable. This property always + returns false. + + + + + + See + + + The value for the key specified. + + + + Get or set a value for the specified . + + + Thrown if the is not a string + + + + See + + + + + See + + + + + See + + + + + See + + + + + + + See + + + + + See + + + + + See + + + + + A class to hold the key and data for a property set in the config file + + + + A class to hold the key and data for a property set in the config file + + + + + + Property Key + + + Property Key + + + + Property Key. + + + + + + Property Value + + + Property Value + + + + Property Value. + + + + + + Override Object.ToString to return sensible debug info + + string info about this object + + + + A that ignores the message + + + + This writer is used in special cases where it is necessary + to protect a writer from being closed by a client. + + + Nicko Cadell + + + + Constructor + + the writer to actually write to + + + Create a new ProtectCloseTextWriter using a writer + + + + + + Attach this instance to a different underlying + + the writer to attach to + + + Attach this instance to a different underlying + + + + + + Does not close the underlying output writer. + + + + Does not close the underlying output writer. + This method does nothing. + + + + + + that does not leak exceptions + + + + does not throw exceptions when things go wrong. + Instead, it delegates error handling to its . + + + Nicko Cadell + Gert Driesen + + + + Constructor + + the writer to actually write to + the error handler to report error to + + + Create a new QuietTextWriter using a writer and error handler + + + + + + Gets or sets the error handler that all errors are passed to. + + + The error handler that all errors are passed to. + + + + Gets or sets the error handler that all errors are passed to. + + + + + + Gets a value indicating whether this writer is closed. + + + true if this writer is closed, otherwise false. + + + + Gets a value indicating whether this writer is closed. + + + + + + Writes a character to the underlying writer + + the char to write + + + Writes a character to the underlying writer + + + + + + Writes a buffer to the underlying writer + + the buffer to write + the start index to write from + the number of characters to write + + + Writes a buffer to the underlying writer + + + + + + Writes a string to the output. + + The string data to write to the output. + + + Writes a string to the output. + + + + + + Closes the underlying output writer. + + + + Closes the underlying output writer. + + + + + + The error handler instance to pass all errors to + + + + + Flag to indicate if this writer is closed + + + + + Defines a lock that supports single writers and multiple readers + + + + ReaderWriterLock is used to synchronize access to a resource. + At any given time, it allows either concurrent read access for + multiple threads, or write access for a single thread. In a + situation where a resource is changed infrequently, a + ReaderWriterLock provides better throughput than a simple + one-at-a-time lock, such as . + + + If a platform does not support a System.Threading.ReaderWriterLock + implementation then all readers and writers are serialized. Therefore + the caller must not rely on multiple simultaneous readers. + + + Nicko Cadell + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Acquires a reader lock + + + + blocks if a different thread has the writer + lock, or if at least one thread is waiting for the writer lock. + + + + + + Decrements the lock count + + + + decrements the lock count. When the count + reaches zero, the lock is released. + + + + + + Acquires the writer lock + + + + This method blocks if another thread has a reader lock or writer lock. + + + + + + Decrements the lock count on the writer lock + + + + ReleaseWriterLock decrements the writer lock count. + When the count reaches zero, the writer lock is released. + + + + + + String keyed object map that is read only. + + + + This collection is readonly and cannot be modified. + + + While this collection is serializable only member + objects that are serializable will + be serialized along with this collection. + + + Nicko Cadell + Gert Driesen + + + + The Hashtable used to store the properties data + + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Copy Constructor + + properties to copy + + + Initializes a new instance of the class. + + + + + + Deserialization constructor + + The that holds the serialized object data. + The that contains contextual information about the source or destination. + + + Initializes a new instance of the class + with serialized data. + + + + + + Gets the key names. + + An array of all the keys. + + + Gets the key names. + + + + + + Gets or sets the value of the property with the specified key. + + + The value of the property with the specified key. + + The key of the property to get or set. + + + The property value will only be serialized if it is serializable. + If it cannot be serialized it will be silently ignored if + a serialization operation is performed. + + + + + + Test if the dictionary contains a specified key + + the key to look for + true if the dictionary contains the specified key + + + Test if the dictionary contains a specified key + + + + + + The hashtable used to store the properties + + + The internal collection used to store the properties + + + + The hashtable used to store the properties + + + + + + Serializes this object into the provided. + + The to populate with data. + The destination for this serialization. + + + Serializes this object into the provided. + + + + + + See + + + + + See + + + + + + See + + + + + + + Remove all properties from the properties collection + + + + + See + + + + + + + See + + + + + See + + + + + See + + + + + See + + + + + See + + + + + See + + + + + + + See + + + + + The number of properties in this collection + + + + + See + + + + + See + + + + + A that can be and reused + + + + A that can be and reused. + This uses a single buffer for string operations. + + + Nicko Cadell + + + + Create an instance of + + the format provider to use + + + Create an instance of + + + + + + Override Dispose to prevent closing of writer + + flag + + + Override Dispose to prevent closing of writer + + + + + + Reset this string writer so that it can be reused. + + the maximum buffer capacity before it is trimmed + the default size to make the buffer + + + Reset this string writer so that it can be reused. + The internal buffers are cleared and reset. + + + + + + Utility class for system specific information. + + + + Utility class of static methods for system specific information. + + + Nicko Cadell + Gert Driesen + Alexey Solofnenko + + + + Private constructor to prevent instances. + + + + Only static methods are exposed from this type. + + + + + + Initialize default values for private static fields. + + + + Only static methods are exposed from this type. + + + + + + Gets the system dependent line terminator. + + + The system dependent line terminator. + + + + Gets the system dependent line terminator. + + + + + + Gets the base directory for this . + + The base directory path for the current . + + + Gets the base directory for this . + + + The value returned may be either a local file path or a URI. + + + + + + Gets the path to the configuration file for the current . + + The path to the configuration file for the current . + + + The .NET Compact Framework 1.0 does not have a concept of a configuration + file. For this runtime, we use the entry assembly location as the root for + the configuration file name. + + + The value returned may be either a local file path or a URI. + + + + + + Gets the path to the file that first executed in the current . + + The path to the entry assembly. + + + Gets the path to the file that first executed in the current . + + + + + + Gets the ID of the current thread. + + The ID of the current thread. + + + On the .NET framework, the AppDomain.GetCurrentThreadId method + is used to obtain the thread ID for the current thread. This is the + operating system ID for the thread. + + + On the .NET Compact Framework 1.0 it is not possible to get the + operating system thread ID for the current thread. The native method + GetCurrentThreadId is implemented inline in a header file + and cannot be called. + + + On the .NET Framework 2.0 the Thread.ManagedThreadId is used as this + gives a stable id unrelated to the operating system thread ID which may + change if the runtime is using fibers. + + + + + + Get the host name or machine name for the current machine + + + The hostname or machine name + + + + Get the host name or machine name for the current machine + + + The host name () or + the machine name (Environment.MachineName) for + the current machine, or if neither of these are available + then NOT AVAILABLE is returned. + + + + + + Get this application's friendly name + + + The friendly name of this application as a string + + + + If available the name of the application is retrieved from + the AppDomain using AppDomain.CurrentDomain.FriendlyName. + + + Otherwise the file name of the entry assembly is used. + + + + + + Get the start time for the current process. + + + + This is the time at which the log4net library was loaded into the + AppDomain. Due to reports of a hang in the call to System.Diagnostics.Process.StartTime + this is not the start time for the current process. + + + The log4net library should be loaded by an application early during its + startup, therefore this start time should be a good approximation for + the actual start time. + + + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating, however this start time + will be set per AppDomain. + + + + + + Get the UTC start time for the current process. + + + + This is the UTC time at which the log4net library was loaded into the + AppDomain. Due to reports of a hang in the call to System.Diagnostics.Process.StartTime + this is not the start time for the current process. + + + The log4net library should be loaded by an application early during its + startup, therefore this start time should be a good approximation for + the actual start time. + + + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating, however this start time + will be set per AppDomain. + + + + + + Text to output when a null is encountered. + + + + Use this value to indicate a null has been encountered while + outputting a string representation of an item. + + + The default value is (null). This value can be overridden by specifying + a value for the log4net.NullText appSetting in the application's + .config file. + + + + + + Text to output when an unsupported feature is requested. + + + + Use this value when an unsupported feature is requested. + + + The default value is NOT AVAILABLE. This value can be overridden by specifying + a value for the log4net.NotAvailableText appSetting in the application's + .config file. + + + + + + Gets the assembly location path for the specified assembly. + + The assembly to get the location for. + The location of the assembly. + + + This method does not guarantee to return the correct path + to the assembly. If only tries to give an indication as to + where the assembly was loaded from. + + + + + + Gets the fully qualified name of the , including + the name of the assembly from which the was + loaded. + + The to get the fully qualified name for. + The fully qualified name for the . + + + This is equivalent to the Type.AssemblyQualifiedName property, + but this method works on the .NET Compact Framework 1.0 as well as + the full .NET runtime. + + + + + + Gets the short name of the . + + The to get the name for. + The short name of the . + + + The short name of the assembly is the + without the version, culture, or public key. i.e. it is just the + assembly's file name without the extension. + + + Use this rather than Assembly.GetName().Name because that + is not available on the Compact Framework. + + + Because of a FileIOPermission security demand we cannot do + the obvious Assembly.GetName().Name. We are allowed to get + the of the assembly so we + start from there and strip out just the assembly name. + + + + + + Gets the file name portion of the , including the extension. + + The to get the file name for. + The file name of the assembly. + + + Gets the file name portion of the , including the extension. + + + + + + Loads the type specified in the type string. + + A sibling type to use to load the type. + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified, it will be loaded from the assembly + containing the specified relative type. If the type is not found in the assembly + then all the loaded assemblies will be searched for the type. + + + + + + Loads the type specified in the type string. + + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified it will be loaded from the + assembly that is directly calling this method. If the type is not found + in the assembly then all the loaded assemblies will be searched for the type. + + + + + + Loads the type specified in the type string. + + An assembly to load the type from. + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified it will be loaded from the specified + assembly. If the type is not found in the assembly then all the loaded assemblies + will be searched for the type. + + + + + + Generate a new guid + + A new Guid + + + Generate a new guid + + + + + + Create an + + The name of the parameter that caused the exception + The value of the argument that causes this exception + The message that describes the error + the ArgumentOutOfRangeException object + + + Create a new instance of the class + with a specified error message, the parameter name, and the value + of the argument. + + + The Compact Framework does not support the 3 parameter constructor for the + type. This method provides an + implementation that works for all platforms. + + + + + + Parse a string into an value + + the string to parse + out param where the parsed value is placed + true if the string was able to be parsed into an integer + + + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns false. The method does not throw an exception. + + + + + + Parse a string into an value + + the string to parse + out param where the parsed value is placed + true if the string was able to be parsed into an integer + + + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns false. The method does not throw an exception. + + + + + + Parse a string into an value + + the string to parse + out param where the parsed value is placed + true if the string was able to be parsed into an integer + + + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns false. The method does not throw an exception. + + + + + + Lookup an application setting + + the application settings key to lookup + the value for the key, or null + + + Configuration APIs are not supported under the Compact Framework + + + + + + Convert a path into a fully qualified local file path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + + The path specified must be a local file path, a URI is not supported. + + + + + + Creates a new case-insensitive instance of the class with the default initial capacity. + + A new case-insensitive instance of the class with the default initial capacity + + + The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer. + + + + + + Tests two strings for equality, the ignoring case. + + + If the platform permits, culture information is ignored completely (ordinal comparison). + The aim of this method is to provide a fast comparison that deals with null and ignores different casing. + It is not supposed to deal with various, culture-specific habits. + Use it to compare against pure ASCII constants, like keywords etc. + + The one string. + The other string. + true if the strings are equal, false otherwise. + + + + Gets an empty array of types. + + + + The Type.EmptyTypes field is not available on + the .NET Compact Framework 1.0. + + + + + + The fully qualified type of the SystemInfo class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Cache the host name for the current machine + + + + + Cache the application friendly name + + + + + Text to output when a null is encountered. + + + + + Text to output when an unsupported feature is requested. + + + + + Start time for the current process. + + + + + Utility class that represents a format string. + + + + Utility class that represents a format string. + + + Nicko Cadell + + + + Initialise the + + An that supplies culture-specific formatting information. + A containing zero or more format items. + An array containing zero or more objects to format. + + + + Format the string and arguments + + the formatted string + + + + Replaces the format item in a specified with the text equivalent + of the value of a corresponding instance in a specified array. + A specified parameter supplies culture-specific formatting information. + + An that supplies culture-specific formatting information. + A containing zero or more format items. + An array containing zero or more objects to format. + + A copy of format in which the format items have been replaced by the + equivalent of the corresponding instances of in args. + + + + This method does not throw exceptions. If an exception thrown while formatting the result the + exception and arguments are returned in the result string. + + + + + + Process an error during StringFormat + + + + + Dump the contents of an array into a string builder + + + + + Dump an object to a string + + + + + The fully qualified type of the SystemStringFormat class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Adapter that extends and forwards all + messages to an instance of . + + + + Adapter that extends and forwards all + messages to an instance of . + + + Nicko Cadell + + + + The writer to forward messages to + + + + + Create an instance of that forwards all + messages to a . + + The to forward to + + + Create an instance of that forwards all + messages to a . + + + + + + Gets or sets the underlying . + + + The underlying . + + + + Gets or sets the underlying . + + + + + + The Encoding in which the output is written + + + The + + + + The Encoding in which the output is written + + + + + + Gets an object that controls formatting + + + The format provider + + + + Gets an object that controls formatting + + + + + + Gets or sets the line terminator string used by the TextWriter + + + The line terminator to use + + + + Gets or sets the line terminator string used by the TextWriter + + + + + + Closes the writer and releases any system resources associated with the writer + + + + + + + + + Dispose this writer + + flag indicating if we are being disposed + + + Dispose this writer + + + + + + Flushes any buffered output + + + + Clears all buffers for the writer and causes any buffered data to be written + to the underlying device + + + + + + Writes a character to the wrapped TextWriter + + the value to write to the TextWriter + + + Writes a character to the wrapped TextWriter + + + + + + Writes a character buffer to the wrapped TextWriter + + the data buffer + the start index + the number of characters to write + + + Writes a character buffer to the wrapped TextWriter + + + + + + Writes a string to the wrapped TextWriter + + the value to write to the TextWriter + + + Writes a string to the wrapped TextWriter + + + + + + Implementation of Properties collection for the + + + + Class implements a collection of properties that is specific to each thread. + The class is not synchronized as each thread has its own . + + + Nicko Cadell + + + + Each thread will automatically have its instance. + + + + + Internal constructor + + + + Initializes a new instance of the class. + + + + + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Gets or sets the value of a property + + + + + + Remove a property + + the key for the entry to remove + + + Remove a property + + + + + + Get the keys stored in the properties. + + + Gets the keys stored in the properties. + + a set of the defined keys + + + + Clear all properties + + + + Clear all properties + + + + + + Get the PropertiesDictionary for this thread. + + create the dictionary if it does not exist, otherwise return null if does not exist + the properties for this thread + + + The collection returned is only to be used on the calling thread. If the + caller needs to share the collection between different threads then the + caller must clone the collection before doing so. + + + + + + Implementation of Stack for the + + + + Implementation of Stack for the + + + Nicko Cadell + + + + The stack store. + + + + + Internal constructor + + + + Initializes a new instance of the class. + + + + + + The number of messages in the stack + + + The current number of messages in the stack + + + + The current number of messages in the stack. That is + the number of times has been called + minus the number of times has been called. + + + + + + Clears all the contextual information held in this stack. + + + + Clears all the contextual information held in this stack. + Only call this if you think that this tread is being reused after + a previous call execution which may not have completed correctly. + You do not need to use this method if you always guarantee to call + the method of the + returned from even in exceptional circumstances, + for example by using the using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message")) + syntax. + + + + + + Removes the top context from this stack. + + The message in the context that was removed from the top of this stack. + + + Remove the top context from this stack, and return + it to the caller. If this stack is empty then an + empty string (not ) is returned. + + + + + + Pushes a new context message into this stack. + + The new context message. + + An that can be used to clean up the context stack. + + + + Pushes a new context onto this stack. An + is returned that can be used to clean up this stack. This + can be easily combined with the using keyword to scope the + context. + + + Simple example of using the Push method with the using keyword. + + using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message")) + { + log.Warn("This should have an ThreadContext Stack message"); + } + + + + + + Gets the current context information for this stack. + + The current context information. + + + + Gets and sets the internal stack used by this + + The internal storage stack + + + This property is provided only to support backward compatability + of the . Tytpically the internal stack should not + be modified. + + + + + + Gets the current context information for this stack. + + Gets the current context information + + + Gets the current context information for this stack. + + + + + + Get a portable version of this object + + the portable instance of this object + + + Get a cross thread portable version of this object + + + + + + Inner class used to represent a single context frame in the stack. + + + + Inner class used to represent a single context frame in the stack. + + + + + + Constructor + + The message for this context. + The parent context in the chain. + + + Initializes a new instance of the class + with the specified message and parent context. + + + + + + Get the message. + + The message. + + + Get the message. + + + + + + Gets the full text of the context down to the root level. + + + The full text of the context down to the root level. + + + + Gets the full text of the context down to the root level. + + + + + + Struct returned from the method. + + + + This struct implements the and is designed to be used + with the pattern to remove the stack frame at the end of the scope. + + + + + + The ThreadContextStack internal stack + + + + + The depth to trim the stack to when this instance is disposed + + + + + Constructor + + The internal stack used by the ThreadContextStack. + The depth to return the stack to when this object is disposed. + + + Initializes a new instance of the class with + the specified stack and return depth. + + + + + + Returns the stack to the correct depth. + + + + Returns the stack to the correct depth. + + + + + + Implementation of Stacks collection for the + + + + Implementation of Stacks collection for the + + + Nicko Cadell + + + + Internal constructor + + + + Initializes a new instance of the class. + + + + + + Gets the named thread context stack + + + The named stack + + + + Gets the named thread context stack + + + + + + The fully qualified type of the ThreadContextStacks class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Utility class for transforming strings. + + + + Utility class for transforming strings. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to prevent instantiation of this class. + + + + + + Write a string to an + + the writer to write to + the string to write + The string to replace non XML compliant chars with + + + The test is escaped either using XML escape entities + or using CDATA sections. + + + + + + Replace invalid XML characters in text string + + the XML text input string + the string to use in place of invalid characters + A string that does not contain invalid XML characters. + + + Certain Unicode code points are not allowed in the XML InfoSet, for + details see: http://www.w3.org/TR/REC-xml/#charsets. + + + This method replaces any illegal characters in the input string + with the mask string specified. + + + + + + Count the number of times that the substring occurs in the text + + the text to search + the substring to find + the number of times the substring occurs in the text + + + The substring is assumed to be non repeating within itself. + + + + + + Characters illegal in XML 1.0 + + + + + Type converter for Boolean. + + + + Supports conversion from string to bool type. + + + + + + Nicko Cadell + Gert Driesen + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Convert the source object to the type supported by this object + + the object to convert + the converted object + + + Uses the method to convert the + argument to a . + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Exception base type for conversion errors. + + + + This type extends . It + does not add any new functionality but does differentiate the + type of exception being thrown. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Constructor + + A message to include with the exception. + + + Initializes a new instance of the class + with the specified message. + + + + + + Constructor + + A message to include with the exception. + A nested exception to include. + + + Initializes a new instance of the class + with the specified message and inner exception. + + + + + + Serialization constructor + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + + + Initializes a new instance of the class + with serialized data. + + + + + + Creates a new instance of the class. + + The conversion destination type. + The value to convert. + An instance of the . + + + Creates a new instance of the class. + + + + + + Creates a new instance of the class. + + The conversion destination type. + The value to convert. + A nested exception to include. + An instance of the . + + + Creates a new instance of the class. + + + + + + Register of type converters for specific types. + + + + Maintains a registry of type converters used to convert between + types. + + + Use the and + methods to register new converters. + The and methods + lookup appropriate converters to use. + + + + + Nicko Cadell + Gert Driesen + + + + Private constructor + + + Initializes a new instance of the class. + + + + + Static constructor. + + + + This constructor defines the intrinsic type converters. + + + + + + Adds a converter for a specific type. + + The type being converted to. + The type converter to use to convert to the destination type. + + + Adds a converter instance for a specific type. + + + + + + Adds a converter for a specific type. + + The type being converted to. + The type of the type converter to use to convert to the destination type. + + + Adds a converter for a specific type. + + + + + + Gets the type converter to use to convert values to the destination type. + + The type being converted from. + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + Gets the type converter to use to convert values to the destination type. + + + + + + Gets the type converter to use to convert values to the destination type. + + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + Gets the type converter to use to convert values to the destination type. + + + + + + Lookups the type converter to use as specified by the attributes on the + destination type. + + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + + Creates the instance of the type converter. + + The type of the type converter. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + The type specified for the type converter must implement + the or interfaces + and must have a public default (no argument) constructor. + + + + + + The fully qualified type of the ConverterRegistry class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Mapping from to type converter. + + + + + Supports conversion from string to type. + + + + Supports conversion from string to type. + + + + + + Nicko Cadell + Gert Driesen + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to an encoding + the encoding + + + Uses the method to + convert the argument to an . + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Interface supported by type converters + + + + This interface supports conversion from arbitrary types + to a single target type. See . + + + Nicko Cadell + Gert Driesen + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Test if the can be converted to the + type supported by this converter. + + + + + + Convert the source object to the type supported by this object + + the object to convert + the converted object + + + Converts the to the type supported + by this converter. + + + + + + Interface supported by type converters + + + + This interface supports conversion from a single type to arbitrary types. + See . + + + Nicko Cadell + + + + Returns whether this converter can convert the object to the specified type + + A Type that represents the type you want to convert to + true if the conversion is possible + + + Test if the type supported by this converter can be converted to the + . + + + + + + Converts the given value object to the specified type, using the arguments + + the object to convert + The Type to convert the value parameter to + the converted object + + + Converts the (which must be of the type supported + by this converter) to the specified.. + + + + + + Supports conversion from string to type. + + + + Supports conversion from string to type. + + + + + Nicko Cadell + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to an IPAddress + the IPAddress + + + Uses the method to convert the + argument to an . + If that fails then the string is resolved as a DNS hostname. + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Valid characters in an IPv4 or IPv6 address string. (Does not support subnets) + + + + + Supports conversion from string to type. + + + + Supports conversion from string to type. + + + The string is used as the + of the . + + + + + + Nicko Cadell + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to a PatternLayout + the PatternLayout + + + Creates and returns a new using + the as the + . + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Convert between string and + + + + Supports conversion from string to type, + and from a type to a string. + + + The string is used as the + of the . + + + + + + Nicko Cadell + + + + Can the target type be converted to the type supported by this object + + A that represents the type you want to convert to + true if the conversion is possible + + + Returns true if the is + assignable from a type. + + + + + + Converts the given value object to the specified type, using the arguments + + the object to convert + The Type to convert the value parameter to + the converted object + + + Uses the method to convert the + argument to a . + + + + The object cannot be converted to the + . To check for this condition use the + method. + + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to a PatternString + the PatternString + + + Creates and returns a new using + the as the + . + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Supports conversion from string to type. + + + + Supports conversion from string to type. + + + + + + Nicko Cadell + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to a Type + the Type + + + Uses the method to convert the + argument to a . + Additional effort is made to locate partially specified types + by searching the loaded assemblies. + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Attribute used to associate a type converter + + + + Class and Interface level attribute that specifies a type converter + to use with the associated type. + + + To associate a type converter with a target type apply a + TypeConverterAttribute to the target type. Specify the + type of the type converter on the attribute. + + + Nicko Cadell + Gert Driesen + + + + The string type name of the type converter + + + + + Default constructor + + + + Default constructor + + + + + + Create a new type converter attribute for the specified type name + + The string type name of the type converter + + + The type specified must implement the + or the interfaces. + + + + + + Create a new type converter attribute for the specified type + + The type of the type converter + + + The type specified must implement the + or the interfaces. + + + + + + The string type name of the type converter + + + The string type name of the type converter + + + + The type specified must implement the + or the interfaces. + + + + + + Impersonate a Windows Account + + + + This impersonates a Windows account. + + + How the impersonation is done depends on the value of . + This allows the context to either impersonate a set of user credentials specified + using username, domain name and password or to revert to the process credentials. + + + + + + The impersonation modes for the + + + + See the property for + details. + + + + + + Impersonate a user using the credentials supplied + + + + + Revert this the thread to the credentials of the process + + + + + Default constructor + + + + Default constructor + + + + + + Gets or sets the impersonation mode for this security context + + + The impersonation mode for this security context + + + + Impersonate either a user with user credentials or + revert this thread to the credentials of the process. + The value is one of the + enum. + + + The default value is + + + When the mode is set to + the user's credentials are established using the + , and + values. + + + When the mode is set to + no other properties need to be set. If the calling thread is + impersonating then it will be reverted back to the process credentials. + + + + + + Gets or sets the Windows username for this security context + + + The Windows username for this security context + + + + This property must be set if + is set to (the default setting). + + + + + + Gets or sets the Windows domain name for this security context + + + The Windows domain name for this security context + + + + The default value for is the local machine name + taken from the property. + + + This property must be set if + is set to (the default setting). + + + + + + Sets the password for the Windows account specified by the and properties. + + + The password for the Windows account specified by the and properties. + + + + This property must be set if + is set to (the default setting). + + + + + + Initialize the SecurityContext based on the options set. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + The security context will try to Logon the specified user account and + capture a primary token for impersonation. + + + The required , + or properties were not specified. + + + + Impersonate the Windows account specified by the and properties. + + caller provided state + + An instance that will revoke the impersonation of this SecurityContext + + + + Depending on the property either + impersonate a user using credentials supplied or revert + to the process credentials. + + + + + + Create a given the userName, domainName and password. + + the user name + the domain name + the password + the for the account specified + + + Uses the Windows API call LogonUser to get a principal token for the account. This + token is used to initialize the WindowsIdentity. + + + + + + Adds to + + + + Helper class to expose the + through the interface. + + + + + + Constructor + + the impersonation context being wrapped + + + Constructor + + + + + + Revert the impersonation + + + + Revert the impersonation + + + + + diff --git a/app_data/jobs/triggered/utility/logs/BoldBi/Azure/Development/Log4Net.config b/app_data/jobs/triggered/utility/logs/BoldBi/Azure/Development/Log4Net.config new file mode 100644 index 000000000..f60070d5d --- /dev/null +++ b/app_data/jobs/triggered/utility/logs/BoldBi/Azure/Development/Log4Net.config @@ -0,0 +1,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/logs/BoldBi/Azure/Live/Log4Net.config b/app_data/jobs/triggered/utility/logs/BoldBi/Azure/Live/Log4Net.config new file mode 100644 index 000000000..3064bca26 --- /dev/null +++ b/app_data/jobs/triggered/utility/logs/BoldBi/Azure/Live/Log4Net.config @@ -0,0 +1,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/logs/BoldBi/Azure/Staging/Log4Net.config b/app_data/jobs/triggered/utility/logs/BoldBi/Azure/Staging/Log4Net.config new file mode 100644 index 000000000..3064bca26 --- /dev/null +++ b/app_data/jobs/triggered/utility/logs/BoldBi/Azure/Staging/Log4Net.config @@ -0,0 +1,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app_data/jobs/triggered/utility/logs/Log4Net.config b/app_data/jobs/triggered/utility/logs/Log4Net.config new file mode 100644 index 000000000..1dd544e08 --- /dev/null +++ b/app_data/jobs/triggered/utility/logs/Log4Net.config @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + \ No newline at end of file