Google Cloud reCAPTCHA Enterprise v1 API - Class AssessmentName (2.4.0) 

public sealed class AssessmentName : IResourceName, IEquatable<AssessmentName>

Reference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class AssessmentName.

Resource name for the Assessment resource.

Inheritance

object > AssessmentName

Namespace

GoogleGoogle.CloudGoogle.Cloud.RecaptchaEnterpriseV1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

AssessmentName(string, string)

public AssessmentName(string projectId, string assessmentId)

Constructs a new instance of a AssessmentName class from the component parts of pattern projects/{project}/assessments/{assessment}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
assessmentId string

The Assessment ID. Must not be null or empty.

Properties

AssessmentId

public string AssessmentId { get; }

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

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

The AssessmentName.ResourceNameType of the contained resource name.

Property Value
Type Description
AssessmentNameResourceNameType

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)

public static string Format(string projectId, string assessmentId)

Formats the IDs into the string representation of this AssessmentName with pattern projects/{project}/assessments/{assessment}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
assessmentId string

The Assessment ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AssessmentName with pattern projects/{project}/assessments/{assessment}.

FormatProjectAssessment(string, string)

public static string FormatProjectAssessment(string projectId, string assessmentId)

Formats the IDs into the string representation of this AssessmentName with pattern projects/{project}/assessments/{assessment}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
assessmentId string

The Assessment ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AssessmentName with pattern projects/{project}/assessments/{assessment}.

FromProjectAssessment(string, string)

public static AssessmentName FromProjectAssessment(string projectId, string assessmentId)

Creates a AssessmentName with the pattern projects/{project}/assessments/{assessment}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
assessmentId string

The Assessment ID. Must not be null or empty.
Returns
Type Description
AssessmentName

A new instance of AssessmentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AssessmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AssessmentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
assessmentName string

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

The parsed AssessmentName if successful.
Remarks

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

  • projects/{project}/assessments/{assessment}

Parse(string, bool)

public static AssessmentName Parse(string assessmentName, bool allowUnparsed)

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

Parameters
Name Description
assessmentName 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
AssessmentName

The parsed AssessmentName if successful.
Remarks

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

  • projects/{project}/assessments/{assessment}
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 AssessmentName)

public static bool TryParse(string assessmentName, out AssessmentName result)

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

Parameters
Name Description
assessmentName string

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

When this method returns, the parsed AssessmentName, 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}/assessments/{assessment}

TryParse(string, bool, out AssessmentName)

public static bool TryParse(string assessmentName, bool allowUnparsed, out AssessmentName result)

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

Parameters
Name Description
assessmentName 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 AssessmentName

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

Operators

operator ==(AssessmentName, AssessmentName)

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

operator !=(AssessmentName, AssessmentName)

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