Confidential Computing v1 API - Class ChallengeName (1.1.0)

public sealed class ChallengeName : IResourceName, IEquatable<ChallengeName>

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

Resource name for the Challenge resource.

Inheritance

object > ChallengeName

Namespace

Google.Cloud.ConfidentialComputing.V1

Assembly

Google.Cloud.ConfidentialComputing.V1.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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

uuidIdstring

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

Type

public ChallengeName.ResourceNameType Type { get; }

The ChallengeName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ChallengeNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

UuidId

public string UuidId { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

uuidIdstring

The Uuid ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

uuidIdstring

The Uuid ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

uuidIdstring

The Uuid ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ChallengeName

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

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

Parameter
NameDescription
challengeNamestring

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

Returns
TypeDescription
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
NameDescription
challengeNamestring

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
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
TypeDescription
string

The string representation of the resource name.

Overrides

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
NameDescription
challengeNamestring

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

resultChallengeName

When this method returns, the parsed ChallengeName, 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}/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
NameDescription
challengeNamestring

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.

resultChallengeName

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

Operators

operator ==(ChallengeName, ChallengeName)

public static bool operator ==(ChallengeName a, ChallengeName b)
Parameters
NameDescription
aChallengeName
bChallengeName
Returns
TypeDescription
bool

operator !=(ChallengeName, ChallengeName)

public static bool operator !=(ChallengeName a, ChallengeName b)
Parameters
NameDescription
aChallengeName
bChallengeName
Returns
TypeDescription
bool