Certificate Authority v1 API - Class CertificateRevocationListName (3.4.0)

public sealed class CertificateRevocationListName : IResourceName, IEquatable<CertificateRevocationListName>

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

Resource name for the CertificateRevocationList resource.

Inheritance

object > CertificateRevocationListName

Implements

IResourceName, IEquatable CertificateRevocationListName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Security.PrivateCA.V1

Assembly

Google.Cloud.Security.PrivateCA.V1.dll

Constructors

CertificateRevocationListName(string, string, string, string, string)

public CertificateRevocationListName(string projectId, string locationId, string caPoolId, string certificateAuthorityId, string certificateRevocationListId)

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

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.
`certificateRevocationListId`	`string` The `CertificateRevocationList` 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`

CertificateRevocationListId

public string CertificateRevocationListId { get; }

The CertificateRevocationList 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
`bool`

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

The CertificateRevocationListName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`CertificateRevocationListNameResourceNameType`

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

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

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

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.
`certificateRevocationListId`	`string` The `CertificateRevocationList` ID. Must not be `null` or empty.

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

FormatProjectLocationCaPoolCertificateAuthorityCertificateRevocationList(string, string, string, string, string)

public static string FormatProjectLocationCaPoolCertificateAuthorityCertificateRevocationList(string projectId, string locationId, string caPoolId, string certificateAuthorityId, string certificateRevocationListId)

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.
`certificateRevocationListId`	`string` The `CertificateRevocationList` ID. Must not be `null` or empty.

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

FromProjectLocationCaPoolCertificateAuthorityCertificateRevocationList(string, string, string, string, string)

public static CertificateRevocationListName FromProjectLocationCaPoolCertificateAuthorityCertificateRevocationList(string projectId, string locationId, string caPoolId, string certificateAuthorityId, string certificateRevocationListId)

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

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.
`certificateRevocationListId`	`string` The `CertificateRevocationList` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static CertificateRevocationListName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CertificateRevocationListName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static CertificateRevocationListName Parse(string certificateRevocationListName)

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

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

Returns
Type	Description
`CertificateRevocationListName`	The parsed CertificateRevocationListName 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}/certificateRevocationLists/{certificate_revocation_list}

Parse(string, bool)

public static CertificateRevocationListName Parse(string certificateRevocationListName, bool allowUnparsed)

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

Parameters
Name	Description
`certificateRevocationListName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` 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
`CertificateRevocationListName`	The parsed CertificateRevocationListName 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}/certificateRevocationLists/{certificate_revocation_list}

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

public static bool TryParse(string certificateRevocationListName, out CertificateRevocationListName result)

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

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

Returns
Type	Description
`bool`	`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}/certificateRevocationLists/{certificate_revocation_list}

TryParse(string, bool, out CertificateRevocationListName)

public static bool TryParse(string certificateRevocationListName, bool allowUnparsed, out CertificateRevocationListName result)

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

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

Returns
Type	Description
`bool`	`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}/certificateRevocationLists/{certificate_revocation_list}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CertificateRevocationListName, CertificateRevocationListName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`CertificateRevocationListName` The first resource name to compare, or null.
`b`	`CertificateRevocationListName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is the same as the value of `b`; otherwise, false.

operator !=(CertificateRevocationListName, CertificateRevocationListName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`CertificateRevocationListName` The first resource name to compare, or null.
`b`	`CertificateRevocationListName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is different from the value of `b`; otherwise, false.