Certificate Manager v1 API - Class DnsAuthorizationName (2.9.0) 

public sealed class DnsAuthorizationName : IResourceName, IEquatable<DnsAuthorizationName>

Reference documentation and code samples for the Certificate Manager v1 API class DnsAuthorizationName.

Resource name for the DnsAuthorization resource.

Inheritance

object > DnsAuthorizationName

Namespace

Google.Cloud.CertificateManager.V1

Assembly

Google.Cloud.CertificateManager.V1.dll

Constructors

DnsAuthorizationName(string, string, string)

public DnsAuthorizationName(string projectId, string locationId, string dnsAuthorizationId)

Constructs a new instance of a DnsAuthorizationName class from the component parts of pattern projects/{project}/locations/{location}/dnsAuthorizations/{dns_authorization}

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

The DnsAuthorization ID. Must not be null or empty.

Properties

DnsAuthorizationId

public string DnsAuthorizationId { get; }

The DnsAuthorization 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 DnsAuthorizationName.ResourceNameType Type { get; }

The DnsAuthorizationName.ResourceNameType of the contained resource name.

Property Value
Type Description
DnsAuthorizationNameResourceNameType

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

Formats the IDs into the string representation of this DnsAuthorizationName with pattern projects/{project}/locations/{location}/dnsAuthorizations/{dns_authorization}.

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

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

The string representation of this DnsAuthorizationName with pattern projects/{project}/locations/{location}/dnsAuthorizations/{dns_authorization}.

FormatProjectLocationDnsAuthorization(string, string, string)

public static string FormatProjectLocationDnsAuthorization(string projectId, string locationId, string dnsAuthorizationId)

Formats the IDs into the string representation of this DnsAuthorizationName with pattern projects/{project}/locations/{location}/dnsAuthorizations/{dns_authorization}.

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

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

The string representation of this DnsAuthorizationName with pattern projects/{project}/locations/{location}/dnsAuthorizations/{dns_authorization}.

FromProjectLocationDnsAuthorization(string, string, string)

public static DnsAuthorizationName FromProjectLocationDnsAuthorization(string projectId, string locationId, string dnsAuthorizationId)

Creates a DnsAuthorizationName with the pattern projects/{project}/locations/{location}/dnsAuthorizations/{dns_authorization}.

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

The DnsAuthorization ID. Must not be null or empty.
Returns
Type Description
DnsAuthorizationName

A new instance of DnsAuthorizationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DnsAuthorizationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DnsAuthorizationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
dnsAuthorizationName string

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

The parsed DnsAuthorizationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dnsAuthorizations/{dns_authorization}

Parse(string, bool)

public static DnsAuthorizationName Parse(string dnsAuthorizationName, bool allowUnparsed)

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

Parameters
Name Description
dnsAuthorizationName 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
DnsAuthorizationName

The parsed DnsAuthorizationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dnsAuthorizations/{dns_authorization}
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 DnsAuthorizationName)

public static bool TryParse(string dnsAuthorizationName, out DnsAuthorizationName result)

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

Parameters
Name Description
dnsAuthorizationName string

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

When this method returns, the parsed DnsAuthorizationName, 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}/dnsAuthorizations/{dns_authorization}

TryParse(string, bool, out DnsAuthorizationName)

public static bool TryParse(string dnsAuthorizationName, bool allowUnparsed, out DnsAuthorizationName result)

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

Parameters
Name Description
dnsAuthorizationName 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 DnsAuthorizationName

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

Operators

operator ==(DnsAuthorizationName, DnsAuthorizationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DnsAuthorizationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DnsAuthorizationName

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

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.