Cloud IoT v1 API - Class DeviceName (2.2.0)

public sealed class DeviceName : IResourceName, IEquatable<DeviceName>

Reference documentation and code samples for the Cloud IoT v1 API class DeviceName.

Resource name for the Device resource.

Inheritance

object > DeviceName

Implements

IResourceName, IEquatable DeviceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Iot.V1

Assembly

Google.Cloud.Iot.V1.dll

Constructors

DeviceName(string, string, string, string)

public DeviceName(string projectId, string locationId, string registryId, string deviceId)

Constructs a new instance of a DeviceName class from the component parts of pattern projects/{project}/locations/{location}/registries/{registry}/devices/{device}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`registryId`	`string` The `Registry` ID. Must not be `null` or empty.
`deviceId`	`string` The `Device` ID. Must not be `null` or empty.

Properties

DeviceId

public string DeviceId { get; }

The Device ID. Will not be null, unless this instance contains an unparsed resource name.

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
`bool`

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

RegistryId

public string RegistryId { get; }

The Registry ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

Type

public DeviceName.ResourceNameType Type { get; }

The DeviceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`DeviceNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
`UnparsedResourceName`

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string registryId, string deviceId)

Formats the IDs into the string representation of this DeviceName with pattern projects/{project}/locations/{location}/registries/{registry}/devices/{device}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`registryId`	`string` The `Registry` ID. Must not be `null` or empty.
`deviceId`	`string` The `Device` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this DeviceName with pattern `projects/{project}/locations/{location}/registries/{registry}/devices/{device}`.

FormatProjectLocationRegistryDevice(string, string, string, string)

public static string FormatProjectLocationRegistryDevice(string projectId, string locationId, string registryId, string deviceId)

Formats the IDs into the string representation of this DeviceName with pattern projects/{project}/locations/{location}/registries/{registry}/devices/{device}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`registryId`	`string` The `Registry` ID. Must not be `null` or empty.
`deviceId`	`string` The `Device` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this DeviceName with pattern `projects/{project}/locations/{location}/registries/{registry}/devices/{device}`.

FromProjectLocationRegistryDevice(string, string, string, string)

public static DeviceName FromProjectLocationRegistryDevice(string projectId, string locationId, string registryId, string deviceId)

Creates a DeviceName with the pattern projects/{project}/locations/{location}/registries/{registry}/devices/{device}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`registryId`	`string` The `Registry` ID. Must not be `null` or empty.
`deviceId`	`string` The `Device` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static DeviceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DeviceName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static DeviceName Parse(string deviceName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/registries/{registry}/devices/{device}

Parse(string, bool)

public static DeviceName Parse(string deviceName, bool allowUnparsed)

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

Parameters
Name	Description
`deviceName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` 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
`DeviceName`	The parsed DeviceName if successful.

Remarks

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

projects/{project}/locations/{location}/registries/{registry}/devices/{device}

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 DeviceName)

public static bool TryParse(string deviceName, out DeviceName result)

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

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

Returns
Type	Description
`bool`	`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}/locations/{location}/registries/{registry}/devices/{device}

TryParse(string, bool, out DeviceName)

public static bool TryParse(string deviceName, bool allowUnparsed, out DeviceName result)

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

Parameters
Name	Description
`deviceName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` 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`	`DeviceName` When this method returns, the parsed DeviceName, or `null` if parsing failed.

Returns
Type	Description
`bool`	`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}/locations/{location}/registries/{registry}/devices/{device}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DeviceName, DeviceName)

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

Parameters
Name	Description
`a`	`DeviceName`
`b`	`DeviceName`

Returns
Type	Description
`bool`

operator !=(DeviceName, DeviceName)

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

Parameters
Name	Description
`a`	`DeviceName`
`b`	`DeviceName`

Returns
Type	Description
`bool`