Class RegistryName (2.0.0)

public sealed class RegistryName : IResourceName, IEquatable<RegistryName>

Resource name for the Registry resource.

Inheritance

Object > RegistryName

Namespace

Google.Cloud.Iot.V1

Assembly

Google.Cloud.Iot.V1.dll

Constructors

RegistryName(String, String, String)

public RegistryName(string projectId, string locationId, string registryId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

registryIdString

The Registry ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

RegistryId

public string RegistryId { get; }

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

Property Value
TypeDescription
String

Type

public RegistryName.ResourceNameType Type { get; }

The RegistryName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
RegistryName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String)

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

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

registryIdString

The Registry ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this RegistryName with pattern projects/{project}/locations/{location}/registries/{registry}.

FormatProjectLocationRegistry(String, String, String)

public static string FormatProjectLocationRegistry(string projectId, string locationId, string registryId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

registryIdString

The Registry ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this RegistryName with pattern projects/{project}/locations/{location}/registries/{registry}.

FromProjectLocationRegistry(String, String, String)

public static RegistryName FromProjectLocationRegistry(string projectId, string locationId, string registryId)

Creates a RegistryName with the pattern projects/{project}/locations/{location}/registries/{registry}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

registryIdString

The Registry ID. Must not be null or empty.

Returns
TypeDescription
RegistryName

A new instance of RegistryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RegistryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RegistryName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
RegistryName

A new instance of RegistryName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static RegistryName Parse(string registryName)

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

Parameter
NameDescription
registryNameString

The resource name in string form. Must not be null.

Returns
TypeDescription
RegistryName

The parsed RegistryName if successful.

Remarks

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

  • projects/{project}/locations/{location}/registries/{registry}

Parse(String, Boolean)

public static RegistryName Parse(string registryName, bool allowUnparsed)

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

Parameters
NameDescription
registryNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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
TypeDescription
RegistryName

The parsed RegistryName if successful.

Remarks

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

  • projects/{project}/locations/{location}/registries/{registry}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out RegistryName)

public static bool TryParse(string registryName, out RegistryName result)

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

Parameters
NameDescription
registryNameString

The resource name in string form. Must not be null.

resultRegistryName

When this method returns, the parsed RegistryName, or null if parsing failed.

Returns
TypeDescription
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}/locations/{location}/registries/{registry}

TryParse(String, Boolean, out RegistryName)

public static bool TryParse(string registryName, bool allowUnparsed, out RegistryName result)

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

Parameters
NameDescription
registryNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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.

resultRegistryName

When this method returns, the parsed RegistryName, or null if parsing failed.

Returns
TypeDescription
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}/locations/{location}/registries/{registry}
Or may be in any format if allowUnparsed is true.

Operators

Equality(RegistryName, RegistryName)

public static bool operator ==(RegistryName a, RegistryName b)
Parameters
NameDescription
aRegistryName
bRegistryName
Returns
TypeDescription
Boolean

Inequality(RegistryName, RegistryName)

public static bool operator !=(RegistryName a, RegistryName b)
Parameters
NameDescription
aRegistryName
bRegistryName
Returns
TypeDescription
Boolean