Cloud AI Platform v1 API - Class TuningJobName (2.27.0) 

public sealed class TuningJobName : IResourceName, IEquatable<TuningJobName>

Reference documentation and code samples for the Cloud AI Platform v1 API class TuningJobName.

Resource name for the TuningJob resource.

Inheritance

object > TuningJobName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

TuningJobName(string, string, string)

public TuningJobName(string projectId, string locationId, string tuningJobId)

Constructs a new instance of a TuningJobName class from the component parts of pattern projects/{project}/locations/{location}/tuningJobs/{tuning_job}

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

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

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

TuningJobId

public string TuningJobId { get; }

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

Property Value
Type Description
string

Type

public TuningJobName.ResourceNameType Type { get; }

The TuningJobName.ResourceNameType of the contained resource name.

Property Value
Type Description
TuningJobNameResourceNameType

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

Formats the IDs into the string representation of this TuningJobName with pattern projects/{project}/locations/{location}/tuningJobs/{tuning_job}.

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

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

The string representation of this TuningJobName with pattern projects/{project}/locations/{location}/tuningJobs/{tuning_job}.

FormatProjectLocationTuningJob(string, string, string)

public static string FormatProjectLocationTuningJob(string projectId, string locationId, string tuningJobId)

Formats the IDs into the string representation of this TuningJobName with pattern projects/{project}/locations/{location}/tuningJobs/{tuning_job}.

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

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

The string representation of this TuningJobName with pattern projects/{project}/locations/{location}/tuningJobs/{tuning_job}.

FromProjectLocationTuningJob(string, string, string)

public static TuningJobName FromProjectLocationTuningJob(string projectId, string locationId, string tuningJobId)

Creates a TuningJobName with the pattern projects/{project}/locations/{location}/tuningJobs/{tuning_job}.

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

The TuningJob ID. Must not be null or empty.
Returns
Type Description
TuningJobName

A new instance of TuningJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TuningJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TuningJobName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
tuningJobName string

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

The parsed TuningJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/tuningJobs/{tuning_job}

Parse(string, bool)

public static TuningJobName Parse(string tuningJobName, bool allowUnparsed)

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

Parameters
Name Description
tuningJobName 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
TuningJobName

The parsed TuningJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/tuningJobs/{tuning_job}
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 TuningJobName)

public static bool TryParse(string tuningJobName, out TuningJobName result)

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

Parameters
Name Description
tuningJobName string

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

When this method returns, the parsed TuningJobName, 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}/tuningJobs/{tuning_job}

TryParse(string, bool, out TuningJobName)

public static bool TryParse(string tuningJobName, bool allowUnparsed, out TuningJobName result)

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

Parameters
Name Description
tuningJobName 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 TuningJobName

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

Operators

operator ==(TuningJobName, TuningJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TuningJobName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TuningJobName

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

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.