Confidential Computing v1alpha1 API - Class ChallengeName (1.0.0-alpha05)

Version latest

• 1.0.0-alpha05 (latest)
• 1.0.0-alpha04

public sealed class ChallengeName : IResourceName, IEquatable<ChallengeName>

Reference documentation and code samples for the Confidential Computing v1alpha1 API class ChallengeName.

Resource name for the Challenge resource.

Inheritance

object > ChallengeName

Implements

IResourceName, IEquatableChallengeName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ConfidentialComputing.V1Alpha1

Assembly

Google.Cloud.ConfidentialComputing.V1Alpha1.dll

Constructors

ChallengeName(string, string, string)

public ChallengeName(string projectId, string locationId, string uuidId)

Constructs a new instance of a ChallengeName class from the component parts of pattern projects/{project}/locations/{location}/challenges/{uuid}

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.
uuidId	string The Uuid 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
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 ChallengeName.ResourceNameType Type { get; }

The ChallengeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ChallengeNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
UnparsedResourceName

UuidId

public string UuidId { get; }

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

Property Value
Type	Description
string

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this ChallengeName with pattern projects/{project}/locations/{location}/challenges/{uuid}.

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.
uuidId	string The Uuid ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ChallengeName with pattern projects/{project}/locations/{location}/challenges/{uuid}.

FormatProjectLocationUuid(string, string, string)

public static string FormatProjectLocationUuid(string projectId, string locationId, string uuidId)

Formats the IDs into the string representation of this ChallengeName with pattern projects/{project}/locations/{location}/challenges/{uuid}.

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.
uuidId	string The Uuid ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ChallengeName with pattern projects/{project}/locations/{location}/challenges/{uuid}.

FromProjectLocationUuid(string, string, string)

public static ChallengeName FromProjectLocationUuid(string projectId, string locationId, string uuidId)

Creates a ChallengeName with the pattern projects/{project}/locations/{location}/challenges/{uuid}.

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.
uuidId	string The Uuid ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static ChallengeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ChallengeName containing an unparsed resource name.

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

Returns
Type	Description
ChallengeName	A new instance of ChallengeName 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 ChallengeName Parse(string challengeName)

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

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

Returns
Type	Description
ChallengeName	The parsed ChallengeName if successful.

Remarks

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

• projects/{project}/locations/{location}/challenges/{uuid}

Parse(string, bool)

public static ChallengeName Parse(string challengeName, bool allowUnparsed)

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

Parameters
Name	Description
challengeName	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
ChallengeName	The parsed ChallengeName if successful.

Remarks

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

• projects/{project}/locations/{location}/challenges/{uuid}

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

public static bool TryParse(string challengeName, out ChallengeName result)

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

Parameters
Name	Description
challengeName	string The resource name in string form. Must not be null.
result	ChallengeName When this method returns, the parsed ChallengeName, 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}/challenges/{uuid}

TryParse(string, bool, out ChallengeName)

public static bool TryParse(string challengeName, bool allowUnparsed, out ChallengeName result)

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

Parameters
Name	Description
challengeName	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	ChallengeName When this method returns, the parsed ChallengeName, 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}/challenges/{uuid}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ChallengeName, ChallengeName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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