Class CertificateAuthorityName

public sealed class CertificateAuthorityName : IResourceName, IEquatable<CertificateAuthorityName>

Resource name for the CertificateAuthority resource.

Inheritance

Object > CertificateAuthorityName

Namespace

Google.Cloud.Security.PrivateCA.V1Beta1

Assembly

Google.Cloud.Security.PrivateCA.V1Beta1.dll

Constructors

CertificateAuthorityName(String, String, String)

public CertificateAuthorityName(string projectId, string locationId, string certificateAuthorityId)

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

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringcertificateAuthorityId

The CertificateAuthority ID. Must not be null or empty.

Properties

CertificateAuthorityId

public string CertificateAuthorityId { get; }

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

The CertificateAuthorityName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
CertificateAuthorityName.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 certificateAuthorityId)

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

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringcertificateAuthorityId

The CertificateAuthority ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this CertificateAuthorityName with pattern projects/{project}/locations/{location}/certificateAuthorities/{certificate_authority}.

FormatProjectLocationCertificateAuthority(String, String, String)

public static string FormatProjectLocationCertificateAuthority(string projectId, string locationId, string certificateAuthorityId)

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

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringcertificateAuthorityId

The CertificateAuthority ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this CertificateAuthorityName with pattern projects/{project}/locations/{location}/certificateAuthorities/{certificate_authority}.

FromProjectLocationCertificateAuthority(String, String, String)

public static CertificateAuthorityName FromProjectLocationCertificateAuthority(string projectId, string locationId, string certificateAuthorityId)

Creates a CertificateAuthorityName with the pattern projects/{project}/locations/{location}/certificateAuthorities/{certificate_authority}.

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringcertificateAuthorityId

The CertificateAuthority ID. Must not be null or empty.

Returns
TypeDescription
CertificateAuthorityName

A new instance of CertificateAuthorityName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CertificateAuthorityName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CertificateAuthorityName containing an unparsed resource name.

Parameter
TypeNameDescription
UnparsedResourceNameunparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
CertificateAuthorityName

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

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

Parameter
TypeNameDescription
StringcertificateAuthorityName

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

Returns
TypeDescription
CertificateAuthorityName

The parsed CertificateAuthorityName if successful.

Remarks

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

  • projects/{project}/locations/{location}/certificateAuthorities/{certificate_authority}

Parse(String, Boolean)

public static CertificateAuthorityName Parse(string certificateAuthorityName, bool allowUnparsed)

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

Parameters
TypeNameDescription
StringcertificateAuthorityName

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

BooleanallowUnparsed

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
CertificateAuthorityName

The parsed CertificateAuthorityName if successful.

Remarks

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

  • projects/{project}/locations/{location}/certificateAuthorities/{certificate_authority}
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 CertificateAuthorityName)

public static bool TryParse(string certificateAuthorityName, out CertificateAuthorityName result)

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

Parameters
TypeNameDescription
StringcertificateAuthorityName

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

CertificateAuthorityNameresult

When this method returns, the parsed CertificateAuthorityName, 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}/certificateAuthorities/{certificate_authority}

TryParse(String, Boolean, out CertificateAuthorityName)

public static bool TryParse(string certificateAuthorityName, bool allowUnparsed, out CertificateAuthorityName result)

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

Parameters
TypeNameDescription
StringcertificateAuthorityName

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

BooleanallowUnparsed

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.

CertificateAuthorityNameresult

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

Operators

Equality(CertificateAuthorityName, CertificateAuthorityName)

public static bool operator ==(CertificateAuthorityName a, CertificateAuthorityName b)
Parameters
TypeNameDescription
CertificateAuthorityNamea
CertificateAuthorityNameb
Returns
TypeDescription
Boolean

Inequality(CertificateAuthorityName, CertificateAuthorityName)

public static bool operator !=(CertificateAuthorityName a, CertificateAuthorityName b)
Parameters
TypeNameDescription
CertificateAuthorityNamea
CertificateAuthorityNameb
Returns
TypeDescription
Boolean