Class CertificateAuthorityName

Resource name for the CertificateAuthority resource.

Inheritance

System.Object

CertificateAuthorityName

Implements

IResourceName

System.IEquatable<CertificateAuthorityName>

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 CertificateAuthorityName : IResourceName, IEquatable<CertificateAuthorityName>

Constructors

CertificateAuthorityName(String, String, String)

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

Declaration

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

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.

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

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 CertificateAuthorityName.ResourceNameType of the contained resource name.

Declaration

public CertificateAuthorityName.ResourceNameType Type { get; }

Property Value

Type	Description
CertificateAuthorityName.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)

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

Declaration

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

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.

Returns

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

FormatProjectLocationCertificateAuthority(String, String, String)

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

Declaration

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

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.

Returns

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

FromProjectLocationCertificateAuthority(String, String, String)

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

Declaration

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

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.

Returns

Type	Description
CertificateAuthorityName	A new instance of CertificateAuthorityName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a CertificateAuthorityName containing an unparsed resource name.

Declaration

public static CertificateAuthorityName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
CertificateAuthorityName	A new instance of CertificateAuthorityName 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 CertificateAuthorityName instance.

Declaration

public static CertificateAuthorityName Parse(string certificateAuthorityName)

Parameters

Type	Name	Description
System.String	certificateAuthorityName	The resource name in string form. Must not be `null`.

Returns

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

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

Declaration

public static CertificateAuthorityName Parse(string certificateAuthorityName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	certificateAuthorityName	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
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()

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 CertificateAuthorityName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	certificateAuthorityName	The resource name in string form. Must not be `null`.
CertificateAuthorityName	result	When this method returns, the parsed CertificateAuthorityName, 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}

TryParse(String, Boolean, out CertificateAuthorityName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	certificateAuthorityName	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.
CertificateAuthorityName	result	When this method returns, the parsed CertificateAuthorityName, 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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(CertificateAuthorityName, CertificateAuthorityName)

Declaration

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

Parameters

Type	Name	Description
CertificateAuthorityName	a
CertificateAuthorityName	b

Returns

Type	Description
System.Boolean

Inequality(CertificateAuthorityName, CertificateAuthorityName)

Declaration

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

Parameters

Type	Name	Description
CertificateAuthorityName	a
CertificateAuthorityName	b

Returns

Type	Description
System.Boolean