Certificate Authority v1 API - Class CertificateTemplateName (3.2.0)

public sealed class CertificateTemplateName : IResourceName, IEquatable<CertificateTemplateName>

Reference documentation and code samples for the Certificate Authority v1 API class CertificateTemplateName.

Resource name for the CertificateTemplate resource.

Inheritance

Object > CertificateTemplateName

Namespace

Google.Cloud.Security.PrivateCA.V1

Assembly

Google.Cloud.Security.PrivateCA.V1.dll

Constructors

CertificateTemplateName(String, String, String)

public CertificateTemplateName(string projectId, string locationId, string certificateTemplateId)

Constructs a new instance of a CertificateTemplateName class from the component parts of pattern projects/{project}/locations/{location}/certificateTemplates/{certificate_template}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

certificateTemplateIdString

The CertificateTemplate ID. Must not be null or empty.

Properties

CertificateTemplateId

public string CertificateTemplateId { get; }

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

The CertificateTemplateName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
CertificateTemplateName.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 certificateTemplateId)

Formats the IDs into the string representation of this CertificateTemplateName with pattern projects/{project}/locations/{location}/certificateTemplates/{certificate_template}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

certificateTemplateIdString

The CertificateTemplate ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this CertificateTemplateName with pattern projects/{project}/locations/{location}/certificateTemplates/{certificate_template}.

FormatProjectLocationCertificateTemplate(String, String, String)

public static string FormatProjectLocationCertificateTemplate(string projectId, string locationId, string certificateTemplateId)

Formats the IDs into the string representation of this CertificateTemplateName with pattern projects/{project}/locations/{location}/certificateTemplates/{certificate_template}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

certificateTemplateIdString

The CertificateTemplate ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this CertificateTemplateName with pattern projects/{project}/locations/{location}/certificateTemplates/{certificate_template}.

FromProjectLocationCertificateTemplate(String, String, String)

public static CertificateTemplateName FromProjectLocationCertificateTemplate(string projectId, string locationId, string certificateTemplateId)

Creates a CertificateTemplateName with the pattern projects/{project}/locations/{location}/certificateTemplates/{certificate_template}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

certificateTemplateIdString

The CertificateTemplate ID. Must not be null or empty.

Returns
TypeDescription
CertificateTemplateName

A new instance of CertificateTemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CertificateTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CertificateTemplateName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
CertificateTemplateName

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

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

Parameter
NameDescription
certificateTemplateNameString

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

Returns
TypeDescription
CertificateTemplateName

The parsed CertificateTemplateName if successful.

Remarks

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

  • projects/{project}/locations/{location}/certificateTemplates/{certificate_template}

Parse(String, Boolean)

public static CertificateTemplateName Parse(string certificateTemplateName, bool allowUnparsed)

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

Parameters
NameDescription
certificateTemplateNameString

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
CertificateTemplateName

The parsed CertificateTemplateName if successful.

Remarks

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

  • projects/{project}/locations/{location}/certificateTemplates/{certificate_template}
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 CertificateTemplateName)

public static bool TryParse(string certificateTemplateName, out CertificateTemplateName result)

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

Parameters
NameDescription
certificateTemplateNameString

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

resultCertificateTemplateName

When this method returns, the parsed CertificateTemplateName, 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}/certificateTemplates/{certificate_template}

TryParse(String, Boolean, out CertificateTemplateName)

public static bool TryParse(string certificateTemplateName, bool allowUnparsed, out CertificateTemplateName result)

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

Parameters
NameDescription
certificateTemplateNameString

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.

resultCertificateTemplateName

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

Operators

Equality(CertificateTemplateName, CertificateTemplateName)

public static bool operator ==(CertificateTemplateName a, CertificateTemplateName b)
Parameters
NameDescription
aCertificateTemplateName
bCertificateTemplateName
Returns
TypeDescription
Boolean

Inequality(CertificateTemplateName, CertificateTemplateName)

public static bool operator !=(CertificateTemplateName a, CertificateTemplateName b)
Parameters
NameDescription
aCertificateTemplateName
bCertificateTemplateName
Returns
TypeDescription
Boolean