Certificate Manager v1 API - Class CertificateMapEntryName (2.8.0)

public sealed class CertificateMapEntryName : IResourceName, IEquatable<CertificateMapEntryName>

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

Resource name for the CertificateMapEntry resource.

Inheritance

object > CertificateMapEntryName

Namespace

Google.Cloud.CertificateManager.V1

Assembly

Google.Cloud.CertificateManager.V1.dll

Constructors

CertificateMapEntryName(string, string, string, string)

public CertificateMapEntryName(string projectId, string locationId, string certificateMapId, string certificateMapEntryId)

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

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.

certificateMapId string

The CertificateMap ID. Must not be null or empty.

certificateMapEntryId string

The CertificateMapEntry ID. Must not be null or empty.

Properties

CertificateMapEntryId

public string CertificateMapEntryId { get; }

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

Property Value
Type Description
string

CertificateMapId

public string CertificateMapId { get; }

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

The CertificateMapEntryName.ResourceNameType of the contained resource name.

Property Value
Type Description
CertificateMapEntryNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string certificateMapId, string certificateMapEntryId)

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

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.

certificateMapId string

The CertificateMap ID. Must not be null or empty.

certificateMapEntryId string

The CertificateMapEntry ID. Must not be null or empty.

Returns
Type Description
string

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

FormatProjectLocationCertificateMapCertificateMapEntry(string, string, string, string)

public static string FormatProjectLocationCertificateMapCertificateMapEntry(string projectId, string locationId, string certificateMapId, string certificateMapEntryId)

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

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.

certificateMapId string

The CertificateMap ID. Must not be null or empty.

certificateMapEntryId string

The CertificateMapEntry ID. Must not be null or empty.

Returns
Type Description
string

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

FromProjectLocationCertificateMapCertificateMapEntry(string, string, string, string)

public static CertificateMapEntryName FromProjectLocationCertificateMapCertificateMapEntry(string projectId, string locationId, string certificateMapId, string certificateMapEntryId)

Creates a CertificateMapEntryName with the pattern projects/{project}/locations/{location}/certificateMaps/{certificate_map}/certificateMapEntries/{certificate_map_entry} .

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.

certificateMapId string

The CertificateMap ID. Must not be null or empty.

certificateMapEntryId string

The CertificateMapEntry ID. Must not be null or empty.

Returns
Type Description
CertificateMapEntryName

A new instance of CertificateMapEntryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CertificateMapEntryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CertificateMapEntryName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
CertificateMapEntryName

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

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

Parameter
Name Description
certificateMapEntryName string

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

Returns
Type Description
CertificateMapEntryName

The parsed CertificateMapEntryName if successful.

Remarks

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

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

Parse(string, bool)

public static CertificateMapEntryName Parse(string certificateMapEntryName, bool allowUnparsed)

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

Parameters
Name Description
certificateMapEntryName 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
CertificateMapEntryName

The parsed CertificateMapEntryName if successful.

Remarks

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

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

public static bool TryParse(string certificateMapEntryName, out CertificateMapEntryName result)

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

Parameters
Name Description
certificateMapEntryName string

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

result CertificateMapEntryName

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

TryParse(string, bool, out CertificateMapEntryName)

public static bool TryParse(string certificateMapEntryName, bool allowUnparsed, out CertificateMapEntryName result)

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

Parameters
Name Description
certificateMapEntryName 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 CertificateMapEntryName

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

Operators

operator ==(CertificateMapEntryName, CertificateMapEntryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CertificateMapEntryName

The first resource name to compare, or null.

b CertificateMapEntryName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CertificateMapEntryName

The first resource name to compare, or null.

b CertificateMapEntryName

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.