Cloud Domains v1 API - Class RegistrationName (2.3.0) 

public sealed class RegistrationName : IResourceName, IEquatable<RegistrationName>

Reference documentation and code samples for the Cloud Domains v1 API class RegistrationName.

Resource name for the Registration resource.

Inheritance

object > RegistrationName

Namespace

Google.Cloud.Domains.V1

Assembly

Google.Cloud.Domains.V1.dll

Constructors

RegistrationName(string, string, string)

public RegistrationName(string projectId, string locationId, string registrationId)

Constructs a new instance of a RegistrationName class from the component parts of pattern projects/{project}/locations/{location}/registrations/{registration}

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.
registrationId string

The Registration 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
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

RegistrationId

public string RegistrationId { get; }

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

Property Value
Type Description
string

Type

public RegistrationName.ResourceNameType Type { get; }

The RegistrationName.ResourceNameType of the contained resource name.

Property Value
Type Description
RegistrationNameResourceNameType

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)

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

Formats the IDs into the string representation of this RegistrationName with pattern projects/{project}/locations/{location}/registrations/{registration}.

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.
registrationId string

The Registration ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this RegistrationName with pattern projects/{project}/locations/{location}/registrations/{registration}.

FormatProjectLocationRegistration(string, string, string)

public static string FormatProjectLocationRegistration(string projectId, string locationId, string registrationId)

Formats the IDs into the string representation of this RegistrationName with pattern projects/{project}/locations/{location}/registrations/{registration}.

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.
registrationId string

The Registration ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this RegistrationName with pattern projects/{project}/locations/{location}/registrations/{registration}.

FromProjectLocationRegistration(string, string, string)

public static RegistrationName FromProjectLocationRegistration(string projectId, string locationId, string registrationId)

Creates a RegistrationName with the pattern projects/{project}/locations/{location}/registrations/{registration}.

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.
registrationId string

The Registration ID. Must not be null or empty.
Returns
Type Description
RegistrationName

A new instance of RegistrationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RegistrationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RegistrationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
RegistrationName

A new instance of RegistrationName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static RegistrationName Parse(string registrationName)

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

Parameter
Name Description
registrationName string

The resource name in string form. Must not be null.
Returns
Type Description
RegistrationName

The parsed RegistrationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/registrations/{registration}

Parse(string, bool)

public static RegistrationName Parse(string registrationName, bool allowUnparsed)

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

Parameters
Name Description
registrationName 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
RegistrationName

The parsed RegistrationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/registrations/{registration}
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

TryParse(string, out RegistrationName)

public static bool TryParse(string registrationName, out RegistrationName result)

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

Parameters
Name Description
registrationName string

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

When this method returns, the parsed RegistrationName, 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}/registrations/{registration}

TryParse(string, bool, out RegistrationName)

public static bool TryParse(string registrationName, bool allowUnparsed, out RegistrationName result)

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

Parameters
Name Description
registrationName 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 RegistrationName

When this method returns, the parsed RegistrationName, 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}/registrations/{registration}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RegistrationName, RegistrationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RegistrationName

The first resource name to compare, or null.
b RegistrationName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(RegistrationName, RegistrationName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RegistrationName

The first resource name to compare, or null.
b RegistrationName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.