Certificate Manager v1 API - Class CaPoolName (2.3.0) 

public sealed class CaPoolName : IResourceName, IEquatable<CaPoolName>

Reference documentation and code samples for the Certificate Manager v1 API class CaPoolName.

Resource name for the CaPool resource.

Inheritance

object > CaPoolName

Namespace

GoogleCloudGoogle.Cloud.CertificateManagerV1

Assembly

Google.Cloud.CertificateManager.V1.dll

Constructors

CaPoolName(string, string, string)

public CaPoolName(string projectId, string locationId, string caPoolId)

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

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.

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

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

The CaPoolName.ResourceNameType of the contained resource name.

Property Value
Type Description
CaPoolNameResourceNameType

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)

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

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

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.
Returns
Type Description
string

The string representation of this CaPoolName with pattern projects/{project}/locations/{location}/caPools/{ca_pool}.

FormatProjectLocationCaPool(string, string, string)

public static string FormatProjectLocationCaPool(string projectId, string locationId, string caPoolId)

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

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.
Returns
Type Description
string

The string representation of this CaPoolName with pattern projects/{project}/locations/{location}/caPools/{ca_pool}.

FromProjectLocationCaPool(string, string, string)

public static CaPoolName FromProjectLocationCaPool(string projectId, string locationId, string caPoolId)

Creates a CaPoolName with the pattern projects/{project}/locations/{location}/caPools/{ca_pool}.

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.
Returns
Type Description
CaPoolName

A new instance of CaPoolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CaPoolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CaPoolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
CaPoolName

A new instance of CaPoolName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static CaPoolName Parse(string caPoolName)

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

Parameter
Name Description
caPoolName string

The resource name in string form. Must not be null.
Returns
Type Description
CaPoolName

The parsed CaPoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/caPools/{ca_pool}

Parse(string, bool)

public static CaPoolName Parse(string caPoolName, bool allowUnparsed)

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

Parameters
Name Description
caPoolName 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
CaPoolName

The parsed CaPoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/caPools/{ca_pool}
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

TryParse(string, out CaPoolName)

public static bool TryParse(string caPoolName, out CaPoolName result)

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

Parameters
Name Description
caPoolName string

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

When this method returns, the parsed CaPoolName, 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}

TryParse(string, bool, out CaPoolName)

public static bool TryParse(string caPoolName, bool allowUnparsed, out CaPoolName result)

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

Parameters
Name Description
caPoolName 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 CaPoolName

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

Operators

operator ==(CaPoolName, CaPoolName)

public static bool operator ==(CaPoolName a, CaPoolName b)
Parameters
Name Description
a CaPoolName
b CaPoolName
Returns
Type Description
bool

operator !=(CaPoolName, CaPoolName)

public static bool operator !=(CaPoolName a, CaPoolName b)
Parameters
Name Description
a CaPoolName
b CaPoolName
Returns
Type Description
bool