Compute Engine v1 API - Class ComputeEnumHelpers (2.7.0)

Version 2.7.0

• 3.1.0 (latest)
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public static class ComputeEnumHelpers

Reference documentation and code samples for the Compute Engine v1 API class ComputeEnumHelpers.

Helper methods for conversion between the enums within the Compute API and the string representations used on the wire.

Inheritance

object > ComputeEnumHelpers

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Methods

Format<TEnum>(TEnum)

public static string Format<TEnum>(TEnum value) where TEnum : struct, Enum

Converts the given enum value into the wire representation as a string.

Parameter
Name	Description
value	TEnum The value to convert.

Returns
Type	Description
string	The string representation of the enum value.

Type Parameter
Name	Description
TEnum	The enum type to convert to a string.

Exceptions
Type	Description
ArgumentException	The enum value is not defined, so it has no known wire representation.

Parse<TEnum>(string)

public static TEnum Parse<TEnum>(string value) where TEnum : struct, Enum

Parses the given string value as the wire representation of a TEnum value, throwing an exception if the value cannot be parsed.

Parameter
Name	Description
value	string The text value to parse.

Returns
Type	Description
TEnum	The parsed value.

Type Parameter
Name	Description
TEnum	The enum type to convert value to.

Exceptions
Type	Description
ArgumentException	value is not a valid wire value for TEnum.

TryParse<TEnum>(string, out TEnum)

public static bool TryParse<TEnum>(string value, out TEnum result) where TEnum : struct, Enum

Attempts to parse the given string value as the wire representation of a TEnum value.

Parameters
Name	Description
value	string The text value to parse.
result	TEnum The output parameter to store the result in. This will be the parsed value of TEnum if the return value is true, or the default value otherwise.

Returns
Type	Description
bool	true if the value was successfully parsed; false otherwise

Type Parameter
Name	Description
TEnum	The enum type to convert value to.