Certificate Manager v1 API - Class TrustConfigName (2.6.0)

public sealed class TrustConfigName : IResourceName, IEquatable<TrustConfigName>

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

Resource name for the TrustConfig resource.

Inheritance

object > TrustConfigName

Namespace

Google.Cloud.CertificateManager.V1

Assembly

Google.Cloud.CertificateManager.V1.dll

Constructors

TrustConfigName(string, string, string)

public TrustConfigName(string projectId, string locationId, string trustConfigId)

Constructs a new instance of a TrustConfigName class from the component parts of pattern projects/{project}/locations/{location}/trustConfigs/{trust_config}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

trustConfigIdstring

The TrustConfig ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

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

TrustConfigId

public string TrustConfigId { get; }

The TrustConfig ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

Type

public TrustConfigName.ResourceNameType Type { get; }

The TrustConfigName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TrustConfigNameResourceNameType

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

Formats the IDs into the string representation of this TrustConfigName with pattern projects/{project}/locations/{location}/trustConfigs/{trust_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

trustConfigIdstring

The TrustConfig ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TrustConfigName with pattern projects/{project}/locations/{location}/trustConfigs/{trust_config}.

FormatProjectLocationTrustConfig(string, string, string)

public static string FormatProjectLocationTrustConfig(string projectId, string locationId, string trustConfigId)

Formats the IDs into the string representation of this TrustConfigName with pattern projects/{project}/locations/{location}/trustConfigs/{trust_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

trustConfigIdstring

The TrustConfig ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TrustConfigName with pattern projects/{project}/locations/{location}/trustConfigs/{trust_config}.

FromProjectLocationTrustConfig(string, string, string)

public static TrustConfigName FromProjectLocationTrustConfig(string projectId, string locationId, string trustConfigId)

Creates a TrustConfigName with the pattern projects/{project}/locations/{location}/trustConfigs/{trust_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

trustConfigIdstring

The TrustConfig ID. Must not be null or empty.

Returns
TypeDescription
TrustConfigName

A new instance of TrustConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TrustConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TrustConfigName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TrustConfigName

A new instance of TrustConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static TrustConfigName Parse(string trustConfigName)

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

Parameter
NameDescription
trustConfigNamestring

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

Returns
TypeDescription
TrustConfigName

The parsed TrustConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/trustConfigs/{trust_config}

Parse(string, bool)

public static TrustConfigName Parse(string trustConfigName, bool allowUnparsed)

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

Parameters
NameDescription
trustConfigNamestring

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

allowUnparsedbool

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
TrustConfigName

The parsed TrustConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/trustConfigs/{trust_config}
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 TrustConfigName)

public static bool TryParse(string trustConfigName, out TrustConfigName result)

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

Parameters
NameDescription
trustConfigNamestring

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

resultTrustConfigName

When this method returns, the parsed TrustConfigName, or null if parsing failed.

Returns
TypeDescription
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}/trustConfigs/{trust_config}

TryParse(string, bool, out TrustConfigName)

public static bool TryParse(string trustConfigName, bool allowUnparsed, out TrustConfigName result)

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

Parameters
NameDescription
trustConfigNamestring

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

allowUnparsedbool

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.

resultTrustConfigName

When this method returns, the parsed TrustConfigName, or null if parsing failed.

Returns
TypeDescription
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}/trustConfigs/{trust_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TrustConfigName, TrustConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aTrustConfigName

The first resource name to compare, or null.

bTrustConfigName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(TrustConfigName, TrustConfigName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aTrustConfigName

The first resource name to compare, or null.

bTrustConfigName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.