Certificate Authority v1 API - Class CertificateName (3.1.0)

public sealed class CertificateName : IResourceName, IEquatable<CertificateName>

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

Resource name for the Certificate resource.

Inheritance

Object > CertificateName

Implements

IResourceName, IEquatable<CertificateName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Security.PrivateCA.V1

Assembly

Google.Cloud.Security.PrivateCA.V1.dll

Constructors

CertificateName(String, String, String, String)

public CertificateName(string projectId, string locationId, string caPoolId, string certificateId)

Constructs a new instance of a CertificateName class from the component parts of pattern projects/{project}/locations/{location}/caPools/{ca_pool}/certificates/{certificate}

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.
`caPoolId`	`String` The `CaPool` ID. Must not be `null` or empty.
`certificateId`	`String` The `Certificate` ID. Must not be `null` or empty.

Properties

CaPoolId

public string CaPoolId { get; }

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

Property Value
Type	Description
`String`

CertificateId

public string CertificateId { get; }

The Certificate 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
`Boolean`

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 CertificateName.ResourceNameType Type { get; }

The CertificateName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`CertificateName.ResourceNameType`

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

Formats the IDs into the string representation of this CertificateName with pattern projects/{project}/locations/{location}/caPools/{ca_pool}/certificates/{certificate}.

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.
`caPoolId`	`String` The `CaPool` ID. Must not be `null` or empty.
`certificateId`	`String` The `Certificate` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this CertificateName with pattern `projects/{project}/locations/{location}/caPools/{ca_pool}/certificates/{certificate}`.

FormatProjectLocationCaPoolCertificate(String, String, String, String)

public static string FormatProjectLocationCaPoolCertificate(string projectId, string locationId, string caPoolId, string certificateId)

Formats the IDs into the string representation of this CertificateName with pattern projects/{project}/locations/{location}/caPools/{ca_pool}/certificates/{certificate}.

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.
`caPoolId`	`String` The `CaPool` ID. Must not be `null` or empty.
`certificateId`	`String` The `Certificate` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this CertificateName with pattern `projects/{project}/locations/{location}/caPools/{ca_pool}/certificates/{certificate}`.

FromProjectLocationCaPoolCertificate(String, String, String, String)

public static CertificateName FromProjectLocationCaPoolCertificate(string projectId, string locationId, string caPoolId, string certificateId)

Creates a CertificateName with the pattern projects/{project}/locations/{location}/caPools/{ca_pool}/certificates/{certificate}.

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.
`caPoolId`	`String` The `CaPool` ID. Must not be `null` or empty.
`certificateId`	`String` The `Certificate` ID. Must not be `null` or empty.

Returns
Type	Description
`CertificateName`	A new instance of CertificateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CertificateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CertificateName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`CertificateName`	A new instance of CertificateName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static CertificateName Parse(string certificateName)

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

Parameter
Name	Description
`certificateName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`CertificateName`	The parsed CertificateName if successful.

Remarks

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

projects/{project}/locations/{location}/caPools/{ca_pool}/certificates/{certificate}

Parse(String, Boolean)

public static CertificateName Parse(string certificateName, bool allowUnparsed)

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

Parameters
Name	Description
`certificateName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`CertificateName`	The parsed CertificateName if successful.

Remarks

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

projects/{project}/locations/{location}/caPools/{ca_pool}/certificates/{certificate}

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

Object.ToString()

TryParse(String, out CertificateName)

public static bool TryParse(string certificateName, out CertificateName result)

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

Parameters
Name	Description
`certificateName`	`String` The resource name in string form. Must not be `null`.
`result`	`CertificateName` When this method returns, the parsed CertificateName, or `null` if parsing failed.

Returns
Type	Description
`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}/caPools/{ca_pool}/certificates/{certificate}

TryParse(String, Boolean, out CertificateName)

public static bool TryParse(string certificateName, bool allowUnparsed, out CertificateName result)

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

Parameters
Name	Description
`certificateName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`CertificateName` When this method returns, the parsed CertificateName, or `null` if parsing failed.

Returns
Type	Description
`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}/caPools/{ca_pool}/certificates/{certificate}

Or may be in any format if allowUnparsed is true.

Operators

Equality(CertificateName, CertificateName)

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

Parameters
Name	Description
`a`	`CertificateName`
`b`	`CertificateName`

Returns
Type	Description
`Boolean`

Inequality(CertificateName, CertificateName)

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

Parameters
Name	Description
`a`	`CertificateName`
`b`	`CertificateName`

Returns
Type	Description
`Boolean`