Certificate Authority v1 API - Class CertificateAuthorityName (3.1.0)

public sealed class CertificateAuthorityName : IResourceName, IEquatable<CertificateAuthorityName>

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

Resource name for the CertificateAuthority resource.

Inheritance

Object > CertificateAuthorityName

Implements

IResourceName, IEquatable<CertificateAuthorityName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Security.PrivateCA.V1

Assembly

Google.Cloud.Security.PrivateCA.V1.dll

Constructors

CertificateAuthorityName(String, String, String, String)

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

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

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.
`certificateAuthorityId`	`String` The `CertificateAuthority` 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`

CertificateAuthorityId

public string CertificateAuthorityId { get; }

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

The CertificateAuthorityName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`CertificateAuthorityName.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 certificateAuthorityId)

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

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.
`certificateAuthorityId`	`String` The `CertificateAuthority` ID. Must not be `null` or empty.

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

FormatProjectLocationCaPoolCertificateAuthority(String, String, String, String)

public static string FormatProjectLocationCaPoolCertificateAuthority(string projectId, string locationId, string caPoolId, string certificateAuthorityId)

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.
`certificateAuthorityId`	`String` The `CertificateAuthority` ID. Must not be `null` or empty.

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

FromProjectLocationCaPoolCertificateAuthority(String, String, String, String)

public static CertificateAuthorityName FromProjectLocationCaPoolCertificateAuthority(string projectId, string locationId, string caPoolId, string certificateAuthorityId)

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

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.
`certificateAuthorityId`	`String` 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)

public static CertificateAuthorityName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CertificateAuthorityName containing an unparsed resource name.

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

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static CertificateAuthorityName Parse(string certificateAuthorityName)

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

Parameter
Name	Description
`certificateAuthorityName`	`String` 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}/caPools/{ca_pool}/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
Name	Description
`certificateAuthorityName`	`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
`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}/caPools/{ca_pool}/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
Type	Description
`String`	The string representation of the resource name.

Overrides

Object.ToString()

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

Returns
Type	Description
`Boolean`

Inequality(CertificateAuthorityName, CertificateAuthorityName)

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

Parameters
Name	Description
`a`	`CertificateAuthorityName`
`b`	`CertificateAuthorityName`

Returns
Type	Description
`Boolean`