Google Cloud Dialogflow v2beta1 API - Class GeneratorEvaluationName (1.0.0-beta24)

public sealed class GeneratorEvaluationName : IResourceName, IEquatable<GeneratorEvaluationName>

Reference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class GeneratorEvaluationName.

Resource name for the GeneratorEvaluation resource.

Inheritance

object > GeneratorEvaluationName

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Constructors

GeneratorEvaluationName(string, string, string, string)

public GeneratorEvaluationName(string projectId, string locationId, string generatorId, string evaluationId)

Constructs a new instance of a GeneratorEvaluationName class from the component parts of pattern projects/{project}/locations/{location}/generators/{generator}/evaluations/{evaluation}

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.

generatorId string

The Generator ID. Must not be null or empty.

evaluationId string

The Evaluation ID. Must not be null or empty.

Properties

EvaluationId

public string EvaluationId { get; }

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

Property Value
Type Description
string

GeneratorId

public string GeneratorId { get; }

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

The GeneratorEvaluationName.ResourceNameType of the contained resource name.

Property Value
Type Description
GeneratorEvaluationNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string generatorId, string evaluationId)

Formats the IDs into the string representation of this GeneratorEvaluationName with pattern projects/{project}/locations/{location}/generators/{generator}/evaluations/{evaluation}.

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.

generatorId string

The Generator ID. Must not be null or empty.

evaluationId string

The Evaluation ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this GeneratorEvaluationName with pattern projects/{project}/locations/{location}/generators/{generator}/evaluations/{evaluation}.

FormatProjectLocationGeneratorEvaluation(string, string, string, string)

public static string FormatProjectLocationGeneratorEvaluation(string projectId, string locationId, string generatorId, string evaluationId)

Formats the IDs into the string representation of this GeneratorEvaluationName with pattern projects/{project}/locations/{location}/generators/{generator}/evaluations/{evaluation}.

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.

generatorId string

The Generator ID. Must not be null or empty.

evaluationId string

The Evaluation ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this GeneratorEvaluationName with pattern projects/{project}/locations/{location}/generators/{generator}/evaluations/{evaluation}.

FromProjectLocationGeneratorEvaluation(string, string, string, string)

public static GeneratorEvaluationName FromProjectLocationGeneratorEvaluation(string projectId, string locationId, string generatorId, string evaluationId)

Creates a GeneratorEvaluationName with the pattern projects/{project}/locations/{location}/generators/{generator}/evaluations/{evaluation}.

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.

generatorId string

The Generator ID. Must not be null or empty.

evaluationId string

The Evaluation ID. Must not be null or empty.

Returns
Type Description
GeneratorEvaluationName

A new instance of GeneratorEvaluationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GeneratorEvaluationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GeneratorEvaluationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
GeneratorEvaluationName

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

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

Parameter
Name Description
generatorEvaluationName string

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

Returns
Type Description
GeneratorEvaluationName

The parsed GeneratorEvaluationName if successful.

Remarks

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

  • projects/{project}/locations/{location}/generators/{generator}/evaluations/{evaluation}

Parse(string, bool)

public static GeneratorEvaluationName Parse(string generatorEvaluationName, bool allowUnparsed)

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

Parameters
Name Description
generatorEvaluationName 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
GeneratorEvaluationName

The parsed GeneratorEvaluationName if successful.

Remarks

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

  • projects/{project}/locations/{location}/generators/{generator}/evaluations/{evaluation}
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 GeneratorEvaluationName)

public static bool TryParse(string generatorEvaluationName, out GeneratorEvaluationName result)

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

Parameters
Name Description
generatorEvaluationName string

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

result GeneratorEvaluationName

When this method returns, the parsed GeneratorEvaluationName, 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}/generators/{generator}/evaluations/{evaluation}

TryParse(string, bool, out GeneratorEvaluationName)

public static bool TryParse(string generatorEvaluationName, bool allowUnparsed, out GeneratorEvaluationName result)

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

Parameters
Name Description
generatorEvaluationName 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 GeneratorEvaluationName

When this method returns, the parsed GeneratorEvaluationName, 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}/generators/{generator}/evaluations/{evaluation}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(GeneratorEvaluationName, GeneratorEvaluationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GeneratorEvaluationName

The first resource name to compare, or null.

b GeneratorEvaluationName

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 !=(GeneratorEvaluationName, GeneratorEvaluationName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GeneratorEvaluationName

The first resource name to compare, or null.

b GeneratorEvaluationName

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.