public sealed class EvaluationName : IResourceName, IEquatable<EvaluationName>
Reference documentation and code samples for the Discovery Engine v1beta API class EvaluationName.
Resource name for the Evaluation
resource.
Namespace
Google.Cloud.DiscoveryEngine.V1BetaAssembly
Google.Cloud.DiscoveryEngine.V1Beta.dll
Constructors
EvaluationName(string, string, string)
public EvaluationName(string projectId, string locationId, string evaluationId)
Constructs a new instance of a EvaluationName class from the component parts of pattern
projects/{project}/locations/{location}/evaluations/{evaluation}
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
evaluationId |
string The |
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 |
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 EvaluationName.ResourceNameType Type { get; }
The EvaluationName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
EvaluationNameResourceNameType |
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 evaluationId)
Formats the IDs into the string representation of this EvaluationName with pattern
projects/{project}/locations/{location}/evaluations/{evaluation}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
evaluationId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this EvaluationName with pattern
|
FormatProjectLocationEvaluation(string, string, string)
public static string FormatProjectLocationEvaluation(string projectId, string locationId, string evaluationId)
Formats the IDs into the string representation of this EvaluationName with pattern
projects/{project}/locations/{location}/evaluations/{evaluation}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
evaluationId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this EvaluationName with pattern
|
FromProjectLocationEvaluation(string, string, string)
public static EvaluationName FromProjectLocationEvaluation(string projectId, string locationId, string evaluationId)
Creates a EvaluationName with the pattern
projects/{project}/locations/{location}/evaluations/{evaluation}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
evaluationId |
string The |
Returns | |
---|---|
Type | Description |
EvaluationName |
A new instance of EvaluationName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static EvaluationName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a EvaluationName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
EvaluationName |
A new instance of EvaluationName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static EvaluationName Parse(string evaluationName)
Parses the given resource name string into a new EvaluationName instance.
Parameter | |
---|---|
Name | Description |
evaluationName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
EvaluationName |
The parsed EvaluationName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/evaluations/{evaluation}
Parse(string, bool)
public static EvaluationName Parse(string evaluationName, bool allowUnparsed)
Parses the given resource name string into a new EvaluationName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
evaluationName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
EvaluationName |
The parsed EvaluationName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/evaluations/{evaluation}
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. |
TryParse(string, out EvaluationName)
public static bool TryParse(string evaluationName, out EvaluationName result)
Tries to parse the given resource name string into a new EvaluationName instance.
Parameters | |
---|---|
Name | Description |
evaluationName |
string The resource name in string form. Must not be |
result |
EvaluationName When this method returns, the parsed EvaluationName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/evaluations/{evaluation}
TryParse(string, bool, out EvaluationName)
public static bool TryParse(string evaluationName, bool allowUnparsed, out EvaluationName result)
Tries to parse the given resource name string into a new EvaluationName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
evaluationName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
EvaluationName When this method returns, the parsed EvaluationName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/evaluations/{evaluation}
allowUnparsed
is true
.
Operators
operator ==(EvaluationName, EvaluationName)
public static bool operator ==(EvaluationName a, EvaluationName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
EvaluationName The first resource name to compare, or null. |
b |
EvaluationName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(EvaluationName, EvaluationName)
public static bool operator !=(EvaluationName a, EvaluationName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
EvaluationName The first resource name to compare, or null. |
b |
EvaluationName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |