Google Cloud Monitoring v3 API - Class UptimeCheckConfigName (3.2.0)

public sealed class UptimeCheckConfigName : IResourceName, IEquatable<UptimeCheckConfigName>

Reference documentation and code samples for the Google Cloud Monitoring v3 API class UptimeCheckConfigName.

Resource name for the UptimeCheckConfig resource.

Inheritance

Object > UptimeCheckConfigName

Implements

IResourceName, IEquatable<UptimeCheckConfigName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

UptimeCheckConfigName(String, String)

public UptimeCheckConfigName(string projectId, string uptimeCheckConfigId)

Constructs a new instance of a UptimeCheckConfigName class from the component parts of pattern projects/{project}/uptimeCheckConfigs/{uptime_check_config}

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`uptimeCheckConfigId`	`String` The `UptimeCheckConfig` ID. Must not be `null` or empty.

Properties

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type	Description
`Boolean`

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

Type

public UptimeCheckConfigName.ResourceNameType Type { get; }

The UptimeCheckConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`UptimeCheckConfigName.ResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
`UnparsedResourceName`

UptimeCheckConfigId

public string UptimeCheckConfigId { get; }

The UptimeCheckConfig ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

Methods

Format(String, String)

public static string Format(string projectId, string uptimeCheckConfigId)

Formats the IDs into the string representation of this UptimeCheckConfigName with pattern projects/{project}/uptimeCheckConfigs/{uptime_check_config}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`uptimeCheckConfigId`	`String` The `UptimeCheckConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this UptimeCheckConfigName with pattern `projects/{project}/uptimeCheckConfigs/{uptime_check_config}`.

FormatFolderUptimeCheckConfig(String, String)

public static string FormatFolderUptimeCheckConfig(string folderId, string uptimeCheckConfigId)

Formats the IDs into the string representation of this UptimeCheckConfigName with pattern folders/{folder}/uptimeCheckConfigs/{uptime_check_config}.

Parameters
Name	Description
`folderId`	`String` The `Folder` ID. Must not be `null` or empty.
`uptimeCheckConfigId`	`String` The `UptimeCheckConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this UptimeCheckConfigName with pattern `folders/{folder}/uptimeCheckConfigs/{uptime_check_config}`.

FormatOrganizationUptimeCheckConfig(String, String)

public static string FormatOrganizationUptimeCheckConfig(string organizationId, string uptimeCheckConfigId)

Formats the IDs into the string representation of this UptimeCheckConfigName with pattern organizations/{organization}/uptimeCheckConfigs/{uptime_check_config}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`uptimeCheckConfigId`	`String` The `UptimeCheckConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this UptimeCheckConfigName with pattern `organizations/{organization}/uptimeCheckConfigs/{uptime_check_config}`.

FormatProjectUptimeCheckConfig(String, String)

public static string FormatProjectUptimeCheckConfig(string projectId, string uptimeCheckConfigId)

Formats the IDs into the string representation of this UptimeCheckConfigName with pattern projects/{project}/uptimeCheckConfigs/{uptime_check_config}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`uptimeCheckConfigId`	`String` The `UptimeCheckConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this UptimeCheckConfigName with pattern `projects/{project}/uptimeCheckConfigs/{uptime_check_config}`.

FromFolderUptimeCheckConfig(String, String)

public static UptimeCheckConfigName FromFolderUptimeCheckConfig(string folderId, string uptimeCheckConfigId)

Creates a UptimeCheckConfigName with the pattern folders/{folder}/uptimeCheckConfigs/{uptime_check_config}.

Parameters
Name	Description
`folderId`	`String` The `Folder` ID. Must not be `null` or empty.
`uptimeCheckConfigId`	`String` The `UptimeCheckConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`UptimeCheckConfigName`	A new instance of UptimeCheckConfigName constructed from the provided ids.

FromOrganizationUptimeCheckConfig(String, String)

public static UptimeCheckConfigName FromOrganizationUptimeCheckConfig(string organizationId, string uptimeCheckConfigId)

Creates a UptimeCheckConfigName with the pattern organizations/{organization}/uptimeCheckConfigs/{uptime_check_config}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`uptimeCheckConfigId`	`String` The `UptimeCheckConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`UptimeCheckConfigName`	A new instance of UptimeCheckConfigName constructed from the provided ids.

FromProjectUptimeCheckConfig(String, String)

public static UptimeCheckConfigName FromProjectUptimeCheckConfig(string projectId, string uptimeCheckConfigId)

Creates a UptimeCheckConfigName with the pattern projects/{project}/uptimeCheckConfigs/{uptime_check_config}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`uptimeCheckConfigId`	`String` The `UptimeCheckConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`UptimeCheckConfigName`	A new instance of UptimeCheckConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static UptimeCheckConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a UptimeCheckConfigName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`UptimeCheckConfigName`	A new instance of UptimeCheckConfigName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static UptimeCheckConfigName Parse(string uptimeCheckConfigName)

Parses the given resource name string into a new UptimeCheckConfigName instance.

Parameter
Name	Description
`uptimeCheckConfigName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`UptimeCheckConfigName`	The parsed UptimeCheckConfigName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/uptimeCheckConfigs/{uptime_check_config}
organizations/{organization}/uptimeCheckConfigs/{uptime_check_config}
folders/{folder}/uptimeCheckConfigs/{uptime_check_config}

Parse(String, Boolean)

public static UptimeCheckConfigName Parse(string uptimeCheckConfigName, bool allowUnparsed)

Parses the given resource name string into a new UptimeCheckConfigName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`uptimeCheckConfigName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type	Description
`UptimeCheckConfigName`	The parsed UptimeCheckConfigName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/uptimeCheckConfigs/{uptime_check_config}
organizations/{organization}/uptimeCheckConfigs/{uptime_check_config}
folders/{folder}/uptimeCheckConfigs/{uptime_check_config}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type	Description
`String`	The string representation of the resource name.

Overrides

Object.ToString()

TryParse(String, out UptimeCheckConfigName)

public static bool TryParse(string uptimeCheckConfigName, out UptimeCheckConfigName result)

Tries to parse the given resource name string into a new UptimeCheckConfigName instance.

Parameters
Name	Description
`uptimeCheckConfigName`	`String` The resource name in string form. Must not be `null`.
`result`	`UptimeCheckConfigName` When this method returns, the parsed UptimeCheckConfigName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/uptimeCheckConfigs/{uptime_check_config}
organizations/{organization}/uptimeCheckConfigs/{uptime_check_config}
folders/{folder}/uptimeCheckConfigs/{uptime_check_config}

TryParse(String, Boolean, out UptimeCheckConfigName)

public static bool TryParse(string uptimeCheckConfigName, bool allowUnparsed, out UptimeCheckConfigName result)

Tries to parse the given resource name string into a new UptimeCheckConfigName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`uptimeCheckConfigName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
`result`	`UptimeCheckConfigName` When this method returns, the parsed UptimeCheckConfigName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/uptimeCheckConfigs/{uptime_check_config}
organizations/{organization}/uptimeCheckConfigs/{uptime_check_config}
folders/{folder}/uptimeCheckConfigs/{uptime_check_config}

Or may be in any format if allowUnparsed is true.

Operators

Equality(UptimeCheckConfigName, UptimeCheckConfigName)

public static bool operator ==(UptimeCheckConfigName a, UptimeCheckConfigName b)

Parameters
Name	Description
`a`	`UptimeCheckConfigName`
`b`	`UptimeCheckConfigName`

Returns
Type	Description
`Boolean`

Inequality(UptimeCheckConfigName, UptimeCheckConfigName)

public static bool operator !=(UptimeCheckConfigName a, UptimeCheckConfigName b)

Parameters
Name	Description
`a`	`UptimeCheckConfigName`
`b`	`UptimeCheckConfigName`

Returns
Type	Description
`Boolean`