Show / Hide Table of Contents

Class DiscoveryFormat

Utility methods to convert to/from Discovery API formats. See https://developers.google.com/discovery/v1/type-format

Inheritance
object
DiscoveryFormat
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Util
Assembly: Google.Apis.Core.dll
Syntax
public static class DiscoveryFormat
Remarks

Methods starting "Parse" are for parsing the Discovery format to a .NET type. Methods starting "Format" are for formatting .NET types to Discovery formats. This class does not provide methods for DateTime and object conversions; properties with a type of DateTime or object are marked as obsolete in the generated code, and have legacy behavior which cannot reasonably be changed for backward compatibility reasons.

Methods

FormatDateTimeOffsetToDateTime(DateTimeOffset?)

Formats a DateTime value appropriately for a Discovery "date-time" value. This does not automatically convert the given value to UTC; some services require values to be presented in UTC, in which case user code should ensure that only UTC values are specified.

Declaration
public static string FormatDateTimeOffsetToDateTime(DateTimeOffset? value)
Parameters
Type Name Description
DateTimeOffset? value
Returns
Type Description
string

FormatDateTimeOffsetToGoogleDateTime(DateTimeOffset?)

Formats a DateTime value appropriately for a Discovery "google-datetime" value. This automatically converts the given value to UTC before formatting.

Declaration
public static string FormatDateTimeOffsetToGoogleDateTime(DateTimeOffset? value)
Parameters
Type Name Description
DateTimeOffset? value
Returns
Type Description
string

ParseDateTimeToDateTimeOffset(string)

Parses a Discovery "date-time" format value to DateTimeOffset. The value must start in the format "yyyy-MM-ddTHH:mm:ss", with optional milliseconds, microseconds and nanoseconds. A UTC offset may be provided with up to second precision (e.g. +01, -02:30, +03:45:12), or "Z" for UTC. If nanosecond precision is provided, the value is truncated to .NET "tick" precision (100ns). If the UTC offset has a non-zero seconds component, a value is returned which preserves the instant in time, but truncates the UTC offset to the minute.

Declaration
public static DateTimeOffset? ParseDateTimeToDateTimeOffset(string value)
Parameters
Type Name Description
string value
Returns
Type Description
DateTimeOffset?

ParseGoogleDateTimeToDateTimeOffset(string)

Parses a Discovery "google-datetime" format value to DateTimeOffset. The value must start in the format "yyyy-MM-ddTHH:mm:ss", with optional milliseconds, microseconds and nanoseconds, and a trailing 'Z' to indicate UTC.

Declaration
public static DateTimeOffset? ParseGoogleDateTimeToDateTimeOffset(string value)
Parameters
Type Name Description
string value
Returns
Type Description
DateTimeOffset?
In this article
Back to top Generated by DocFX