Cloud AI Platform v1 API - Class TrialName (3.4.0)

public sealed class TrialName : IResourceName, IEquatable<TrialName>

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

Resource name for the Trial resource.

Inheritance

object > TrialName

Implements

IResourceName, IEquatable TrialName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

TrialName(string, string, string, string)

public TrialName(string projectId, string locationId, string studyId, string trialId)

Constructs a new instance of a TrialName class from the component parts of pattern projects/{project}/locations/{location}/studies/{study}/trials/{trial}

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.
`studyId`	`string` The `Study` ID. Must not be `null` or empty.
`trialId`	`string` The `Trial` 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`

StudyId

public string StudyId { get; }

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

Property Value
Type	Description
`string`

TrialId

public string TrialId { get; }

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

Property Value
Type	Description
`string`

Type

public TrialName.ResourceNameType Type { get; }

The TrialName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TrialNameResourceNameType`

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

Formats the IDs into the string representation of this TrialName with pattern projects/{project}/locations/{location}/studies/{study}/trials/{trial}.

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.
`studyId`	`string` The `Study` ID. Must not be `null` or empty.
`trialId`	`string` The `Trial` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this TrialName with pattern `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`.

FormatProjectLocationStudyTrial(string, string, string, string)

public static string FormatProjectLocationStudyTrial(string projectId, string locationId, string studyId, string trialId)

Formats the IDs into the string representation of this TrialName with pattern projects/{project}/locations/{location}/studies/{study}/trials/{trial}.

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.
`studyId`	`string` The `Study` ID. Must not be `null` or empty.
`trialId`	`string` The `Trial` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this TrialName with pattern `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`.

FromProjectLocationStudyTrial(string, string, string, string)

public static TrialName FromProjectLocationStudyTrial(string projectId, string locationId, string studyId, string trialId)

Creates a TrialName with the pattern projects/{project}/locations/{location}/studies/{study}/trials/{trial}.

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.
`studyId`	`string` The `Study` ID. Must not be `null` or empty.
`trialId`	`string` The `Trial` ID. Must not be `null` or empty.

Returns
Type	Description
`TrialName`	A new instance of TrialName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TrialName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TrialName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`TrialName`	A new instance of TrialName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static TrialName Parse(string trialName)

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

Parameter
Name	Description
`trialName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`TrialName`	The parsed TrialName if successful.

Remarks

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

projects/{project}/locations/{location}/studies/{study}/trials/{trial}

Parse(string, bool)

public static TrialName Parse(string trialName, bool allowUnparsed)

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

Parameters
Name	Description
`trialName`	`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
`TrialName`	The parsed TrialName if successful.

Remarks

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

projects/{project}/locations/{location}/studies/{study}/trials/{trial}

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

object.ToString()

TryParse(string, out TrialName)

public static bool TryParse(string trialName, out TrialName result)

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

Parameters
Name	Description
`trialName`	`string` The resource name in string form. Must not be `null`.
`result`	`TrialName` When this method returns, the parsed TrialName, 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}/studies/{study}/trials/{trial}

TryParse(string, bool, out TrialName)

public static bool TryParse(string trialName, bool allowUnparsed, out TrialName result)

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

Parameters
Name	Description
`trialName`	`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`	`TrialName` When this method returns, the parsed TrialName, 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}/studies/{study}/trials/{trial}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TrialName, TrialName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`TrialName` The first resource name to compare, or null.
`b`	`TrialName` 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 !=(TrialName, TrialName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`TrialName` The first resource name to compare, or null.
`b`	`TrialName` 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.