Public Certificate Authority v1 API - Class ExternalAccountKeyName (1.0.0-beta01)

public sealed class ExternalAccountKeyName : IResourceName, IEquatable<ExternalAccountKeyName>

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

Resource name for the ExternalAccountKey resource.

Inheritance

object > ExternalAccountKeyName

Implements

IResourceName, IEquatable ExternalAccountKeyName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Security.PublicCA.V1

Assembly

Google.Cloud.Security.PublicCA.V1.dll

Constructors

ExternalAccountKeyName(string, string, string)

public ExternalAccountKeyName(string projectId, string locationId, string externalAccountKeyId)

Constructs a new instance of a ExternalAccountKeyName class from the component parts of pattern projects/{project}/locations/{location}/externalAccountKeys/{external_account_key}

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

Properties

ExternalAccountKeyId

public string ExternalAccountKeyId { get; }

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

The ExternalAccountKeyName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ExternalAccountKeyNameResourceNameType`

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

Formats the IDs into the string representation of this ExternalAccountKeyName with pattern projects/{project}/locations/{location}/externalAccountKeys/{external_account_key}.

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

Returns
Type	Description
`string`	The string representation of this ExternalAccountKeyName with pattern `projects/{project}/locations/{location}/externalAccountKeys/{external_account_key}`.

FormatProjectLocationExternalAccountKey(string, string, string)

public static string FormatProjectLocationExternalAccountKey(string projectId, string locationId, string externalAccountKeyId)

Formats the IDs into the string representation of this ExternalAccountKeyName with pattern projects/{project}/locations/{location}/externalAccountKeys/{external_account_key}.

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

Returns
Type	Description
`string`	The string representation of this ExternalAccountKeyName with pattern `projects/{project}/locations/{location}/externalAccountKeys/{external_account_key}`.

FromProjectLocationExternalAccountKey(string, string, string)

public static ExternalAccountKeyName FromProjectLocationExternalAccountKey(string projectId, string locationId, string externalAccountKeyId)

Creates a ExternalAccountKeyName with the pattern projects/{project}/locations/{location}/externalAccountKeys/{external_account_key}.

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

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

FromUnparsed(UnparsedResourceName)

public static ExternalAccountKeyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ExternalAccountKeyName containing an unparsed resource name.

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

Returns
Type	Description
`ExternalAccountKeyName`	A new instance of ExternalAccountKeyName 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 ExternalAccountKeyName Parse(string externalAccountKeyName)

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

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

Returns
Type	Description
`ExternalAccountKeyName`	The parsed ExternalAccountKeyName if successful.

Remarks

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

projects/{project}/locations/{location}/externalAccountKeys/{external_account_key}

Parse(string, bool)

public static ExternalAccountKeyName Parse(string externalAccountKeyName, bool allowUnparsed)

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

Parameters
Name	Description
`externalAccountKeyName`	`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
`ExternalAccountKeyName`	The parsed ExternalAccountKeyName if successful.

Remarks

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

projects/{project}/locations/{location}/externalAccountKeys/{external_account_key}

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

public static bool TryParse(string externalAccountKeyName, out ExternalAccountKeyName result)

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

Parameters
Name	Description
`externalAccountKeyName`	`string` The resource name in string form. Must not be `null`.
`result`	`ExternalAccountKeyName` When this method returns, the parsed ExternalAccountKeyName, 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}/externalAccountKeys/{external_account_key}

TryParse(string, bool, out ExternalAccountKeyName)

public static bool TryParse(string externalAccountKeyName, bool allowUnparsed, out ExternalAccountKeyName result)

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

Parameters
Name	Description
`externalAccountKeyName`	`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`	`ExternalAccountKeyName` When this method returns, the parsed ExternalAccountKeyName, 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}/externalAccountKeys/{external_account_key}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ExternalAccountKeyName, ExternalAccountKeyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`ExternalAccountKeyName` The first resource name to compare, or null.
`b`	`ExternalAccountKeyName` 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 !=(ExternalAccountKeyName, ExternalAccountKeyName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`ExternalAccountKeyName` The first resource name to compare, or null.
`b`	`ExternalAccountKeyName` 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.