public sealed class DeviceName : IResourceName, IEquatable<DeviceName>
Resource name for the Device
resource.
Inheritance
System.Object > DeviceNameNamespace
Google.Cloud.Iot.V1Assembly
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 | System.String The |
locationId | System.String The |
registryId | System.String The |
deviceId | System.String The |
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 |
System.String |
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
Property Value | |
---|---|
Type | Description |
System.Boolean |
LocationId
public string LocationId { get; }
The Location
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
System.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 |
System.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 |
System.String |
Type
public DeviceName.ResourceNameType Type { get; }
The DeviceName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
DeviceName.ResourceNameType |
UnparsedResource
public UnparsedResourceName UnparsedResource { get; }
The contained Google.Api.Gax.UnparsedResourceName. Only non-null
if this instance contains an
unparsed resource name.
Property Value | |
---|---|
Type | Description |
Google.Api.Gax.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 | System.String The |
locationId | System.String The |
registryId | System.String The |
deviceId | System.String The |
Returns | |
---|---|
Type | Description |
System.String | The string representation of this DeviceName with pattern
|
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 | System.String The |
locationId | System.String The |
registryId | System.String The |
deviceId | System.String The |
Returns | |
---|---|
Type | Description |
System.String | The string representation of this DeviceName with pattern
|
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 | System.String The |
locationId | System.String The |
registryId | System.String The |
deviceId | System.String The |
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 | Google.Api.Gax.UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
DeviceName | A new instance of DeviceName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
System.Int32 |
Parse(String)
public static DeviceName Parse(string deviceName)
Parses the given resource name string into a new DeviceName instance.
Parameter | |
---|---|
Name | Description |
deviceName | System.String The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
DeviceName | The parsed DeviceName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/registries/{registry}/devices/{device}
Parse(String, Boolean)
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 | System.String The resource name in string form. Must not be |
allowUnparsed | System.Boolean If |
Returns | |
---|---|
Type | Description |
DeviceName | The parsed DeviceName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/registries/{registry}/devices/{device}
allowUnparsed
is true
.
ToString()
public override string ToString()
The string representation of the resource name.
Returns | |
---|---|
Type | Description |
System.String | The string representation of the resource name. |
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 | System.String The resource name in string form. Must not be |
result | DeviceName When this method returns, the parsed DeviceName, or |
Returns | |
---|---|
Type | Description |
System.Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/registries/{registry}/devices/{device}
TryParse(String, Boolean, 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 | System.String The resource name in string form. Must not be |
allowUnparsed | System.Boolean If |
result | DeviceName When this method returns, the parsed DeviceName, or |
Returns | |
---|---|
Type | Description |
System.Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/registries/{registry}/devices/{device}
allowUnparsed
is true
.
Operators
Equality(DeviceName, DeviceName)
public static bool operator ==(DeviceName a, DeviceName b)
Parameters | |
---|---|
Name | Description |
a | DeviceName |
b | DeviceName |
Returns | |
---|---|
Type | Description |
System.Boolean |
Inequality(DeviceName, DeviceName)
public static bool operator !=(DeviceName a, DeviceName b)
Parameters | |
---|---|
Name | Description |
a | DeviceName |
b | DeviceName |
Returns | |
---|---|
Type | Description |
System.Boolean |