Vertex AI v1beta1 API - Class OnlineEvaluatorName (1.0.0-beta78) 

public sealed class OnlineEvaluatorName : IResourceName, IEquatable<OnlineEvaluatorName>

Reference documentation and code samples for the Vertex AI v1beta1 API class OnlineEvaluatorName.

Resource name for the OnlineEvaluator resource.

Inheritance

object > OnlineEvaluatorName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

OnlineEvaluatorName(string, string, string)

public OnlineEvaluatorName(string projectId, string locationId, string onlineEvaluatorId)

Constructs a new instance of a OnlineEvaluatorName class from the component parts of pattern projects/{project}/locations/{location}/onlineEvaluators/{online_evaluator}

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.
onlineEvaluatorId string

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

OnlineEvaluatorId

public string OnlineEvaluatorId { get; }

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

The OnlineEvaluatorName.ResourceNameType of the contained resource name.

Property Value
Type Description
OnlineEvaluatorNameResourceNameType

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

Formats the IDs into the string representation of this OnlineEvaluatorName with pattern projects/{project}/locations/{location}/onlineEvaluators/{online_evaluator}.

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.
onlineEvaluatorId string

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

The string representation of this OnlineEvaluatorName with pattern projects/{project}/locations/{location}/onlineEvaluators/{online_evaluator}.

FormatProjectLocationOnlineEvaluator(string, string, string)

public static string FormatProjectLocationOnlineEvaluator(string projectId, string locationId, string onlineEvaluatorId)

Formats the IDs into the string representation of this OnlineEvaluatorName with pattern projects/{project}/locations/{location}/onlineEvaluators/{online_evaluator}.

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.
onlineEvaluatorId string

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

The string representation of this OnlineEvaluatorName with pattern projects/{project}/locations/{location}/onlineEvaluators/{online_evaluator}.

FromProjectLocationOnlineEvaluator(string, string, string)

public static OnlineEvaluatorName FromProjectLocationOnlineEvaluator(string projectId, string locationId, string onlineEvaluatorId)

Creates a OnlineEvaluatorName with the pattern projects/{project}/locations/{location}/onlineEvaluators/{online_evaluator}.

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.
onlineEvaluatorId string

The OnlineEvaluator ID. Must not be null or empty.
Returns
Type Description
OnlineEvaluatorName

A new instance of OnlineEvaluatorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OnlineEvaluatorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OnlineEvaluatorName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
onlineEvaluatorName string

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

The parsed OnlineEvaluatorName if successful.
Remarks

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

  • projects/{project}/locations/{location}/onlineEvaluators/{online_evaluator}

Parse(string, bool)

public static OnlineEvaluatorName Parse(string onlineEvaluatorName, bool allowUnparsed)

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

Parameters
Name Description
onlineEvaluatorName 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
OnlineEvaluatorName

The parsed OnlineEvaluatorName if successful.
Remarks

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

  • projects/{project}/locations/{location}/onlineEvaluators/{online_evaluator}

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

public static bool TryParse(string onlineEvaluatorName, out OnlineEvaluatorName result)

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

Parameters
Name Description
onlineEvaluatorName string

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

When this method returns, the parsed OnlineEvaluatorName, 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}/onlineEvaluators/{online_evaluator}

TryParse(string, bool, out OnlineEvaluatorName)

public static bool TryParse(string onlineEvaluatorName, bool allowUnparsed, out OnlineEvaluatorName result)

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

Parameters
Name Description
onlineEvaluatorName 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 OnlineEvaluatorName

When this method returns, the parsed OnlineEvaluatorName, 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}/onlineEvaluators/{online_evaluator}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(OnlineEvaluatorName, OnlineEvaluatorName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OnlineEvaluatorName

The first resource name to compare, or null.
b OnlineEvaluatorName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OnlineEvaluatorName

The first resource name to compare, or null.
b OnlineEvaluatorName

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.