Class CertificateName

Resource name for the Certificate resource.

Inheritance

System.Object

CertificateName

Implements

IResourceName

System.IEquatable<CertificateName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.Security.PrivateCA.V1Beta1

Assembly: Google.Cloud.Security.PrivateCA.V1Beta1.dll

Syntax

public sealed class CertificateName : IResourceName, IEquatable<CertificateName>

Constructors

CertificateName(String, String, String, String)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	certificateAuthorityId	The CertificateAuthority ID. Must not be null or empty.
System.String	certificateId	The Certificate ID. Must not be null or empty.

Properties

CertificateAuthorityId

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

Declaration

public string CertificateAuthorityId { get; }

Property Value

Type	Description
System.String

CertificateId

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

Declaration

public string CertificateId { get; }

Property Value

Type	Description
System.String

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

LocationId

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

Declaration

public string LocationId { get; }

Property Value

Type	Description
System.String

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
System.String

Type

The CertificateName.ResourceNameType of the contained resource name.

Declaration

public CertificateName.ResourceNameType Type { get; }

Property Value

Type	Description
CertificateName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(String, String, String, String)

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

Declaration

public static string Format(string projectId, string locationId, string certificateAuthorityId, string certificateId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	certificateAuthorityId	The CertificateAuthority ID. Must not be null or empty.
System.String	certificateId	The Certificate ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this CertificateName with pattern projects/{project}/locations/{location}/certificateAuthorities/{certificate_authority}/certificates/{certificate} .

FormatProjectLocationCertificateAuthorityCertificate(String, String, String, String)

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

Declaration

public static string FormatProjectLocationCertificateAuthorityCertificate(string projectId, string locationId, string certificateAuthorityId, string certificateId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	certificateAuthorityId	The CertificateAuthority ID. Must not be null or empty.
System.String	certificateId	The Certificate ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this CertificateName with pattern projects/{project}/locations/{location}/certificateAuthorities/{certificate_authority}/certificates/{certificate} .

FromProjectLocationCertificateAuthorityCertificate(String, String, String, String)

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

Declaration

public static CertificateName FromProjectLocationCertificateAuthorityCertificate(string projectId, string locationId, string certificateAuthorityId, string certificateId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	certificateAuthorityId	The CertificateAuthority ID. Must not be null or empty.
System.String	certificateId	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)

Creates a CertificateName containing an unparsed resource name.

Declaration

public static CertificateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	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()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static CertificateName Parse(string certificateName)

Parameters

Type	Name	Description
System.String	certificateName	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}/certificateAuthorities/{certificate_authority}/certificates/{certificate}

Parse(String, Boolean)

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

Declaration

public static CertificateName Parse(string certificateName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	certificateName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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}/certificateAuthorities/{certificate_authority}/certificates/{certificate}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out CertificateName)

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

Declaration

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

Parameters

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

Returns

Type	Description
System.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}/certificateAuthorities/{certificate_authority}/certificates/{certificate}

TryParse(String, Boolean, out CertificateName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	certificateName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
CertificateName	result	When this method returns, the parsed CertificateName, or null if parsing failed.

Returns

Type	Description
System.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}/certificateAuthorities/{certificate_authority}/certificates/{certificate}

Or may be in any format if allowUnparsed is true.

Operators

Equality(CertificateName, CertificateName)

Declaration

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

Parameters

Type	Name	Description
CertificateName	a
CertificateName	b

Returns

Type	Description
System.Boolean

Inequality(CertificateName, CertificateName)

Declaration

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

Parameters

Type	Name	Description
CertificateName	a
CertificateName	b

Returns

Type	Description
System.Boolean