Certificate Manager v1 API - Class CertificateMapName (2.2.0)

public sealed class CertificateMapName : IResourceName, IEquatable<CertificateMapName>

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

Resource name for the CertificateMap resource.

Inheritance

Object > CertificateMapName

Namespace

Google.Cloud.CertificateManager.V1

Assembly

Google.Cloud.CertificateManager.V1.dll

Constructors

CertificateMapName(String, String, String)

public CertificateMapName(string projectId, string locationId, string certificateMapId)

Constructs a new instance of a CertificateMapName class from the component parts of pattern projects/{project}/locations/{location}/certificateMaps/{certificate_map}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

certificateMapIdString

The CertificateMap ID. Must not be null or empty.

Properties

CertificateMapId

public string CertificateMapId { get; }

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

Property Value
TypeDescription
String

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

Type

public CertificateMapName.ResourceNameType Type { get; }

The CertificateMapName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
CertificateMapName.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 certificateMapId)

Formats the IDs into the string representation of this CertificateMapName with pattern projects/{project}/locations/{location}/certificateMaps/{certificate_map}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

certificateMapIdString

The CertificateMap ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this CertificateMapName with pattern projects/{project}/locations/{location}/certificateMaps/{certificate_map}.

FormatProjectLocationCertificateMap(String, String, String)

public static string FormatProjectLocationCertificateMap(string projectId, string locationId, string certificateMapId)

Formats the IDs into the string representation of this CertificateMapName with pattern projects/{project}/locations/{location}/certificateMaps/{certificate_map}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

certificateMapIdString

The CertificateMap ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this CertificateMapName with pattern projects/{project}/locations/{location}/certificateMaps/{certificate_map}.

FromProjectLocationCertificateMap(String, String, String)

public static CertificateMapName FromProjectLocationCertificateMap(string projectId, string locationId, string certificateMapId)

Creates a CertificateMapName with the pattern projects/{project}/locations/{location}/certificateMaps/{certificate_map}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

certificateMapIdString

The CertificateMap ID. Must not be null or empty.

Returns
TypeDescription
CertificateMapName

A new instance of CertificateMapName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CertificateMapName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CertificateMapName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
CertificateMapName

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

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

Parameter
NameDescription
certificateMapNameString

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

Returns
TypeDescription
CertificateMapName

The parsed CertificateMapName if successful.

Remarks

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

  • projects/{project}/locations/{location}/certificateMaps/{certificate_map}

Parse(String, Boolean)

public static CertificateMapName Parse(string certificateMapName, bool allowUnparsed)

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

Parameters
NameDescription
certificateMapNameString

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
CertificateMapName

The parsed CertificateMapName if successful.

Remarks

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

  • projects/{project}/locations/{location}/certificateMaps/{certificate_map}
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 CertificateMapName)

public static bool TryParse(string certificateMapName, out CertificateMapName result)

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

Parameters
NameDescription
certificateMapNameString

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

resultCertificateMapName

When this method returns, the parsed CertificateMapName, 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}/certificateMaps/{certificate_map}

TryParse(String, Boolean, out CertificateMapName)

public static bool TryParse(string certificateMapName, bool allowUnparsed, out CertificateMapName result)

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

Parameters
NameDescription
certificateMapNameString

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.

resultCertificateMapName

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

Operators

Equality(CertificateMapName, CertificateMapName)

public static bool operator ==(CertificateMapName a, CertificateMapName b)
Parameters
NameDescription
aCertificateMapName
bCertificateMapName
Returns
TypeDescription
Boolean

Inequality(CertificateMapName, CertificateMapName)

public static bool operator !=(CertificateMapName a, CertificateMapName b)
Parameters
NameDescription
aCertificateMapName
bCertificateMapName
Returns
TypeDescription
Boolean