Managed Service for Microsoft Active Directory v1 API - Class DomainName (3.2.0)

public sealed class DomainName : IResourceName, IEquatable<DomainName>

Reference documentation and code samples for the Managed Service for Microsoft Active Directory v1 API class DomainName.

Resource name for the Domain resource.

Inheritance

object > DomainName

Namespace

Google.Cloud.ManagedIdentities.V1

Assembly

Google.Cloud.ManagedIdentities.V1.dll

Constructors

DomainName(string, string, string)

public DomainName(string projectId, string locationId, string domainId)

Constructs a new instance of a DomainName class from the component parts of pattern projects/{project}/locations/{location}/domains/{domain}

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.

domainId string

The Domain ID. Must not be null or empty.

Properties

DomainId

public string DomainId { get; }

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

Type

public DomainName.ResourceNameType Type { get; }

The DomainName.ResourceNameType of the contained resource name.

Property Value
Type Description
DomainNameResourceNameType

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

Formats the IDs into the string representation of this DomainName with pattern projects/{project}/locations/{location}/domains/{domain}.

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.

domainId string

The Domain ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DomainName with pattern projects/{project}/locations/{location}/domains/{domain}.

FormatProjectLocationDomain(string, string, string)

public static string FormatProjectLocationDomain(string projectId, string locationId, string domainId)

Formats the IDs into the string representation of this DomainName with pattern projects/{project}/locations/{location}/domains/{domain}.

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.

domainId string

The Domain ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DomainName with pattern projects/{project}/locations/{location}/domains/{domain}.

FromProjectLocationDomain(string, string, string)

public static DomainName FromProjectLocationDomain(string projectId, string locationId, string domainId)

Creates a DomainName with the pattern projects/{project}/locations/{location}/domains/{domain}.

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.

domainId string

The Domain ID. Must not be null or empty.

Returns
Type Description
DomainName

A new instance of DomainName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DomainName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DomainName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
DomainName

A new instance of DomainName 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 DomainName Parse(string domainName)

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

Parameter
Name Description
domainName string

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

Returns
Type Description
DomainName

The parsed DomainName if successful.

Remarks

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

  • projects/{project}/locations/{location}/domains/{domain}

Parse(string, bool)

public static DomainName Parse(string domainName, bool allowUnparsed)

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

Parameters
Name Description
domainName 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
DomainName

The parsed DomainName if successful.

Remarks

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

  • projects/{project}/locations/{location}/domains/{domain}
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 DomainName)

public static bool TryParse(string domainName, out DomainName result)

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

Parameters
Name Description
domainName string

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

result DomainName

When this method returns, the parsed DomainName, 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}/domains/{domain}

TryParse(string, bool, out DomainName)

public static bool TryParse(string domainName, bool allowUnparsed, out DomainName result)

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

Parameters
Name Description
domainName 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 DomainName

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

Operators

operator ==(DomainName, DomainName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DomainName

The first resource name to compare, or null.

b DomainName

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 !=(DomainName, DomainName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DomainName

The first resource name to compare, or null.

b DomainName

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.